From fc608145e81870c0aa710c4613c9ddb93f70e9e8 Mon Sep 17 00:00:00 2001 From: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> Date: Mon, 15 May 2023 17:56:51 -0500 Subject: [PATCH] Update dependency hashicorp/terraform-provider-google-beta to v4.64.0 (#32) Signed-off-by: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> Co-authored-by: renovate[bot] --- 4.x/_gen/data/alloydb_locations.libsonnet | 32 + ...alloydb_supported_database_flags.libsonnet | 45 + .../data/compute_forwarding_rule.libsonnet | 4 +- .../compute_global_forwarding_rule.libsonnet | 4 +- 4.x/_gen/data/dns_keys.libsonnet | 87 +- 4.x/_gen/data/main.libsonnet | 3 + 4.x/_gen/data/sql_tiers.libsonnet | 32 + 4.x/_gen/main.libsonnet | 17 + 4.x/_gen/provider_google-beta.libsonnet | 12 +- ...ess_context_manager_access_level.libsonnet | 6 +- ...ss_context_manager_access_levels.libsonnet | 4 +- ...ss_context_manager_egress_policy.libsonnet | 78 + ...ontext_manager_service_perimeter.libsonnet | 44 +- ...ntext_manager_service_perimeters.libsonnet | 44 +- .../active_directory_domain.libsonnet | 4 +- .../active_directory_domain_trust.libsonnet | 4 +- 4.x/_gen/resources/alloydb_backup.libsonnet | 36 +- 4.x/_gen/resources/alloydb_cluster.libsonnet | 50 +- ...ystores_aliases_self_signed_cert.libsonnet | 4 +- 4.x/_gen/resources/billing_budget.libsonnet | 2 +- .../certificate_manager_certificate.libsonnet | 18 +- ...te_manager_certificate_map_entry.libsonnet | 4 +- .../cloud_asset_folder_feed.libsonnet | 6 +- .../cloud_asset_organization_feed.libsonnet | 6 +- .../cloud_asset_project_feed.libsonnet | 6 +- .../resources/cloud_run_service.libsonnet | 20 +- 4.x/_gen/resources/cloud_run_v2_job.libsonnet | 4 +- .../resources/cloud_run_v2_service.libsonnet | 32 +- .../resources/cloud_scheduler_job.libsonnet | 10 +- ...oudbuild_bitbucket_server_config.libsonnet | 4 +- .../resources/cloudbuild_trigger.libsonnet | 18 +- .../cloudfunctions2_function.libsonnet | 4 +- .../compute_backend_service.libsonnet | 12 +- 4.x/_gen/resources/compute_disk.libsonnet | 38 +- .../compute_firewall_policy_rule.libsonnet | 24 +- .../compute_forwarding_rule.libsonnet | 32 +- .../compute_global_forwarding_rule.libsonnet | 36 +- 4.x/_gen/resources/compute_network.libsonnet | 4 +- ...ute_network_firewall_policy_rule.libsonnet | 20 +- .../compute_region_commitment.libsonnet | 4 +- .../resources/compute_region_disk.libsonnet | 36 +- ...ion_network_firewall_policy_rule.libsonnet | 20 +- .../compute_resource_policy.libsonnet | 38 +- .../resources/compute_router_peer.libsonnet | 46 +- 4.x/_gen/resources/compute_snapshot.libsonnet | 4 +- .../compute_target_https_proxy.libsonnet | 4 +- .../container_aws_node_pool.libsonnet | 12 +- .../resources/data_fusion_instance.libsonnet | 4 +- ...s_prevention_deidentify_template.libsonnet | 94 +- ...loss_prevention_inspect_template.libsonnet | 70 +- ...data_loss_prevention_job_trigger.libsonnet | 322 +++- ...ation_service_connection_profile.libsonnet | 408 ++++++ 4.x/_gen/resources/dialogflow_agent.libsonnet | 4 +- .../resources/dialogflow_intent.libsonnet | 4 +- 4.x/_gen/resources/dns_managed_zone.libsonnet | 2 +- .../resources/dns_response_policy.libsonnet | 2 +- .../resources/firebase_apple_app.libsonnet | 8 +- .../firebase_database_instance.libsonnet | 4 +- .../resources/gke_hub_membership.libsonnet | 2 +- .../gkeonprem_vmware_cluster.libsonnet | 618 ++++++++ .../gkeonprem_vmware_node_pool.libsonnet | 234 +++ .../resources/healthcare_fhir_store.libsonnet | 2 +- .../resources/iam_workforce_pool.libsonnet | 4 +- .../iam_workforce_pool_provider.libsonnet | 2 +- ..._platform_project_default_config.libsonnet | 2 +- 4.x/_gen/resources/kms_crypto_key.libsonnet | 4 +- 4.x/_gen/resources/logging_metric.libsonnet | 2 +- .../resources/monitoring_service.libsonnet | 2 +- .../network_security_address_group.libsonnet | 168 +++ ...rk_security_authorization_policy.libsonnet | 208 +++ ...twork_security_client_tls_policy.libsonnet | 240 +++ ...ity_gateway_security_policy_rule.libsonnet | 4 +- ...network_services_endpoint_policy.libsonnet | 252 ++++ .../network_services_gateway.libsonnet | 4 +- .../network_services_grpc_route.libsonnet | 286 ++++ .../resources/network_services_mesh.libsonnet | 4 +- ...network_services_service_binding.libsonnet | 124 ++ .../network_services_tcp_route.libsonnet | 8 +- .../network_services_tls_route.libsonnet | 188 +++ .../resources/privateca_ca_pool.libsonnet | 2 +- .../resources/privateca_certificate.libsonnet | 2 +- .../privateca_certificate_authority.libsonnet | 4 +- .../resources/pubsub_subscription.libsonnet | 8 +- .../resources/sourcerepo_repository.libsonnet | 6 +- 4.x/_gen/resources/spanner_instance.libsonnet | 4 +- 4.x/_gen/resources/sql_database.libsonnet | 4 +- ...l_source_representation_instance.libsonnet | 4 +- .../resources/vertex_ai_endpoint.libsonnet | 18 +- 4.x/_gen/resources/vertex_ai_index.libsonnet | 2 +- .../resources/workflows_workflow.libsonnet | 18 +- .../workstations_workstation.libsonnet | 4 +- ...workstations_workstation_cluster.libsonnet | 4 +- .../workstations_workstation_config.libsonnet | 10 +- ...s_workstation_config_iam_binding.libsonnet | 140 ++ ...ns_workstation_config_iam_member.libsonnet | 140 ++ ...ns_workstation_config_iam_policy.libsonnet | 90 ++ ...stations_workstation_iam_binding.libsonnet | 154 ++ ...kstations_workstation_iam_member.libsonnet | 154 ++ ...kstations_workstation_iam_policy.libsonnet | 104 ++ docs/4.x/README.md | 17 + docs/4.x/data/google_alloydb_locations.md | 92 ++ ...google_alloydb_supported_database_flags.md | 111 ++ .../data/google_compute_forwarding_rule.md | 40 +- .../google_compute_global_forwarding_rule.md | 32 +- docs/4.x/data/google_dns_keys.md | 176 --- docs/4.x/data/google_sql_tiers.md | 92 ++ docs/4.x/data/index.md | 3 + ...gle_access_context_manager_access_level.md | 6 +- ...le_access_context_manager_access_levels.md | 4 +- ...le_access_context_manager_egress_policy.md | 177 +++ ...ccess_context_manager_service_perimeter.md | 180 +-- ...cess_context_manager_service_perimeters.md | 180 +-- docs/4.x/google_active_directory_domain.md | 16 +- .../google_active_directory_domain_trust.md | 4 +- docs/4.x/google_alloydb_backup.md | 66 + docs/4.x/google_alloydb_cluster.md | 102 +- ...igee_keystores_aliases_self_signed_cert.md | 8 +- docs/4.x/google_billing_budget.md | 2 +- .../google_certificate_manager_certificate.md | 19 + ...rtificate_manager_certificate_map_entry.md | 8 +- docs/4.x/google_cloud_asset_folder_feed.md | 10 +- .../google_cloud_asset_organization_feed.md | 10 +- docs/4.x/google_cloud_asset_project_feed.md | 10 +- docs/4.x/google_cloud_run_service.md | 21 +- docs/4.x/google_cloud_run_v2_job.md | 10 +- docs/4.x/google_cloud_run_v2_service.md | 25 +- docs/4.x/google_cloud_scheduler_job.md | 46 +- ...ogle_cloudbuild_bitbucket_server_config.md | 12 +- docs/4.x/google_cloudbuild_trigger.md | 64 +- docs/4.x/google_cloudfunctions2_function.md | 6 +- docs/4.x/google_compute_backend_service.md | 27 + docs/4.x/google_compute_disk.md | 70 +- .../google_compute_firewall_policy_rule.md | 12 +- docs/4.x/google_compute_forwarding_rule.md | 532 +++++-- .../google_compute_global_forwarding_rule.md | 398 +++-- docs/4.x/google_compute_network.md | 32 +- ...le_compute_network_firewall_policy_rule.md | 8 + docs/4.x/google_compute_region_commitment.md | 20 +- docs/4.x/google_compute_region_disk.md | 66 + ...ute_region_network_firewall_policy_rule.md | 8 + docs/4.x/google_compute_resource_policy.md | 70 +- docs/4.x/google_compute_router_peer.md | 69 + docs/4.x/google_compute_snapshot.md | 20 +- docs/4.x/google_compute_target_https_proxy.md | 4 +- docs/4.x/google_container_aws_node_pool.md | 26 + docs/4.x/google_data_fusion_instance.md | 8 +- ...ata_loss_prevention_deidentify_template.md | 229 +++ ...e_data_loss_prevention_inspect_template.md | 113 ++ ...google_data_loss_prevention_job_trigger.md | 836 ++++++++++- ...se_migration_service_connection_profile.md | 778 ++++++++++ docs/4.x/google_dialogflow_agent.md | 20 +- docs/4.x/google_dialogflow_intent.md | 4 +- docs/4.x/google_dns_managed_zone.md | 4 +- docs/4.x/google_dns_response_policy.md | 4 +- docs/4.x/google_firebase_apple_app.md | 4 +- docs/4.x/google_firebase_database_instance.md | 4 +- docs/4.x/google_gke_hub_membership.md | 2 +- docs/4.x/google_gkeonprem_vmware_cluster.md | 1289 +++++++++++++++++ docs/4.x/google_gkeonprem_vmware_node_pool.md | 443 ++++++ docs/4.x/google_healthcare_fhir_store.md | 4 +- docs/4.x/google_iam_workforce_pool.md | 4 +- .../4.x/google_iam_workforce_pool_provider.md | 6 +- ...dentity_platform_project_default_config.md | 4 +- docs/4.x/google_kms_crypto_key.md | 4 +- docs/4.x/google_logging_metric.md | 4 +- docs/4.x/google_monitoring_service.md | 4 +- .../google_network_security_address_group.md | 296 ++++ ...e_network_security_authorization_policy.md | 410 ++++++ ...ogle_network_security_client_tls_policy.md | 490 +++++++ ...k_security_gateway_security_policy_rule.md | 4 +- ...google_network_services_endpoint_policy.md | 476 ++++++ docs/4.x/google_network_services_gateway.md | 8 +- .../4.x/google_network_services_grpc_route.md | 578 ++++++++ docs/4.x/google_network_services_mesh.md | 16 +- ...google_network_services_service_binding.md | 236 +++ docs/4.x/google_network_services_tcp_route.md | 8 +- docs/4.x/google_network_services_tls_route.md | 386 +++++ docs/4.x/google_privateca_ca_pool.md | 2 +- docs/4.x/google_privateca_certificate.md | 2 +- .../google_privateca_certificate_authority.md | 4 +- docs/4.x/google_pubsub_subscription.md | 18 +- docs/4.x/google_sourcerepo_repository.md | 12 +- docs/4.x/google_spanner_instance.md | 4 +- docs/4.x/google_sql_database.md | 12 +- ...ogle_sql_source_representation_instance.md | 4 +- docs/4.x/google_vertex_ai_endpoint.md | 19 + docs/4.x/google_vertex_ai_index.md | 2 +- docs/4.x/google_workflows_workflow.md | 37 +- docs/4.x/google_workstations_workstation.md | 12 +- ...google_workstations_workstation_cluster.md | 12 +- .../google_workstations_workstation_config.md | 14 +- ...stations_workstation_config_iam_binding.md | 255 ++++ ...kstations_workstation_config_iam_member.md | 255 ++++ ...kstations_workstation_config_iam_policy.md | 168 +++ ...le_workstations_workstation_iam_binding.md | 274 ++++ ...gle_workstations_workstation_iam_member.md | 274 ++++ ...gle_workstations_workstation_iam_policy.md | 187 +++ docs/4.x/provider.md | 4 + 198 files changed, 15138 insertions(+), 1146 deletions(-) create mode 100644 4.x/_gen/data/alloydb_locations.libsonnet create mode 100644 4.x/_gen/data/alloydb_supported_database_flags.libsonnet create mode 100644 4.x/_gen/data/sql_tiers.libsonnet create mode 100644 4.x/_gen/resources/access_context_manager_egress_policy.libsonnet create mode 100644 4.x/_gen/resources/database_migration_service_connection_profile.libsonnet create mode 100644 4.x/_gen/resources/gkeonprem_vmware_cluster.libsonnet create mode 100644 4.x/_gen/resources/gkeonprem_vmware_node_pool.libsonnet create mode 100644 4.x/_gen/resources/network_security_address_group.libsonnet create mode 100644 4.x/_gen/resources/network_security_authorization_policy.libsonnet create mode 100644 4.x/_gen/resources/network_security_client_tls_policy.libsonnet create mode 100644 4.x/_gen/resources/network_services_endpoint_policy.libsonnet create mode 100644 4.x/_gen/resources/network_services_grpc_route.libsonnet create mode 100644 4.x/_gen/resources/network_services_service_binding.libsonnet create mode 100644 4.x/_gen/resources/network_services_tls_route.libsonnet create mode 100644 4.x/_gen/resources/workstations_workstation_config_iam_binding.libsonnet create mode 100644 4.x/_gen/resources/workstations_workstation_config_iam_member.libsonnet create mode 100644 4.x/_gen/resources/workstations_workstation_config_iam_policy.libsonnet create mode 100644 4.x/_gen/resources/workstations_workstation_iam_binding.libsonnet create mode 100644 4.x/_gen/resources/workstations_workstation_iam_member.libsonnet create mode 100644 4.x/_gen/resources/workstations_workstation_iam_policy.libsonnet create mode 100644 docs/4.x/data/google_alloydb_locations.md create mode 100644 docs/4.x/data/google_alloydb_supported_database_flags.md create mode 100644 docs/4.x/data/google_sql_tiers.md create mode 100644 docs/4.x/google_access_context_manager_egress_policy.md create mode 100644 docs/4.x/google_database_migration_service_connection_profile.md create mode 100644 docs/4.x/google_gkeonprem_vmware_cluster.md create mode 100644 docs/4.x/google_gkeonprem_vmware_node_pool.md create mode 100644 docs/4.x/google_network_security_address_group.md create mode 100644 docs/4.x/google_network_security_authorization_policy.md create mode 100644 docs/4.x/google_network_security_client_tls_policy.md create mode 100644 docs/4.x/google_network_services_endpoint_policy.md create mode 100644 docs/4.x/google_network_services_grpc_route.md create mode 100644 docs/4.x/google_network_services_service_binding.md create mode 100644 docs/4.x/google_network_services_tls_route.md create mode 100644 docs/4.x/google_workstations_workstation_config_iam_binding.md create mode 100644 docs/4.x/google_workstations_workstation_config_iam_member.md create mode 100644 docs/4.x/google_workstations_workstation_config_iam_policy.md create mode 100644 docs/4.x/google_workstations_workstation_iam_binding.md create mode 100644 docs/4.x/google_workstations_workstation_iam_member.md create mode 100644 docs/4.x/google_workstations_workstation_iam_policy.md diff --git a/4.x/_gen/data/alloydb_locations.libsonnet b/4.x/_gen/data/alloydb_locations.libsonnet new file mode 100644 index 00000000..3ec2106a --- /dev/null +++ b/4.x/_gen/data/alloydb_locations.libsonnet @@ -0,0 +1,32 @@ +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='google_alloydb_locations', url='', help='`google_alloydb_locations` represents the `google-beta_google_alloydb_locations` 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-beta.data.google_alloydb_locations.new` injects a new `data_google-beta_google_alloydb_locations` 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-beta.data.google_alloydb_locations.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.data.google_alloydb_locations` using the reference:\n\n $._ref.data_google-beta_google_alloydb_locations.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google-beta_google_alloydb_locations.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 - `project` (`string`): Project ID of the project. 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, + project=null, + _meta={} + ):: tf.withData( + type='google_alloydb_locations', + label=dataSrcLabel, + attrs=self.newAttrs(project=project), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.data.google_alloydb_locations.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_locations`\nTerraform data source.\n\nUnlike [google-beta.data.google_alloydb_locations.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 - `project` (`string`): Project ID of the project. 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 `google_alloydb_locations` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + project=null + ):: std.prune(a={ + project: project, + }), + '#withProject':: d.fn(help='`google-beta.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_alloydb_locations+: { + [dataSrcLabel]+: { + project: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/data/alloydb_supported_database_flags.libsonnet b/4.x/_gen/data/alloydb_supported_database_flags.libsonnet new file mode 100644 index 00000000..2afd0861 --- /dev/null +++ b/4.x/_gen/data/alloydb_supported_database_flags.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='google_alloydb_supported_database_flags', url='', help='`google_alloydb_supported_database_flags` represents the `google-beta_google_alloydb_supported_database_flags` 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-beta.data.google_alloydb_supported_database_flags.new` injects a new `data_google-beta_google_alloydb_supported_database_flags` 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-beta.data.google_alloydb_supported_database_flags.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.data.google_alloydb_supported_database_flags` using the reference:\n\n $._ref.data_google-beta_google_alloydb_supported_database_flags.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google-beta_google_alloydb_supported_database_flags.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`): The canonical id for the location. For example: \u0026#34;us-east1\u0026#34;.\n - `project` (`string`): Project ID of the project. 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, + location, + project=null, + _meta={} + ):: tf.withData( + type='google_alloydb_supported_database_flags', + label=dataSrcLabel, + attrs=self.newAttrs(location=location, project=project), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.data.google_alloydb_supported_database_flags.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_supported_database_flags`\nTerraform data source.\n\nUnlike [google-beta.data.google_alloydb_supported_database_flags.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`): The canonical id for the location. For example: "us-east1".\n - `project` (`string`): Project ID of the project. 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 `google_alloydb_supported_database_flags` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + location, + project=null + ):: std.prune(a={ + location: location, + project: project, + }), + '#withLocation':: d.fn(help='`google-beta.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_alloydb_supported_database_flags+: { + [dataSrcLabel]+: { + location: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_alloydb_supported_database_flags+: { + [dataSrcLabel]+: { + project: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/data/compute_forwarding_rule.libsonnet b/4.x/_gen/data/compute_forwarding_rule.libsonnet index 7a501093..731be5ec 100644 --- a/4.x/_gen/data/compute_forwarding_rule.libsonnet +++ b/4.x/_gen/data/compute_forwarding_rule.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='google_compute_forwarding_rule', url='', help='`google_compute_forwarding_rule` represents the `google-beta_google_compute_forwarding_rule` 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-beta.data.google_compute_forwarding_rule.new` injects a new `data_google-beta_google_compute_forwarding_rule` 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-beta.data.google_compute_forwarding_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.data.google_compute_forwarding_rule` using the reference:\n\n $._ref.data_google-beta_google_compute_forwarding_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google-beta_google_compute_forwarding_rule.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`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.\n - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The location of this resource. When `null`, the `region` 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':: d.fn(help="\n`google-beta.data.google_compute_forwarding_rule.new` injects a new `data_google-beta_google_compute_forwarding_rule` 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-beta.data.google_compute_forwarding_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.data.google_compute_forwarding_rule` using the reference:\n\n $._ref.data_google-beta_google_compute_forwarding_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google-beta_google_compute_forwarding_rule.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`): Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply with\n[RFC1035](https://www.ietf.org/rfc/rfc1035.txt).\n\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, the forwarding rule name must be a 1-20 characters string with\nlowercase letters and numbers and must start with a letter.\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 - `region` (`string`): A reference to the region where the regional forwarding rule resides.\n\nThis field is not applicable to global forwarding rules. When `null`, the `region` 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, @@ -15,7 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(name=name, project=project, region=region), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.data.google_compute_forwarding_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_forwarding_rule`\nTerraform data source.\n\nUnlike [google-beta.data.google_compute_forwarding_rule.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`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.\n - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The location of this resource. When `null`, the `region` 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 `google_compute_forwarding_rule` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.data.google_compute_forwarding_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_forwarding_rule`\nTerraform data source.\n\nUnlike [google-beta.data.google_compute_forwarding_rule.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`): Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply with\n[RFC1035](https://www.ietf.org/rfc/rfc1035.txt).\n\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, the forwarding rule name must be a 1-20 characters string with\nlowercase letters and numbers and must start with a letter.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): A reference to the region where the regional forwarding rule resides.\n\nThis field is not applicable to global forwarding rules. When `null`, the `region` 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 `google_compute_forwarding_rule` data source into the root Terraform configuration.\n', args=[]), newAttrs( name, project=null, diff --git a/4.x/_gen/data/compute_global_forwarding_rule.libsonnet b/4.x/_gen/data/compute_global_forwarding_rule.libsonnet index b3817b16..45b442f1 100644 --- a/4.x/_gen/data/compute_global_forwarding_rule.libsonnet +++ b/4.x/_gen/data/compute_global_forwarding_rule.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='google_compute_global_forwarding_rule', url='', help='`google_compute_global_forwarding_rule` represents the `google-beta_google_compute_global_forwarding_rule` 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-beta.data.google_compute_global_forwarding_rule.new` injects a new `data_google-beta_google_compute_global_forwarding_rule` 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-beta.data.google_compute_global_forwarding_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.data.google_compute_global_forwarding_rule` using the reference:\n\n $._ref.data_google-beta_google_compute_global_forwarding_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google-beta_google_compute_global_forwarding_rule.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`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.\n - `project` (`string`): The project this resource belongs in. 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':: d.fn(help="\n`google-beta.data.google_compute_global_forwarding_rule.new` injects a new `data_google-beta_google_compute_global_forwarding_rule` 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-beta.data.google_compute_global_forwarding_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.data.google_compute_global_forwarding_rule` using the reference:\n\n $._ref.data_google-beta_google_compute_global_forwarding_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google-beta_google_compute_global_forwarding_rule.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`): Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply with\n[RFC1035](https://www.ietf.org/rfc/rfc1035.txt).\n\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, the forwarding rule name must be a 1-20 characters string with\nlowercase letters and numbers and must start with a letter.\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, @@ -14,7 +14,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(name=name, project=project), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.data.google_compute_global_forwarding_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_global_forwarding_rule`\nTerraform data source.\n\nUnlike [google-beta.data.google_compute_global_forwarding_rule.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`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.\n - `project` (`string`): The project this resource belongs in. 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 `google_compute_global_forwarding_rule` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.data.google_compute_global_forwarding_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_global_forwarding_rule`\nTerraform data source.\n\nUnlike [google-beta.data.google_compute_global_forwarding_rule.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`): Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply with\n[RFC1035](https://www.ietf.org/rfc/rfc1035.txt).\n\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, the forwarding rule name must be a 1-20 characters string with\nlowercase letters and numbers and must start with a letter.\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 `google_compute_global_forwarding_rule` data source into the root Terraform configuration.\n', args=[]), newAttrs( name, project=null diff --git a/4.x/_gen/data/dns_keys.libsonnet b/4.x/_gen/data/dns_keys.libsonnet index bd253910..baddee2b 100644 --- a/4.x/_gen/data/dns_keys.libsonnet +++ b/4.x/_gen/data/dns_keys.libsonnet @@ -2,71 +2,26 @@ 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='google_dns_keys', url='', help='`google_dns_keys` represents the `google-beta_google_dns_keys` Terraform data source.\n\nGet the DNSKEY and DS records of DNSSEC-signed managed zones\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - key_signing_keys:: { - digests:: { - '#new':: d.fn(help='\n`google-beta.google_dns_keys.key_signing_keys.digests.new` constructs a new object with attributes and blocks configured for the `digests`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `digests` sub block.\n', args=[]), - new( - - ):: std.prune(a={}), - }, - '#new':: d.fn(help='\n`google-beta.google_dns_keys.key_signing_keys.new` constructs a new object with attributes and blocks configured for the `key_signing_keys`\nTerraform sub block.\n\n\n\n**Args**:\n - `digests` (`list[obj]`): A list of cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. When `null`, the `digests` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dns_keys.key_signing_keys.digests.new](#fn-key_signing_keysdigestsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `key_signing_keys` sub block.\n', args=[]), - new( - digests=null - ):: std.prune(a={ - digests: digests, - }), - }, - '#new':: d.fn(help="\n`google-beta.data.google_dns_keys.new` injects a new `data_google-beta_google_dns_keys` 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-beta.data.google_dns_keys.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.data.google_dns_keys` using the reference:\n\n $._ref.data_google-beta_google_dns_keys.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google-beta_google_dns_keys.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 - `managed_zone` (`string`): The Name of the zone.\n - `project` (`string`): The ID of the project for the Google Cloud. When `null`, the `project` field will be omitted from the resulting object.\n - `key_signing_keys` (`list[obj]`): A list of Key-signing key (KSK) records. When `null`, the `key_signing_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.data.google_dns_keys.key_signing_keys.new](#fn-key_signing_keysnew) constructor.\n - `zone_signing_keys` (`list[obj]`): A list of Zone-signing key (ZSK) records. When `null`, the `zone_signing_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.data.google_dns_keys.zone_signing_keys.new](#fn-zone_signing_keysnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.data.google_dns_keys.new` injects a new `data_google-beta_google_dns_keys` 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-beta.data.google_dns_keys.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.data.google_dns_keys` using the reference:\n\n $._ref.data_google-beta_google_dns_keys.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google-beta_google_dns_keys.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 - `managed_zone` (`string`): The Name of the zone.\n - `project` (`string`): The ID of the project for the Google Cloud. 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, managed_zone, - key_signing_keys=null, project=null, - zone_signing_keys=null, _meta={} ):: tf.withData( type='google_dns_keys', label=dataSrcLabel, - attrs=self.newAttrs( - key_signing_keys=key_signing_keys, - managed_zone=managed_zone, - project=project, - zone_signing_keys=zone_signing_keys - ), + attrs=self.newAttrs(managed_zone=managed_zone, project=project), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.data.google_dns_keys.newAttrs` constructs a new object with attributes and blocks configured for the `google_dns_keys`\nTerraform data source.\n\nUnlike [google-beta.data.google_dns_keys.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 - `managed_zone` (`string`): The Name of the zone.\n - `project` (`string`): The ID of the project for the Google Cloud. When `null`, the `project` field will be omitted from the resulting object.\n - `key_signing_keys` (`list[obj]`): A list of Key-signing key (KSK) records. When `null`, the `key_signing_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.data.google_dns_keys.key_signing_keys.new](#fn-key_signing_keysnew) constructor.\n - `zone_signing_keys` (`list[obj]`): A list of Zone-signing key (ZSK) records. When `null`, the `zone_signing_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.data.google_dns_keys.zone_signing_keys.new](#fn-zone_signing_keysnew) constructor.\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 `google_dns_keys` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.data.google_dns_keys.newAttrs` constructs a new object with attributes and blocks configured for the `google_dns_keys`\nTerraform data source.\n\nUnlike [google-beta.data.google_dns_keys.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 - `managed_zone` (`string`): The Name of the zone.\n - `project` (`string`): The ID of the project for the Google Cloud. 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 `google_dns_keys` data source into the root Terraform configuration.\n', args=[]), newAttrs( managed_zone, - key_signing_keys=null, - project=null, - zone_signing_keys=null + project=null ):: std.prune(a={ - key_signing_keys: key_signing_keys, managed_zone: managed_zone, project: project, - zone_signing_keys: zone_signing_keys, }), - '#withKeySigningKeys':: d.fn(help='`google-beta.list[obj].withKeySigningKeys` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the key_signing_keys 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-beta.list[obj].withKeySigningKeysMixin](TODO) function.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `key_signing_keys` field.\n', args=[]), - withKeySigningKeys(dataSrcLabel, value): { - data+: { - google_dns_keys+: { - [dataSrcLabel]+: { - key_signing_keys: value, - }, - }, - }, - }, - '#withKeySigningKeysMixin':: d.fn(help='`google-beta.list[obj].withKeySigningKeysMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the key_signing_keys 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-beta.list[obj].withKeySigningKeys](TODO)\nfunction.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `key_signing_keys` field.\n', args=[]), - withKeySigningKeysMixin(dataSrcLabel, value): { - data+: { - google_dns_keys+: { - [dataSrcLabel]+: { - key_signing_keys+: if std.isArray(v=value) then value else [value], - }, - }, - }, - }, '#withManagedZone':: d.fn(help='`google-beta.string.withManagedZone` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the managed_zone 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 `managed_zone` field.\n', args=[]), withManagedZone(dataSrcLabel, value): { data+: { @@ -87,38 +42,4 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, - '#withZoneSigningKeys':: d.fn(help='`google-beta.list[obj].withZoneSigningKeys` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the zone_signing_keys 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-beta.list[obj].withZoneSigningKeysMixin](TODO) function.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `zone_signing_keys` field.\n', args=[]), - withZoneSigningKeys(dataSrcLabel, value): { - data+: { - google_dns_keys+: { - [dataSrcLabel]+: { - zone_signing_keys: value, - }, - }, - }, - }, - '#withZoneSigningKeysMixin':: d.fn(help='`google-beta.list[obj].withZoneSigningKeysMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the zone_signing_keys 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-beta.list[obj].withZoneSigningKeys](TODO)\nfunction.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `zone_signing_keys` field.\n', args=[]), - withZoneSigningKeysMixin(dataSrcLabel, value): { - data+: { - google_dns_keys+: { - [dataSrcLabel]+: { - zone_signing_keys+: if std.isArray(v=value) then value else [value], - }, - }, - }, - }, - zone_signing_keys:: { - digests:: { - '#new':: d.fn(help='\n`google-beta.google_dns_keys.zone_signing_keys.digests.new` constructs a new object with attributes and blocks configured for the `digests`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `digests` sub block.\n', args=[]), - new( - - ):: std.prune(a={}), - }, - '#new':: d.fn(help='\n`google-beta.google_dns_keys.zone_signing_keys.new` constructs a new object with attributes and blocks configured for the `zone_signing_keys`\nTerraform sub block.\n\n\n\n**Args**:\n - `digests` (`list[obj]`): A list of cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. When `null`, the `digests` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dns_keys.zone_signing_keys.digests.new](#fn-zone_signing_keysdigestsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `zone_signing_keys` sub block.\n', args=[]), - new( - digests=null - ):: std.prune(a={ - digests: digests, - }), - }, } diff --git a/4.x/_gen/data/main.libsonnet b/4.x/_gen/data/main.libsonnet index 654aa29f..ed6bee36 100644 --- a/4.x/_gen/data/main.libsonnet +++ b/4.x/_gen/data/main.libsonnet @@ -5,6 +5,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); access_approval_organization_service_account: (import 'access_approval_organization_service_account.libsonnet'), access_approval_project_service_account: (import 'access_approval_project_service_account.libsonnet'), active_folder: (import 'active_folder.libsonnet'), + alloydb_locations: (import 'alloydb_locations.libsonnet'), + alloydb_supported_database_flags: (import 'alloydb_supported_database_flags.libsonnet'), app_engine_default_service_account: (import 'app_engine_default_service_account.libsonnet'), artifact_registry_repository: (import 'artifact_registry_repository.libsonnet'), beyondcorp_app_connection: (import 'beyondcorp_app_connection.libsonnet'), @@ -133,6 +135,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); sql_database_instance: (import 'sql_database_instance.libsonnet'), sql_database_instances: (import 'sql_database_instances.libsonnet'), sql_databases: (import 'sql_databases.libsonnet'), + sql_tiers: (import 'sql_tiers.libsonnet'), storage_bucket: (import 'storage_bucket.libsonnet'), storage_bucket_object: (import 'storage_bucket_object.libsonnet'), storage_bucket_object_content: (import 'storage_bucket_object_content.libsonnet'), diff --git a/4.x/_gen/data/sql_tiers.libsonnet b/4.x/_gen/data/sql_tiers.libsonnet new file mode 100644 index 00000000..1da1b88b --- /dev/null +++ b/4.x/_gen/data/sql_tiers.libsonnet @@ -0,0 +1,32 @@ +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='google_sql_tiers', url='', help='`google_sql_tiers` represents the `google-beta_google_sql_tiers` 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-beta.data.google_sql_tiers.new` injects a new `data_google-beta_google_sql_tiers` 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-beta.data.google_sql_tiers.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.data.google_sql_tiers` using the reference:\n\n $._ref.data_google-beta_google_sql_tiers.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google-beta_google_sql_tiers.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 - `project` (`string`): Project ID of the project for which to list tiers. 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, + project=null, + _meta={} + ):: tf.withData( + type='google_sql_tiers', + label=dataSrcLabel, + attrs=self.newAttrs(project=project), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.data.google_sql_tiers.newAttrs` constructs a new object with attributes and blocks configured for the `google_sql_tiers`\nTerraform data source.\n\nUnlike [google-beta.data.google_sql_tiers.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 - `project` (`string`): Project ID of the project for which to list tiers. 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 `google_sql_tiers` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + project=null + ):: std.prune(a={ + project: project, + }), + '#withProject':: d.fn(help='`google-beta.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_sql_tiers+: { + [dataSrcLabel]+: { + project: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/main.libsonnet b/4.x/_gen/main.libsonnet index f156b266..16b3014c 100644 --- a/4.x/_gen/main.libsonnet +++ b/4.x/_gen/main.libsonnet @@ -10,6 +10,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); access_context_manager_access_policy_iam_member: (import 'resources/access_context_manager_access_policy_iam_member.libsonnet'), access_context_manager_access_policy_iam_policy: (import 'resources/access_context_manager_access_policy_iam_policy.libsonnet'), access_context_manager_authorized_orgs_desc: (import 'resources/access_context_manager_authorized_orgs_desc.libsonnet'), + access_context_manager_egress_policy: (import 'resources/access_context_manager_egress_policy.libsonnet'), access_context_manager_gcp_user_access_binding: (import 'resources/access_context_manager_gcp_user_access_binding.libsonnet'), access_context_manager_ingress_policy: (import 'resources/access_context_manager_ingress_policy.libsonnet'), access_context_manager_service_perimeter: (import 'resources/access_context_manager_service_perimeter.libsonnet'), @@ -339,6 +340,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); data_loss_prevention_inspect_template: (import 'resources/data_loss_prevention_inspect_template.libsonnet'), data_loss_prevention_job_trigger: (import 'resources/data_loss_prevention_job_trigger.libsonnet'), data_loss_prevention_stored_info_type: (import 'resources/data_loss_prevention_stored_info_type.libsonnet'), + database_migration_service_connection_profile: (import 'resources/database_migration_service_connection_profile.libsonnet'), dataflow_flex_template_job: (import 'resources/dataflow_flex_template_job.libsonnet'), dataflow_job: (import 'resources/dataflow_job.libsonnet'), dataform_repository: (import 'resources/dataform_repository.libsonnet'), @@ -454,6 +456,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); gke_hub_membership_iam_binding: (import 'resources/gke_hub_membership_iam_binding.libsonnet'), gke_hub_membership_iam_member: (import 'resources/gke_hub_membership_iam_member.libsonnet'), gke_hub_membership_iam_policy: (import 'resources/gke_hub_membership_iam_policy.libsonnet'), + gkeonprem_vmware_cluster: (import 'resources/gkeonprem_vmware_cluster.libsonnet'), + gkeonprem_vmware_node_pool: (import 'resources/gkeonprem_vmware_node_pool.libsonnet'), healthcare_consent_store: (import 'resources/healthcare_consent_store.libsonnet'), healthcare_consent_store_iam_binding: (import 'resources/healthcare_consent_store_iam_binding.libsonnet'), healthcare_consent_store_iam_member: (import 'resources/healthcare_consent_store_iam_member.libsonnet'), @@ -556,16 +560,23 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); network_connectivity_hub: (import 'resources/network_connectivity_hub.libsonnet'), network_connectivity_spoke: (import 'resources/network_connectivity_spoke.libsonnet'), network_management_connectivity_test: (import 'resources/network_management_connectivity_test.libsonnet'), + network_security_address_group: (import 'resources/network_security_address_group.libsonnet'), + network_security_authorization_policy: (import 'resources/network_security_authorization_policy.libsonnet'), + network_security_client_tls_policy: (import 'resources/network_security_client_tls_policy.libsonnet'), network_security_gateway_security_policy: (import 'resources/network_security_gateway_security_policy.libsonnet'), network_security_gateway_security_policy_rule: (import 'resources/network_security_gateway_security_policy_rule.libsonnet'), network_security_url_lists: (import 'resources/network_security_url_lists.libsonnet'), network_services_edge_cache_keyset: (import 'resources/network_services_edge_cache_keyset.libsonnet'), network_services_edge_cache_origin: (import 'resources/network_services_edge_cache_origin.libsonnet'), network_services_edge_cache_service: (import 'resources/network_services_edge_cache_service.libsonnet'), + network_services_endpoint_policy: (import 'resources/network_services_endpoint_policy.libsonnet'), network_services_gateway: (import 'resources/network_services_gateway.libsonnet'), + network_services_grpc_route: (import 'resources/network_services_grpc_route.libsonnet'), network_services_http_route: (import 'resources/network_services_http_route.libsonnet'), network_services_mesh: (import 'resources/network_services_mesh.libsonnet'), + network_services_service_binding: (import 'resources/network_services_service_binding.libsonnet'), network_services_tcp_route: (import 'resources/network_services_tcp_route.libsonnet'), + network_services_tls_route: (import 'resources/network_services_tls_route.libsonnet'), notebooks_environment: (import 'resources/notebooks_environment.libsonnet'), notebooks_instance: (import 'resources/notebooks_instance.libsonnet'), notebooks_instance_iam_binding: (import 'resources/notebooks_instance_iam_binding.libsonnet'), @@ -722,5 +733,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); workstations_workstation: (import 'resources/workstations_workstation.libsonnet'), workstations_workstation_cluster: (import 'resources/workstations_workstation_cluster.libsonnet'), workstations_workstation_config: (import 'resources/workstations_workstation_config.libsonnet'), + workstations_workstation_config_iam_binding: (import 'resources/workstations_workstation_config_iam_binding.libsonnet'), + workstations_workstation_config_iam_member: (import 'resources/workstations_workstation_config_iam_member.libsonnet'), + workstations_workstation_config_iam_policy: (import 'resources/workstations_workstation_config_iam_policy.libsonnet'), + workstations_workstation_iam_binding: (import 'resources/workstations_workstation_iam_binding.libsonnet'), + workstations_workstation_iam_member: (import 'resources/workstations_workstation_iam_member.libsonnet'), + workstations_workstation_iam_policy: (import 'resources/workstations_workstation_iam_policy.libsonnet'), data: (import 'data/main.libsonnet'), } diff --git a/4.x/_gen/provider_google-beta.libsonnet b/4.x/_gen/provider_google-beta.libsonnet index 7c74f39b..7f96246e 100644 --- a/4.x/_gen/provider_google-beta.libsonnet +++ b/4.x/_gen/provider_google-beta.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-beta` 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-beta.provider.new` injects a new `google-beta` 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 - `api_gateway_custom_endpoint` (`string`): Set the `api_gateway_custom_endpoint` field on the resulting provider block. When `null`, the `api_gateway_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 - `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 - `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 - `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 - `dataform_custom_endpoint` (`string`): Set the `dataform_custom_endpoint` field on the resulting provider block. When `null`, the `dataform_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 - `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 - `firebase_custom_endpoint` (`string`): Set the `firebase_custom_endpoint` field on the resulting provider block. When `null`, the `firebase_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_database_custom_endpoint` (`string`): Set the `firebase_database_custom_endpoint` field on the resulting provider block. When `null`, the `firebase_database_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_hosting_custom_endpoint` (`string`): Set the `firebase_hosting_custom_endpoint` field on the resulting provider block. When `null`, the `firebase_hosting_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_storage_custom_endpoint` (`string`): Set the `firebase_storage_custom_endpoint` field on the resulting provider block. When `null`, the `firebase_storage_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_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 - `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 - `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 - `runtime_config_custom_endpoint` (`string`): Set the `runtime_config_custom_endpoint` field on the resulting provider block. When `null`, the `runtime_config_custom_endpoint` field will be omitted from the resulting object.\n - `runtimeconfig_custom_endpoint` (`string`): Set the `runtimeconfig_custom_endpoint` field on the resulting provider block. When `null`, the `runtimeconfig_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 - `security_scanner_custom_endpoint` (`string`): Set the `security_scanner_custom_endpoint` field on the resulting provider block. When `null`, the `security_scanner_custom_endpoint` field will be omitted from the resulting object.\n - `service_directory_custom_endpoint` (`string`): Set the `service_directory_custom_endpoint` field on the resulting provider block. When `null`, the `service_directory_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_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 - `workstations_custom_endpoint` (`string`): Set the `workstations_custom_endpoint` field on the resulting provider block. When `null`, the `workstations_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-beta.provider.batching.new](#fn-googlebetabatchingnew) 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-beta.provider.new` injects a new `google-beta` 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 - `api_gateway_custom_endpoint` (`string`): Set the `api_gateway_custom_endpoint` field on the resulting provider block. When `null`, the `api_gateway_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 - `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 - `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 - `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 - `dataform_custom_endpoint` (`string`): Set the `dataform_custom_endpoint` field on the resulting provider block. When `null`, the `dataform_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 - `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 - `firebase_custom_endpoint` (`string`): Set the `firebase_custom_endpoint` field on the resulting provider block. When `null`, the `firebase_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_database_custom_endpoint` (`string`): Set the `firebase_database_custom_endpoint` field on the resulting provider block. When `null`, the `firebase_database_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_hosting_custom_endpoint` (`string`): Set the `firebase_hosting_custom_endpoint` field on the resulting provider block. When `null`, the `firebase_hosting_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_storage_custom_endpoint` (`string`): Set the `firebase_storage_custom_endpoint` field on the resulting provider block. When `null`, the `firebase_storage_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_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 - `gkeonprem_custom_endpoint` (`string`): Set the `gkeonprem_custom_endpoint` field on the resulting provider block. When `null`, the `gkeonprem_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 - `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 - `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 - `runtime_config_custom_endpoint` (`string`): Set the `runtime_config_custom_endpoint` field on the resulting provider block. When `null`, the `runtime_config_custom_endpoint` field will be omitted from the resulting object.\n - `runtimeconfig_custom_endpoint` (`string`): Set the `runtimeconfig_custom_endpoint` field on the resulting provider block. When `null`, the `runtimeconfig_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 - `security_scanner_custom_endpoint` (`string`): Set the `security_scanner_custom_endpoint` field on the resulting provider block. When `null`, the `security_scanner_custom_endpoint` field will be omitted from the resulting object.\n - `service_directory_custom_endpoint` (`string`): Set the `service_directory_custom_endpoint` field on the resulting provider block. When `null`, the `service_directory_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_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 - `workstations_custom_endpoint` (`string`): Set the `workstations_custom_endpoint` field on the resulting provider block. When `null`, the `workstations_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-beta.provider.batching.new](#fn-googlebetabatchingnew) 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, @@ -55,6 +55,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); data_catalog_custom_endpoint=null, data_fusion_custom_endpoint=null, data_loss_prevention_custom_endpoint=null, + database_migration_service_custom_endpoint=null, dataflow_custom_endpoint=null, dataform_custom_endpoint=null, dataplex_custom_endpoint=null, @@ -80,6 +81,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); gke_backup_custom_endpoint=null, gke_hub_custom_endpoint=null, gkehub_feature_custom_endpoint=null, + gkeonprem_custom_endpoint=null, healthcare_custom_endpoint=null, iam2_custom_endpoint=null, iam_beta_custom_endpoint=null, @@ -198,6 +200,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); data_catalog_custom_endpoint=data_catalog_custom_endpoint, data_fusion_custom_endpoint=data_fusion_custom_endpoint, data_loss_prevention_custom_endpoint=data_loss_prevention_custom_endpoint, + database_migration_service_custom_endpoint=database_migration_service_custom_endpoint, dataflow_custom_endpoint=dataflow_custom_endpoint, dataform_custom_endpoint=dataform_custom_endpoint, dataplex_custom_endpoint=dataplex_custom_endpoint, @@ -223,6 +226,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); gke_backup_custom_endpoint=gke_backup_custom_endpoint, gke_hub_custom_endpoint=gke_hub_custom_endpoint, gkehub_feature_custom_endpoint=gkehub_feature_custom_endpoint, + gkeonprem_custom_endpoint=gkeonprem_custom_endpoint, healthcare_custom_endpoint=healthcare_custom_endpoint, iam2_custom_endpoint=iam2_custom_endpoint, iam_beta_custom_endpoint=iam_beta_custom_endpoint, @@ -283,7 +287,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); zone=zone ) ), - '#newAttrs':: d.fn(help='\n`google-beta.provider.` constructs a new object with attributes and blocks configured for the `google-beta`\nTerraform `provider`.\n\nUnlike [google-beta.provider.new](#fn-googlebetanew), 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 - `api_gateway_custom_endpoint` (`string`): Set the `api_gateway_custom_endpoint` field on the resulting object. When `null`, the `api_gateway_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 - `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 - `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 - `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 - `dataform_custom_endpoint` (`string`): Set the `dataform_custom_endpoint` field on the resulting object. When `null`, the `dataform_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 - `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 - `firebase_custom_endpoint` (`string`): Set the `firebase_custom_endpoint` field on the resulting object. When `null`, the `firebase_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_database_custom_endpoint` (`string`): Set the `firebase_database_custom_endpoint` field on the resulting object. When `null`, the `firebase_database_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_hosting_custom_endpoint` (`string`): Set the `firebase_hosting_custom_endpoint` field on the resulting object. When `null`, the `firebase_hosting_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_storage_custom_endpoint` (`string`): Set the `firebase_storage_custom_endpoint` field on the resulting object. When `null`, the `firebase_storage_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_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 - `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 - `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 - `runtime_config_custom_endpoint` (`string`): Set the `runtime_config_custom_endpoint` field on the resulting object. When `null`, the `runtime_config_custom_endpoint` field will be omitted from the resulting object.\n - `runtimeconfig_custom_endpoint` (`string`): Set the `runtimeconfig_custom_endpoint` field on the resulting object. When `null`, the `runtimeconfig_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 - `security_scanner_custom_endpoint` (`string`): Set the `security_scanner_custom_endpoint` field on the resulting object. When `null`, the `security_scanner_custom_endpoint` field will be omitted from the resulting object.\n - `service_directory_custom_endpoint` (`string`): Set the `service_directory_custom_endpoint` field on the resulting object. When `null`, the `service_directory_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_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 - `workstations_custom_endpoint` (`string`): Set the `workstations_custom_endpoint` field on the resulting object. When `null`, the `workstations_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-beta.provider.batching.new](#fn-googlebetabatchingnew) 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-beta` provider\n configuration into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.provider.` constructs a new object with attributes and blocks configured for the `google-beta`\nTerraform `provider`.\n\nUnlike [google-beta.provider.new](#fn-googlebetanew), 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 - `api_gateway_custom_endpoint` (`string`): Set the `api_gateway_custom_endpoint` field on the resulting object. When `null`, the `api_gateway_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 - `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 - `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 - `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 - `dataform_custom_endpoint` (`string`): Set the `dataform_custom_endpoint` field on the resulting object. When `null`, the `dataform_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 - `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 - `firebase_custom_endpoint` (`string`): Set the `firebase_custom_endpoint` field on the resulting object. When `null`, the `firebase_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_database_custom_endpoint` (`string`): Set the `firebase_database_custom_endpoint` field on the resulting object. When `null`, the `firebase_database_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_hosting_custom_endpoint` (`string`): Set the `firebase_hosting_custom_endpoint` field on the resulting object. When `null`, the `firebase_hosting_custom_endpoint` field will be omitted from the resulting object.\n - `firebase_storage_custom_endpoint` (`string`): Set the `firebase_storage_custom_endpoint` field on the resulting object. When `null`, the `firebase_storage_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_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 - `gkeonprem_custom_endpoint` (`string`): Set the `gkeonprem_custom_endpoint` field on the resulting object. When `null`, the `gkeonprem_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 - `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 - `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 - `runtime_config_custom_endpoint` (`string`): Set the `runtime_config_custom_endpoint` field on the resulting object. When `null`, the `runtime_config_custom_endpoint` field will be omitted from the resulting object.\n - `runtimeconfig_custom_endpoint` (`string`): Set the `runtimeconfig_custom_endpoint` field on the resulting object. When `null`, the `runtimeconfig_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 - `security_scanner_custom_endpoint` (`string`): Set the `security_scanner_custom_endpoint` field on the resulting object. When `null`, the `security_scanner_custom_endpoint` field will be omitted from the resulting object.\n - `service_directory_custom_endpoint` (`string`): Set the `service_directory_custom_endpoint` field on the resulting object. When `null`, the `service_directory_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_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 - `workstations_custom_endpoint` (`string`): Set the `workstations_custom_endpoint` field on the resulting object. When `null`, the `workstations_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-beta.provider.batching.new](#fn-googlebetabatchingnew) 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-beta` provider\n configuration into the root Terraform configuration.\n', args=[]), newAttrs( access_approval_custom_endpoint=null, access_context_manager_custom_endpoint=null, @@ -336,6 +340,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); data_catalog_custom_endpoint=null, data_fusion_custom_endpoint=null, data_loss_prevention_custom_endpoint=null, + database_migration_service_custom_endpoint=null, dataflow_custom_endpoint=null, dataform_custom_endpoint=null, dataplex_custom_endpoint=null, @@ -361,6 +366,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); gke_backup_custom_endpoint=null, gke_hub_custom_endpoint=null, gkehub_feature_custom_endpoint=null, + gkeonprem_custom_endpoint=null, healthcare_custom_endpoint=null, iam2_custom_endpoint=null, iam_beta_custom_endpoint=null, @@ -471,6 +477,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); data_catalog_custom_endpoint: data_catalog_custom_endpoint, data_fusion_custom_endpoint: data_fusion_custom_endpoint, data_loss_prevention_custom_endpoint: data_loss_prevention_custom_endpoint, + database_migration_service_custom_endpoint: database_migration_service_custom_endpoint, dataflow_custom_endpoint: dataflow_custom_endpoint, dataform_custom_endpoint: dataform_custom_endpoint, dataplex_custom_endpoint: dataplex_custom_endpoint, @@ -496,6 +503,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); gke_backup_custom_endpoint: gke_backup_custom_endpoint, gke_hub_custom_endpoint: gke_hub_custom_endpoint, gkehub_feature_custom_endpoint: gkehub_feature_custom_endpoint, + gkeonprem_custom_endpoint: gkeonprem_custom_endpoint, healthcare_custom_endpoint: healthcare_custom_endpoint, iam2_custom_endpoint: iam2_custom_endpoint, iam_beta_custom_endpoint: iam_beta_custom_endpoint, diff --git a/4.x/_gen/resources/access_context_manager_access_level.libsonnet b/4.x/_gen/resources/access_context_manager_access_level.libsonnet index 40b61dcd..8a5c8874 100644 --- a/4.x/_gen/resources/access_context_manager_access_level.libsonnet +++ b/4.x/_gen/resources/access_context_manager_access_level.libsonnet @@ -75,14 +75,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); title: title, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_access_level.custom.new` constructs a new object with attributes and blocks configured for the `custom`\nTerraform sub block.\n\n\n\n**Args**:\n - `expr` (`list[obj]`): Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language.\nThis page details the objects and attributes that are used to the build the CEL expressions for \ncustom access levels - https://cloud.google.com/access-context-manager/docs/custom-access-level-spec. When `null`, the `expr` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.custom.expr.new](#fn-customexprnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_access_level.custom.new` constructs a new object with attributes and blocks configured for the `custom`\nTerraform sub block.\n\n\n\n**Args**:\n - `expr` (`list[obj]`): Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language.\nThis page details the objects and attributes that are used to the build the CEL expressions for\ncustom access levels - https://cloud.google.com/access-context-manager/docs/custom-access-level-spec. When `null`, the `expr` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.custom.expr.new](#fn-customexprnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom` sub block.\n', args=[]), new( expr=null ):: std.prune(a={ expr: expr, }), }, - '#new':: d.fn(help="\n`google-beta.google_access_context_manager_access_level.new` injects a new `google-beta_google_access_context_manager_access_level` 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-beta.google_access_context_manager_access_level.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_access_context_manager_access_level` using the reference:\n\n $._ref.google-beta_google_access_context_manager_access_level.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_access_context_manager_access_level.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): Description of the AccessLevel and its use. Does not affect behavior. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Resource name for the Access Level. The short_name component must begin\nwith a letter and only include alphanumeric and \u0026#39;_\u0026#39;.\nFormat: accessPolicies/{policy_id}/accessLevels/{short_name}\n - `parent` (`string`): The AccessPolicy this AccessLevel lives in.\nFormat: accessPolicies/{policy_id}\n - `title` (`string`): Human readable title. Must be unique within the Policy.\n - `basic` (`list[obj]`): A set of predefined conditions for the access level and a combining function. When `null`, the `basic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.basic.new](#fn-basicnew) constructor.\n - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. \nSee CEL spec at: https://github.com/google/cel-spec. When `null`, the `custom` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.custom.new](#fn-customnew) 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-beta.google_access_context_manager_access_level.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-beta.google_access_context_manager_access_level.new` injects a new `google-beta_google_access_context_manager_access_level` 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-beta.google_access_context_manager_access_level.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_access_context_manager_access_level` using the reference:\n\n $._ref.google-beta_google_access_context_manager_access_level.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_access_context_manager_access_level.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): Description of the AccessLevel and its use. Does not affect behavior. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Resource name for the Access Level. The short_name component must begin\nwith a letter and only include alphanumeric and \u0026#39;_\u0026#39;.\nFormat: accessPolicies/{policy_id}/accessLevels/{short_name}\n - `parent` (`string`): The AccessPolicy this AccessLevel lives in.\nFormat: accessPolicies/{policy_id}\n - `title` (`string`): Human readable title. Must be unique within the Policy.\n - `basic` (`list[obj]`): A set of predefined conditions for the access level and a combining function. When `null`, the `basic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.basic.new](#fn-basicnew) constructor.\n - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request.\nSee CEL spec at: https://github.com/google/cel-spec. When `null`, the `custom` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.custom.new](#fn-customnew) 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-beta.google_access_context_manager_access_level.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, @@ -107,7 +107,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_access_context_manager_access_level.newAttrs` constructs a new object with attributes and blocks configured for the `google_access_context_manager_access_level`\nTerraform resource.\n\nUnlike [google-beta.google_access_context_manager_access_level.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): Description of the AccessLevel and its use. Does not affect behavior. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Resource name for the Access Level. The short_name component must begin\nwith a letter and only include alphanumeric and '_'.\nFormat: accessPolicies/{policy_id}/accessLevels/{short_name}\n - `parent` (`string`): The AccessPolicy this AccessLevel lives in.\nFormat: accessPolicies/{policy_id}\n - `title` (`string`): Human readable title. Must be unique within the Policy.\n - `basic` (`list[obj]`): A set of predefined conditions for the access level and a combining function. When `null`, the `basic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.basic.new](#fn-basicnew) constructor.\n - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. \nSee CEL spec at: https://github.com/google/cel-spec. When `null`, the `custom` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.custom.new](#fn-customnew) 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-beta.google_access_context_manager_access_level.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 `google_access_context_manager_access_level` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_access_context_manager_access_level.newAttrs` constructs a new object with attributes and blocks configured for the `google_access_context_manager_access_level`\nTerraform resource.\n\nUnlike [google-beta.google_access_context_manager_access_level.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): Description of the AccessLevel and its use. Does not affect behavior. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Resource name for the Access Level. The short_name component must begin\nwith a letter and only include alphanumeric and '_'.\nFormat: accessPolicies/{policy_id}/accessLevels/{short_name}\n - `parent` (`string`): The AccessPolicy this AccessLevel lives in.\nFormat: accessPolicies/{policy_id}\n - `title` (`string`): Human readable title. Must be unique within the Policy.\n - `basic` (`list[obj]`): A set of predefined conditions for the access level and a combining function. When `null`, the `basic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.basic.new](#fn-basicnew) constructor.\n - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request.\nSee CEL spec at: https://github.com/google/cel-spec. When `null`, the `custom` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.custom.new](#fn-customnew) 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-beta.google_access_context_manager_access_level.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 `google_access_context_manager_access_level` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, parent, diff --git a/4.x/_gen/resources/access_context_manager_access_levels.libsonnet b/4.x/_gen/resources/access_context_manager_access_levels.libsonnet index fd64ada1..ac237b7d 100644 --- a/4.x/_gen/resources/access_context_manager_access_levels.libsonnet +++ b/4.x/_gen/resources/access_context_manager_access_levels.libsonnet @@ -74,14 +74,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); title: title, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_access_levels.access_levels.custom.new` constructs a new object with attributes and blocks configured for the `custom`\nTerraform sub block.\n\n\n\n**Args**:\n - `expr` (`list[obj]`): Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language.\nThis page details the objects and attributes that are used to the build the CEL expressions for \ncustom access levels - https://cloud.google.com/access-context-manager/docs/custom-access-level-spec. When `null`, the `expr` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_levels.access_levels.custom.expr.new](#fn-access_levelsaccess_levelsexprnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_access_levels.access_levels.custom.new` constructs a new object with attributes and blocks configured for the `custom`\nTerraform sub block.\n\n\n\n**Args**:\n - `expr` (`list[obj]`): Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language.\nThis page details the objects and attributes that are used to the build the CEL expressions for\ncustom access levels - https://cloud.google.com/access-context-manager/docs/custom-access-level-spec. When `null`, the `expr` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_levels.access_levels.custom.expr.new](#fn-access_levelsaccess_levelsexprnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom` sub block.\n', args=[]), new( expr=null ):: std.prune(a={ expr: expr, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_access_levels.access_levels.new` constructs a new object with attributes and blocks configured for the `access_levels`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): Description of the AccessLevel and its use. Does not affect behavior. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Resource name for the Access Level. The short_name component must begin\nwith a letter and only include alphanumeric and '_'.\nFormat: accessPolicies/{policy_id}/accessLevels/{short_name}\n - `title` (`string`): Human readable title. Must be unique within the Policy.\n - `basic` (`list[obj]`): A set of predefined conditions for the access level and a combining function. When `null`, the `basic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_levels.access_levels.basic.new](#fn-access_levelsbasicnew) constructor.\n - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. \nSee CEL spec at: https://github.com/google/cel-spec. When `null`, the `custom` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_levels.access_levels.custom.new](#fn-access_levelscustomnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `access_levels` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_access_levels.access_levels.new` constructs a new object with attributes and blocks configured for the `access_levels`\nTerraform sub block.\n\n\n\n**Args**:\n - `description` (`string`): Description of the AccessLevel and its use. Does not affect behavior. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Resource name for the Access Level. The short_name component must begin\nwith a letter and only include alphanumeric and '_'.\nFormat: accessPolicies/{policy_id}/accessLevels/{short_name}\n - `title` (`string`): Human readable title. Must be unique within the Policy.\n - `basic` (`list[obj]`): A set of predefined conditions for the access level and a combining function. When `null`, the `basic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_levels.access_levels.basic.new](#fn-access_levelsbasicnew) constructor.\n - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request.\nSee CEL spec at: https://github.com/google/cel-spec. When `null`, the `custom` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_levels.access_levels.custom.new](#fn-access_levelscustomnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `access_levels` sub block.\n', args=[]), new( name, title, diff --git a/4.x/_gen/resources/access_context_manager_egress_policy.libsonnet b/4.x/_gen/resources/access_context_manager_egress_policy.libsonnet new file mode 100644 index 00000000..6edad15a --- /dev/null +++ b/4.x/_gen/resources/access_context_manager_egress_policy.libsonnet @@ -0,0 +1,78 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='google_access_context_manager_egress_policy', url='', help='`google_access_context_manager_egress_policy` represents the `google-beta_google_access_context_manager_egress_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-beta.google_access_context_manager_egress_policy.new` injects a new `google-beta_google_access_context_manager_egress_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-beta.google_access_context_manager_egress_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_access_context_manager_egress_policy` using the reference:\n\n $._ref.google-beta_google_access_context_manager_egress_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_access_context_manager_egress_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 - `egress_policy_name` (`string`): The name of the Service Perimeter to add this resource to.\n - `resource` (`string`): A GCP resource that is inside of the service perimeter.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_egress_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + egress_policy_name, + resource, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_access_context_manager_egress_policy', + label=resourceLabel, + attrs=self.newAttrs(egress_policy_name=egress_policy_name, resource=resource, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_access_context_manager_egress_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_access_context_manager_egress_policy`\nTerraform resource.\n\nUnlike [google-beta.google_access_context_manager_egress_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 - `egress_policy_name` (`string`): The name of the Service Perimeter to add this resource to.\n - `resource` (`string`): A GCP resource that is inside of the service perimeter.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_egress_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_access_context_manager_egress_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + egress_policy_name, + resource, + timeouts=null + ):: std.prune(a={ + egress_policy_name: egress_policy_name, + resource: resource, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_egress_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, + '#withEgressPolicyName':: d.fn(help='`google-beta.string.withEgressPolicyName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the egress_policy_name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `egress_policy_name` field.\n', args=[]), + withEgressPolicyName(resourceLabel, value): { + resource+: { + google_access_context_manager_egress_policy+: { + [resourceLabel]+: { + egress_policy_name: value, + }, + }, + }, + }, + '#withResource':: d.fn(help='`google-beta.string.withResource` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the resource field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `resource` field.\n', args=[]), + withResource(resourceLabel, value): { + resource+: { + google_access_context_manager_egress_policy+: { + [resourceLabel]+: { + resource: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.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-beta.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_access_context_manager_egress_policy+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.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-beta.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_access_context_manager_egress_policy+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/access_context_manager_service_perimeter.libsonnet b/4.x/_gen/resources/access_context_manager_service_perimeter.libsonnet index 1ad8a4bf..4a7a6cd5 100644 --- a/4.x/_gen/resources/access_context_manager_service_perimeter.libsonnet +++ b/4.x/_gen/resources/access_context_manager_service_perimeter.libsonnet @@ -56,7 +56,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); spec:: { egress_policies:: { egress_from:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_from.new` constructs a new object with attributes and blocks configured for the `egress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. \nShould be in the format of email address. The email address should \nrepresent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the \nperimeter. If left unspecified, then members of 'identities' field will \nbe allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `egress_from` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_from.new` constructs a new object with attributes and blocks configured for the `egress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'.\nShould be in the format of email address. The email address should\nrepresent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the\nperimeter. If left unspecified, then members of 'identities' field will\nbe allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `egress_from` sub block.\n', args=[]), new( identities=null, identity_type=null @@ -66,7 +66,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, egress_to:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.new` constructs a new object with attributes and blocks configured for the `egress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request\nmatches if it contains an external resource in this list (Example:\ns3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object.\n - `resources` (`list`): A list of resources, currently only projects in the form \n'projects/<projectnumber>', that match this to stanza. A request matches \nif it contains a resource in this list. If * is specified for resources, \nthen this 'EgressTo' rule will authorize access to all resources outside \nthe perimeter. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches \nif it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.operations.new](#fn-specspecegress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_to` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.new` constructs a new object with attributes and blocks configured for the `egress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request\nmatches if it contains an external resource in this list (Example:\ns3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object.\n - `resources` (`list`): A list of resources, currently only projects in the form\n'projects/<projectnumber>', that match this to stanza. A request matches\nif it contains a resource in this list. If * is specified for resources,\nthen this 'EgressTo' rule will authorize access to all resources outside\nthe perimeter. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches\nif it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.operations.new](#fn-specspecegress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_to` sub block.\n', args=[]), new( external_resources=null, operations=null, @@ -78,7 +78,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), operations:: { method_selectors:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for 'method' should be a valid method name for the corresponding \n'serviceName' in 'ApiOperation'. If '*' used as value for method, \nthen ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the \ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for 'method' should be a valid method name for the corresponding\n'serviceName' in 'ApiOperation'. If '*' used as value for method,\nthen ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the\ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), new( method=null, permission=null @@ -87,7 +87,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); permission: permission, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or \n'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName \nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong \nto the service specified by 'serviceName' field. A single MethodSelector \nentry with '*' specified for the 'method' field will allow all methods \nAND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.operations.method_selectors.new](#fn-specspecegress_policiesegress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or\n'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName\nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong\nto the service specified by 'serviceName' field. A single MethodSelector\nentry with '*' specified for the 'method' field will allow all methods\nAND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.operations.method_selectors.new](#fn-specspecegress_policiesegress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), new( method_selectors=null, service_name=null @@ -97,7 +97,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.new` constructs a new object with attributes and blocks configured for the `egress_policies`\nTerraform sub block.\n\n\n\n**Args**:\n - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_from.new](#fn-specspecegress_fromnew) constructor.\n - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that \ncause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.new](#fn-specspecegress_tonew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_policies` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.new` constructs a new object with attributes and blocks configured for the `egress_policies`\nTerraform sub block.\n\n\n\n**Args**:\n - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_from.new](#fn-specspecegress_fromnew) constructor.\n - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that\ncause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.new](#fn-specspecegress_tonew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_policies` sub block.\n', args=[]), new( egress_from=null, egress_to=null @@ -108,7 +108,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, ingress_policies:: { ingress_from:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_from.new` constructs a new object with attributes and blocks configured for the `ingress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this ingress policy.\nShould be in the format of email address. The email address should represent \nindividual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the \nperimeter. If left unspecified, then members of 'identities' field will be \nallowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_from.sources.new](#fn-specspecingress_policiessourcesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_from` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_from.new` constructs a new object with attributes and blocks configured for the `ingress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this ingress policy.\nShould be in the format of email address. The email address should represent\nindividual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the\nperimeter. If left unspecified, then members of 'identities' field will be\nallowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_from.sources.new](#fn-specspecingress_policiessourcesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_from` sub block.\n', args=[]), new( identities=null, identity_type=null, @@ -119,7 +119,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); sources: sources, }), sources:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_from.sources.new` constructs a new object with attributes and blocks configured for the `sources`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the \n'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed \nmust be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent\n'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, \nresources within the perimeter can only be accessed via Google Cloud calls \nwith request origins within the perimeter. \nExample 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' \nIf * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object.\n - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. \nRequests from these resources will be allowed to access perimeter data. \nCurrently only projects are allowed. Format 'projects/{project_number}' \nThe project may be in any Google Cloud organization, not just the \norganization that the perimeter is defined in. '*' is not allowed, the case \nof allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sources` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_from.sources.new` constructs a new object with attributes and blocks configured for the `sources`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the\n'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed\nmust be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent\n'AccessLevel' will cause an error. If no 'AccessLevel' names are listed,\nresources within the perimeter can only be accessed via Google Cloud calls\nwith request origins within the perimeter.\nExample 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.'\nIf * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object.\n - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter.\nRequests from these resources will be allowed to access perimeter data.\nCurrently only projects are allowed. Format 'projects/{project_number}'\nThe project may be in any Google Cloud organization, not just the\norganization that the perimeter is defined in. '*' is not allowed, the case\nof allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sources` sub block.\n', args=[]), new( access_level=null, resource=null @@ -130,7 +130,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, ingress_to:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.new` constructs a new object with attributes and blocks configured for the `ingress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `resources` (`list`): A list of resources, currently only projects in the form \n'projects/<projectnumber>', protected by this 'ServicePerimeter'\nthat are allowed to be accessed by sources defined in the\ncorresponding 'IngressFrom'. A request matches if it contains\na resource in this list. If '*' is specified for resources,\nthen this 'IngressTo' rule will authorize access to all \nresources inside the perimeter, provided that the request\nalso matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' \nare allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.operations.new](#fn-specspecingress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_to` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.new` constructs a new object with attributes and blocks configured for the `ingress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `resources` (`list`): A list of resources, currently only projects in the form\n'projects/<projectnumber>', protected by this 'ServicePerimeter'\nthat are allowed to be accessed by sources defined in the\ncorresponding 'IngressFrom'. A request matches if it contains\na resource in this list. If '*' is specified for resources,\nthen this 'IngressTo' rule will authorize access to all\nresources inside the perimeter, provided that the request\nalso matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom'\nare allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.operations.new](#fn-specspecingress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_to` sub block.\n', args=[]), new( operations=null, resources=null @@ -140,7 +140,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), operations:: { method_selectors:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for method should be a valid method name for the corresponding \nserviceName in 'ApiOperation'. If '*' used as value for 'method', then \nALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the \ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for method should be a valid method name for the corresponding\nserviceName in 'ApiOperation'. If '*' used as value for 'method', then\nALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the\ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), new( method=null, permission=null @@ -149,7 +149,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); permission: permission, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or \n'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' \nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to \nthe service specified by serviceName field. A single 'MethodSelector' entry \nwith '*' specified for the method field will allow all methods AND \npermissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.operations.method_selectors.new](#fn-specspecingress_policiesingress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or\n'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName'\nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to\nthe service specified by serviceName field. A single 'MethodSelector' entry\nwith '*' specified for the method field will allow all methods AND\npermissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.operations.method_selectors.new](#fn-specspecingress_policiesingress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), new( method_selectors=null, service_name=null @@ -168,7 +168,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ingress_to: ingress_to, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.new` constructs a new object with attributes and blocks configured for the `spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_levels` (`list`): A list of AccessLevel resource names that allow resources within\nthe ServicePerimeter to be accessed from the internet.\nAccessLevels listed must be in the same policy as this\nServicePerimeter. Referencing a nonexistent AccessLevel is a\nsyntax error. If no AccessLevel names are listed, resources within\nthe perimeter can only be accessed via GCP calls with request\norigins within the perimeter. For Service Perimeter Bridge, must\nbe empty.\n\nFormat: accessPolicies/{policy_id}/accessLevels/{access_level_name} When `null`, the `access_levels` field will be omitted from the resulting object.\n - `resources` (`list`): A list of GCP resources that are inside of the service perimeter.\nCurrently only projects are allowed.\nFormat: projects/{project_number} When `null`, the `resources` field will be omitted from the resulting object.\n - `restricted_services` (`list`): GCP services that are subject to the Service Perimeter\nrestrictions. Must contain a list of services. For example, if\n'storage.googleapis.com' is specified, access to the storage\nbuckets inside the perimeter must meet the perimeter's access\nrestrictions. When `null`, the `restricted_services` field will be omitted from the resulting object.\n - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may \nhave multiple EgressPolicies, each of which is evaluated separately.\nAccess is granted if any EgressPolicy grants it. Must be empty for \na perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.new](#fn-specegress_policiesnew) constructor.\n - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may\nhave multiple 'IngressPolicies', each of which is evaluated\nseparately. Access is granted if any 'Ingress Policy' grants it.\nMust be empty for a perimeter bridge. When `null`, the `ingress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.new](#fn-specingress_policiesnew) constructor.\n - `vpc_accessible_services` (`list[obj]`): Specifies how APIs are allowed to communicate within the Service\nPerimeter. When `null`, the `vpc_accessible_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.vpc_accessible_services.new](#fn-specvpc_accessible_servicesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.spec.new` constructs a new object with attributes and blocks configured for the `spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_levels` (`list`): A list of AccessLevel resource names that allow resources within\nthe ServicePerimeter to be accessed from the internet.\nAccessLevels listed must be in the same policy as this\nServicePerimeter. Referencing a nonexistent AccessLevel is a\nsyntax error. If no AccessLevel names are listed, resources within\nthe perimeter can only be accessed via GCP calls with request\norigins within the perimeter. For Service Perimeter Bridge, must\nbe empty.\n\nFormat: accessPolicies/{policy_id}/accessLevels/{access_level_name} When `null`, the `access_levels` field will be omitted from the resulting object.\n - `resources` (`list`): A list of GCP resources that are inside of the service perimeter.\nCurrently only projects are allowed.\nFormat: projects/{project_number} When `null`, the `resources` field will be omitted from the resulting object.\n - `restricted_services` (`list`): GCP services that are subject to the Service Perimeter\nrestrictions. Must contain a list of services. For example, if\n'storage.googleapis.com' is specified, access to the storage\nbuckets inside the perimeter must meet the perimeter's access\nrestrictions. When `null`, the `restricted_services` field will be omitted from the resulting object.\n - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may\nhave multiple EgressPolicies, each of which is evaluated separately.\nAccess is granted if any EgressPolicy grants it. Must be empty for\na perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.new](#fn-specegress_policiesnew) constructor.\n - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may\nhave multiple 'IngressPolicies', each of which is evaluated\nseparately. Access is granted if any 'Ingress Policy' grants it.\nMust be empty for a perimeter bridge. When `null`, the `ingress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.new](#fn-specingress_policiesnew) constructor.\n - `vpc_accessible_services` (`list[obj]`): Specifies how APIs are allowed to communicate within the Service\nPerimeter. When `null`, the `vpc_accessible_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.vpc_accessible_services.new](#fn-specvpc_accessible_servicesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `spec` sub block.\n', args=[]), new( access_levels=null, egress_policies=null, @@ -198,7 +198,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); status:: { egress_policies:: { egress_from:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_from.new` constructs a new object with attributes and blocks configured for the `egress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. \nShould be in the format of email address. The email address should \nrepresent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the \nperimeter. If left unspecified, then members of 'identities' field will \nbe allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `egress_from` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_from.new` constructs a new object with attributes and blocks configured for the `egress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'.\nShould be in the format of email address. The email address should\nrepresent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the\nperimeter. If left unspecified, then members of 'identities' field will\nbe allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `egress_from` sub block.\n', args=[]), new( identities=null, identity_type=null @@ -208,7 +208,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, egress_to:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.new` constructs a new object with attributes and blocks configured for the `egress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request\nmatches if it contains an external resource in this list (Example:\ns3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object.\n - `resources` (`list`): A list of resources, currently only projects in the form \n'projects/<projectnumber>', that match this to stanza. A request matches \nif it contains a resource in this list. If * is specified for resources, \nthen this 'EgressTo' rule will authorize access to all resources outside \nthe perimeter. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches \nif it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.operations.new](#fn-statusstatusegress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_to` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.new` constructs a new object with attributes and blocks configured for the `egress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request\nmatches if it contains an external resource in this list (Example:\ns3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object.\n - `resources` (`list`): A list of resources, currently only projects in the form\n'projects/<projectnumber>', that match this to stanza. A request matches\nif it contains a resource in this list. If * is specified for resources,\nthen this 'EgressTo' rule will authorize access to all resources outside\nthe perimeter. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches\nif it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.operations.new](#fn-statusstatusegress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_to` sub block.\n', args=[]), new( external_resources=null, operations=null, @@ -220,7 +220,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), operations:: { method_selectors:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for 'method' should be a valid method name for the corresponding \n'serviceName' in 'ApiOperation'. If '*' used as value for method, \nthen ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the \ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for 'method' should be a valid method name for the corresponding\n'serviceName' in 'ApiOperation'. If '*' used as value for method,\nthen ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the\ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), new( method=null, permission=null @@ -229,7 +229,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); permission: permission, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or \n'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName \nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong \nto the service specified by 'serviceName' field. A single MethodSelector \nentry with '*' specified for the 'method' field will allow all methods \nAND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.operations.method_selectors.new](#fn-statusstatusegress_policiesegress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or\n'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName\nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong\nto the service specified by 'serviceName' field. A single MethodSelector\nentry with '*' specified for the 'method' field will allow all methods\nAND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.operations.method_selectors.new](#fn-statusstatusegress_policiesegress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), new( method_selectors=null, service_name=null @@ -239,7 +239,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.egress_policies.new` constructs a new object with attributes and blocks configured for the `egress_policies`\nTerraform sub block.\n\n\n\n**Args**:\n - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_from.new](#fn-statusstatusegress_fromnew) constructor.\n - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that \ncause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.new](#fn-statusstatusegress_tonew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_policies` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.egress_policies.new` constructs a new object with attributes and blocks configured for the `egress_policies`\nTerraform sub block.\n\n\n\n**Args**:\n - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_from.new](#fn-statusstatusegress_fromnew) constructor.\n - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that\ncause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.new](#fn-statusstatusegress_tonew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_policies` sub block.\n', args=[]), new( egress_from=null, egress_to=null @@ -250,7 +250,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, ingress_policies:: { ingress_from:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_from.new` constructs a new object with attributes and blocks configured for the `ingress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this ingress policy.\nShould be in the format of email address. The email address should represent \nindividual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the \nperimeter. If left unspecified, then members of 'identities' field will be \nallowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_from.sources.new](#fn-statusstatusingress_policiessourcesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_from` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_from.new` constructs a new object with attributes and blocks configured for the `ingress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this ingress policy.\nShould be in the format of email address. The email address should represent\nindividual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the\nperimeter. If left unspecified, then members of 'identities' field will be\nallowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_from.sources.new](#fn-statusstatusingress_policiessourcesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_from` sub block.\n', args=[]), new( identities=null, identity_type=null, @@ -261,7 +261,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); sources: sources, }), sources:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_from.sources.new` constructs a new object with attributes and blocks configured for the `sources`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the \n'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed \nmust be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent\n'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, \nresources within the perimeter can only be accessed via Google Cloud calls \nwith request origins within the perimeter. \nExample 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' \nIf * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object.\n - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. \nRequests from these resources will be allowed to access perimeter data. \nCurrently only projects are allowed. Format 'projects/{project_number}' \nThe project may be in any Google Cloud organization, not just the \norganization that the perimeter is defined in. '*' is not allowed, the case \nof allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sources` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_from.sources.new` constructs a new object with attributes and blocks configured for the `sources`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the\n'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed\nmust be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent\n'AccessLevel' will cause an error. If no 'AccessLevel' names are listed,\nresources within the perimeter can only be accessed via Google Cloud calls\nwith request origins within the perimeter.\nExample 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.'\nIf * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object.\n - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter.\nRequests from these resources will be allowed to access perimeter data.\nCurrently only projects are allowed. Format 'projects/{project_number}'\nThe project may be in any Google Cloud organization, not just the\norganization that the perimeter is defined in. '*' is not allowed, the case\nof allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sources` sub block.\n', args=[]), new( access_level=null, resource=null @@ -272,7 +272,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, ingress_to:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.new` constructs a new object with attributes and blocks configured for the `ingress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `resources` (`list`): A list of resources, currently only projects in the form \n'projects/<projectnumber>', protected by this 'ServicePerimeter'\nthat are allowed to be accessed by sources defined in the\ncorresponding 'IngressFrom'. A request matches if it contains\na resource in this list. If '*' is specified for resources,\nthen this 'IngressTo' rule will authorize access to all \nresources inside the perimeter, provided that the request\nalso matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' \nare allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.operations.new](#fn-statusstatusingress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_to` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.new` constructs a new object with attributes and blocks configured for the `ingress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `resources` (`list`): A list of resources, currently only projects in the form\n'projects/<projectnumber>', protected by this 'ServicePerimeter'\nthat are allowed to be accessed by sources defined in the\ncorresponding 'IngressFrom'. A request matches if it contains\na resource in this list. If '*' is specified for resources,\nthen this 'IngressTo' rule will authorize access to all\nresources inside the perimeter, provided that the request\nalso matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom'\nare allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.operations.new](#fn-statusstatusingress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_to` sub block.\n', args=[]), new( operations=null, resources=null @@ -282,7 +282,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), operations:: { method_selectors:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for method should be a valid method name for the corresponding \nserviceName in 'ApiOperation'. If '*' used as value for 'method', then \nALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the \ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for method should be a valid method name for the corresponding\nserviceName in 'ApiOperation'. If '*' used as value for 'method', then\nALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the\ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), new( method=null, permission=null @@ -291,7 +291,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); permission: permission, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or \n'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' \nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to \nthe service specified by serviceName field. A single 'MethodSelector' entry \nwith '*' specified for the method field will allow all methods AND \npermissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.operations.method_selectors.new](#fn-statusstatusingress_policiesingress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or\n'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName'\nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to\nthe service specified by serviceName field. A single 'MethodSelector' entry\nwith '*' specified for the method field will allow all methods AND\npermissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.operations.method_selectors.new](#fn-statusstatusingress_policiesingress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), new( method_selectors=null, service_name=null @@ -310,7 +310,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ingress_to: ingress_to, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.new` constructs a new object with attributes and blocks configured for the `status`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_levels` (`list`): A list of AccessLevel resource names that allow resources within\nthe ServicePerimeter to be accessed from the internet.\nAccessLevels listed must be in the same policy as this\nServicePerimeter. Referencing a nonexistent AccessLevel is a\nsyntax error. If no AccessLevel names are listed, resources within\nthe perimeter can only be accessed via GCP calls with request\norigins within the perimeter. For Service Perimeter Bridge, must\nbe empty.\n\nFormat: accessPolicies/{policy_id}/accessLevels/{access_level_name} When `null`, the `access_levels` field will be omitted from the resulting object.\n - `resources` (`list`): A list of GCP resources that are inside of the service perimeter.\nCurrently only projects are allowed.\nFormat: projects/{project_number} When `null`, the `resources` field will be omitted from the resulting object.\n - `restricted_services` (`list`): GCP services that are subject to the Service Perimeter\nrestrictions. Must contain a list of services. For example, if\n'storage.googleapis.com' is specified, access to the storage\nbuckets inside the perimeter must meet the perimeter's access\nrestrictions. When `null`, the `restricted_services` field will be omitted from the resulting object.\n - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may \nhave multiple EgressPolicies, each of which is evaluated separately.\nAccess is granted if any EgressPolicy grants it. Must be empty for \na perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.new](#fn-statusegress_policiesnew) constructor.\n - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may\nhave multiple 'IngressPolicies', each of which is evaluated\nseparately. Access is granted if any 'Ingress Policy' grants it.\nMust be empty for a perimeter bridge. When `null`, the `ingress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.new](#fn-statusingress_policiesnew) constructor.\n - `vpc_accessible_services` (`list[obj]`): Specifies how APIs are allowed to communicate within the Service\nPerimeter. When `null`, the `vpc_accessible_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.vpc_accessible_services.new](#fn-statusvpc_accessible_servicesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `status` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeter.status.new` constructs a new object with attributes and blocks configured for the `status`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_levels` (`list`): A list of AccessLevel resource names that allow resources within\nthe ServicePerimeter to be accessed from the internet.\nAccessLevels listed must be in the same policy as this\nServicePerimeter. Referencing a nonexistent AccessLevel is a\nsyntax error. If no AccessLevel names are listed, resources within\nthe perimeter can only be accessed via GCP calls with request\norigins within the perimeter. For Service Perimeter Bridge, must\nbe empty.\n\nFormat: accessPolicies/{policy_id}/accessLevels/{access_level_name} When `null`, the `access_levels` field will be omitted from the resulting object.\n - `resources` (`list`): A list of GCP resources that are inside of the service perimeter.\nCurrently only projects are allowed.\nFormat: projects/{project_number} When `null`, the `resources` field will be omitted from the resulting object.\n - `restricted_services` (`list`): GCP services that are subject to the Service Perimeter\nrestrictions. Must contain a list of services. For example, if\n'storage.googleapis.com' is specified, access to the storage\nbuckets inside the perimeter must meet the perimeter's access\nrestrictions. When `null`, the `restricted_services` field will be omitted from the resulting object.\n - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may\nhave multiple EgressPolicies, each of which is evaluated separately.\nAccess is granted if any EgressPolicy grants it. Must be empty for\na perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.new](#fn-statusegress_policiesnew) constructor.\n - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may\nhave multiple 'IngressPolicies', each of which is evaluated\nseparately. Access is granted if any 'Ingress Policy' grants it.\nMust be empty for a perimeter bridge. When `null`, the `ingress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.new](#fn-statusingress_policiesnew) constructor.\n - `vpc_accessible_services` (`list[obj]`): Specifies how APIs are allowed to communicate within the Service\nPerimeter. When `null`, the `vpc_accessible_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.vpc_accessible_services.new](#fn-statusvpc_accessible_servicesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `status` sub block.\n', args=[]), new( access_levels=null, egress_policies=null, diff --git a/4.x/_gen/resources/access_context_manager_service_perimeters.libsonnet b/4.x/_gen/resources/access_context_manager_service_perimeters.libsonnet index a9fee7dd..43958498 100644 --- a/4.x/_gen/resources/access_context_manager_service_perimeters.libsonnet +++ b/4.x/_gen/resources/access_context_manager_service_perimeters.libsonnet @@ -47,7 +47,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); spec:: { egress_policies:: { egress_from:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_from.new` constructs a new object with attributes and blocks configured for the `egress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. \nShould be in the format of email address. The email address should \nrepresent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the \nperimeter. If left unspecified, then members of 'identities' field will \nbe allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `egress_from` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_from.new` constructs a new object with attributes and blocks configured for the `egress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'.\nShould be in the format of email address. The email address should\nrepresent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the\nperimeter. If left unspecified, then members of 'identities' field will\nbe allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `egress_from` sub block.\n', args=[]), new( identities=null, identity_type=null @@ -57,7 +57,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, egress_to:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.new` constructs a new object with attributes and blocks configured for the `egress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request\nmatches if it contains an external resource in this list (Example:\ns3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object.\n - `resources` (`list`): A list of resources, currently only projects in the form \n'projects/<projectnumber>', that match this to stanza. A request matches \nif it contains a resource in this list. If * is specified for resources, \nthen this 'EgressTo' rule will authorize access to all resources outside \nthe perimeter. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches \nif it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.operations.new](#fn-service_perimetersservice_perimetersspecegress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_to` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.new` constructs a new object with attributes and blocks configured for the `egress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request\nmatches if it contains an external resource in this list (Example:\ns3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object.\n - `resources` (`list`): A list of resources, currently only projects in the form\n'projects/<projectnumber>', that match this to stanza. A request matches\nif it contains a resource in this list. If * is specified for resources,\nthen this 'EgressTo' rule will authorize access to all resources outside\nthe perimeter. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches\nif it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.operations.new](#fn-service_perimetersservice_perimetersspecegress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_to` sub block.\n', args=[]), new( external_resources=null, operations=null, @@ -69,7 +69,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), operations:: { method_selectors:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for 'method' should be a valid method name for the corresponding \n'serviceName' in 'ApiOperation'. If '*' used as value for method, \nthen ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the \ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for 'method' should be a valid method name for the corresponding\n'serviceName' in 'ApiOperation'. If '*' used as value for method,\nthen ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the\ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), new( method=null, permission=null @@ -78,7 +78,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); permission: permission, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or \n'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName \nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong \nto the service specified by 'serviceName' field. A single MethodSelector \nentry with '*' specified for the 'method' field will allow all methods \nAND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersspecegress_policiesegress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or\n'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName\nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong\nto the service specified by 'serviceName' field. A single MethodSelector\nentry with '*' specified for the 'method' field will allow all methods\nAND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersspecegress_policiesegress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), new( method_selectors=null, service_name=null @@ -88,7 +88,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.new` constructs a new object with attributes and blocks configured for the `egress_policies`\nTerraform sub block.\n\n\n\n**Args**:\n - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_from.new](#fn-service_perimetersservice_perimetersspecegress_fromnew) constructor.\n - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that \ncause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.new](#fn-service_perimetersservice_perimetersspecegress_tonew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_policies` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.new` constructs a new object with attributes and blocks configured for the `egress_policies`\nTerraform sub block.\n\n\n\n**Args**:\n - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_from.new](#fn-service_perimetersservice_perimetersspecegress_fromnew) constructor.\n - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that\ncause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.new](#fn-service_perimetersservice_perimetersspecegress_tonew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_policies` sub block.\n', args=[]), new( egress_from=null, egress_to=null @@ -99,7 +99,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, ingress_policies:: { ingress_from:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_from.new` constructs a new object with attributes and blocks configured for the `ingress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this ingress policy.\nShould be in the format of email address. The email address should represent \nindividual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the \nperimeter. If left unspecified, then members of 'identities' field will be \nallowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_from.sources.new](#fn-service_perimetersservice_perimetersspecingress_policiessourcesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_from` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_from.new` constructs a new object with attributes and blocks configured for the `ingress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this ingress policy.\nShould be in the format of email address. The email address should represent\nindividual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the\nperimeter. If left unspecified, then members of 'identities' field will be\nallowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_from.sources.new](#fn-service_perimetersservice_perimetersspecingress_policiessourcesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_from` sub block.\n', args=[]), new( identities=null, identity_type=null, @@ -110,7 +110,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); sources: sources, }), sources:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_from.sources.new` constructs a new object with attributes and blocks configured for the `sources`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the \n'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed \nmust be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent\n'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, \nresources within the perimeter can only be accessed via Google Cloud calls \nwith request origins within the perimeter. \nExample 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' \nIf * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object.\n - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. \nRequests from these resources will be allowed to access perimeter data. \nCurrently only projects are allowed. Format 'projects/{project_number}' \nThe project may be in any Google Cloud organization, not just the \norganization that the perimeter is defined in. '*' is not allowed, the case \nof allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sources` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_from.sources.new` constructs a new object with attributes and blocks configured for the `sources`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the\n'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed\nmust be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent\n'AccessLevel' will cause an error. If no 'AccessLevel' names are listed,\nresources within the perimeter can only be accessed via Google Cloud calls\nwith request origins within the perimeter.\nExample 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.'\nIf * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object.\n - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter.\nRequests from these resources will be allowed to access perimeter data.\nCurrently only projects are allowed. Format 'projects/{project_number}'\nThe project may be in any Google Cloud organization, not just the\norganization that the perimeter is defined in. '*' is not allowed, the case\nof allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sources` sub block.\n', args=[]), new( access_level=null, resource=null @@ -121,7 +121,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, ingress_to:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.new` constructs a new object with attributes and blocks configured for the `ingress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `resources` (`list`): A list of resources, currently only projects in the form \n'projects/<projectnumber>', protected by this 'ServicePerimeter'\nthat are allowed to be accessed by sources defined in the\ncorresponding 'IngressFrom'. A request matches if it contains\na resource in this list. If '*' is specified for resources,\nthen this 'IngressTo' rule will authorize access to all \nresources inside the perimeter, provided that the request\nalso matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' \nare allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.operations.new](#fn-service_perimetersservice_perimetersspecingress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_to` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.new` constructs a new object with attributes and blocks configured for the `ingress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `resources` (`list`): A list of resources, currently only projects in the form\n'projects/<projectnumber>', protected by this 'ServicePerimeter'\nthat are allowed to be accessed by sources defined in the\ncorresponding 'IngressFrom'. A request matches if it contains\na resource in this list. If '*' is specified for resources,\nthen this 'IngressTo' rule will authorize access to all\nresources inside the perimeter, provided that the request\nalso matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom'\nare allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.operations.new](#fn-service_perimetersservice_perimetersspecingress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_to` sub block.\n', args=[]), new( operations=null, resources=null @@ -131,7 +131,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), operations:: { method_selectors:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for method should be a valid method name for the corresponding \nserviceName in 'ApiOperation'. If '*' used as value for 'method', then \nALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the \ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for method should be a valid method name for the corresponding\nserviceName in 'ApiOperation'. If '*' used as value for 'method', then\nALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the\ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), new( method=null, permission=null @@ -140,7 +140,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); permission: permission, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or \n'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' \nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to \nthe service specified by serviceName field. A single 'MethodSelector' entry \nwith '*' specified for the method field will allow all methods AND \npermissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersspecingress_policiesingress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or\n'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName'\nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to\nthe service specified by serviceName field. A single 'MethodSelector' entry\nwith '*' specified for the method field will allow all methods AND\npermissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersspecingress_policiesingress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), new( method_selectors=null, service_name=null @@ -159,7 +159,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ingress_to: ingress_to, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.new` constructs a new object with attributes and blocks configured for the `spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_levels` (`list`): A list of AccessLevel resource names that allow resources within\nthe ServicePerimeter to be accessed from the internet.\nAccessLevels listed must be in the same policy as this\nServicePerimeter. Referencing a nonexistent AccessLevel is a\nsyntax error. If no AccessLevel names are listed, resources within\nthe perimeter can only be accessed via GCP calls with request\norigins within the perimeter. For Service Perimeter Bridge, must\nbe empty.\n\nFormat: accessPolicies/{policy_id}/accessLevels/{access_level_name} When `null`, the `access_levels` field will be omitted from the resulting object.\n - `resources` (`list`): A list of GCP resources that are inside of the service perimeter.\nCurrently only projects are allowed.\nFormat: projects/{project_number} When `null`, the `resources` field will be omitted from the resulting object.\n - `restricted_services` (`list`): GCP services that are subject to the Service Perimeter\nrestrictions. Must contain a list of services. For example, if\n'storage.googleapis.com' is specified, access to the storage\nbuckets inside the perimeter must meet the perimeter's access\nrestrictions. When `null`, the `restricted_services` field will be omitted from the resulting object.\n - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may \nhave multiple EgressPolicies, each of which is evaluated separately.\nAccess is granted if any EgressPolicy grants it. Must be empty for \na perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.new](#fn-service_perimetersservice_perimetersegress_policiesnew) constructor.\n - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may\nhave multiple 'IngressPolicies', each of which is evaluated\nseparately. Access is granted if any 'Ingress Policy' grants it.\nMust be empty for a perimeter bridge. When `null`, the `ingress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.new](#fn-service_perimetersservice_perimetersingress_policiesnew) constructor.\n - `vpc_accessible_services` (`list[obj]`): Specifies how APIs are allowed to communicate within the Service\nPerimeter. When `null`, the `vpc_accessible_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.vpc_accessible_services.new](#fn-service_perimetersservice_perimetersvpc_accessible_servicesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.new` constructs a new object with attributes and blocks configured for the `spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_levels` (`list`): A list of AccessLevel resource names that allow resources within\nthe ServicePerimeter to be accessed from the internet.\nAccessLevels listed must be in the same policy as this\nServicePerimeter. Referencing a nonexistent AccessLevel is a\nsyntax error. If no AccessLevel names are listed, resources within\nthe perimeter can only be accessed via GCP calls with request\norigins within the perimeter. For Service Perimeter Bridge, must\nbe empty.\n\nFormat: accessPolicies/{policy_id}/accessLevels/{access_level_name} When `null`, the `access_levels` field will be omitted from the resulting object.\n - `resources` (`list`): A list of GCP resources that are inside of the service perimeter.\nCurrently only projects are allowed.\nFormat: projects/{project_number} When `null`, the `resources` field will be omitted from the resulting object.\n - `restricted_services` (`list`): GCP services that are subject to the Service Perimeter\nrestrictions. Must contain a list of services. For example, if\n'storage.googleapis.com' is specified, access to the storage\nbuckets inside the perimeter must meet the perimeter's access\nrestrictions. When `null`, the `restricted_services` field will be omitted from the resulting object.\n - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may\nhave multiple EgressPolicies, each of which is evaluated separately.\nAccess is granted if any EgressPolicy grants it. Must be empty for\na perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.new](#fn-service_perimetersservice_perimetersegress_policiesnew) constructor.\n - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may\nhave multiple 'IngressPolicies', each of which is evaluated\nseparately. Access is granted if any 'Ingress Policy' grants it.\nMust be empty for a perimeter bridge. When `null`, the `ingress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.new](#fn-service_perimetersservice_perimetersingress_policiesnew) constructor.\n - `vpc_accessible_services` (`list[obj]`): Specifies how APIs are allowed to communicate within the Service\nPerimeter. When `null`, the `vpc_accessible_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.vpc_accessible_services.new](#fn-service_perimetersservice_perimetersvpc_accessible_servicesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `spec` sub block.\n', args=[]), new( access_levels=null, egress_policies=null, @@ -189,7 +189,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); status:: { egress_policies:: { egress_from:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_from.new` constructs a new object with attributes and blocks configured for the `egress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. \nShould be in the format of email address. The email address should \nrepresent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the \nperimeter. If left unspecified, then members of 'identities' field will \nbe allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `egress_from` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_from.new` constructs a new object with attributes and blocks configured for the `egress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'.\nShould be in the format of email address. The email address should\nrepresent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the\nperimeter. If left unspecified, then members of 'identities' field will\nbe allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `egress_from` sub block.\n', args=[]), new( identities=null, identity_type=null @@ -199,7 +199,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, egress_to:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.new` constructs a new object with attributes and blocks configured for the `egress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request\nmatches if it contains an external resource in this list (Example:\ns3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object.\n - `resources` (`list`): A list of resources, currently only projects in the form \n'projects/<projectnumber>', that match this to stanza. A request matches \nif it contains a resource in this list. If * is specified for resources, \nthen this 'EgressTo' rule will authorize access to all resources outside \nthe perimeter. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches \nif it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.operations.new](#fn-service_perimetersservice_perimetersstatusegress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_to` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.new` constructs a new object with attributes and blocks configured for the `egress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request\nmatches if it contains an external resource in this list (Example:\ns3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object.\n - `resources` (`list`): A list of resources, currently only projects in the form\n'projects/<projectnumber>', that match this to stanza. A request matches\nif it contains a resource in this list. If * is specified for resources,\nthen this 'EgressTo' rule will authorize access to all resources outside\nthe perimeter. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches\nif it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.operations.new](#fn-service_perimetersservice_perimetersstatusegress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_to` sub block.\n', args=[]), new( external_resources=null, operations=null, @@ -211,7 +211,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), operations:: { method_selectors:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for 'method' should be a valid method name for the corresponding \n'serviceName' in 'ApiOperation'. If '*' used as value for method, \nthen ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the \ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for 'method' should be a valid method name for the corresponding\n'serviceName' in 'ApiOperation'. If '*' used as value for method,\nthen ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the\ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), new( method=null, permission=null @@ -220,7 +220,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); permission: permission, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or \n'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName \nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong \nto the service specified by 'serviceName' field. A single MethodSelector \nentry with '*' specified for the 'method' field will allow all methods \nAND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersstatusegress_policiesegress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or\n'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName\nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong\nto the service specified by 'serviceName' field. A single MethodSelector\nentry with '*' specified for the 'method' field will allow all methods\nAND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersstatusegress_policiesegress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), new( method_selectors=null, service_name=null @@ -230,7 +230,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.new` constructs a new object with attributes and blocks configured for the `egress_policies`\nTerraform sub block.\n\n\n\n**Args**:\n - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_from.new](#fn-service_perimetersservice_perimetersstatusegress_fromnew) constructor.\n - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that \ncause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.new](#fn-service_perimetersservice_perimetersstatusegress_tonew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_policies` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.new` constructs a new object with attributes and blocks configured for the `egress_policies`\nTerraform sub block.\n\n\n\n**Args**:\n - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_from.new](#fn-service_perimetersservice_perimetersstatusegress_fromnew) constructor.\n - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that\ncause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.new](#fn-service_perimetersservice_perimetersstatusegress_tonew) constructor.\n\n**Returns**:\n - An attribute object that represents the `egress_policies` sub block.\n', args=[]), new( egress_from=null, egress_to=null @@ -241,7 +241,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, ingress_policies:: { ingress_from:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_from.new` constructs a new object with attributes and blocks configured for the `ingress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this ingress policy.\nShould be in the format of email address. The email address should represent \nindividual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the \nperimeter. If left unspecified, then members of 'identities' field will be \nallowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_from.sources.new](#fn-service_perimetersservice_perimetersstatusingress_policiessourcesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_from` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_from.new` constructs a new object with attributes and blocks configured for the `ingress_from`\nTerraform sub block.\n\n\n\n**Args**:\n - `identities` (`list`): A list of identities that are allowed access through this ingress policy.\nShould be in the format of email address. The email address should represent\nindividual user or service account only. When `null`, the `identities` field will be omitted from the resulting object.\n - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the\nperimeter. If left unspecified, then members of 'identities' field will be\nallowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object.\n - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_from.sources.new](#fn-service_perimetersservice_perimetersstatusingress_policiessourcesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_from` sub block.\n', args=[]), new( identities=null, identity_type=null, @@ -252,7 +252,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); sources: sources, }), sources:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_from.sources.new` constructs a new object with attributes and blocks configured for the `sources`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the \n'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed \nmust be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent\n'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, \nresources within the perimeter can only be accessed via Google Cloud calls \nwith request origins within the perimeter. \nExample 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' \nIf * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object.\n - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. \nRequests from these resources will be allowed to access perimeter data. \nCurrently only projects are allowed. Format 'projects/{project_number}' \nThe project may be in any Google Cloud organization, not just the \norganization that the perimeter is defined in. '*' is not allowed, the case \nof allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sources` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_from.sources.new` constructs a new object with attributes and blocks configured for the `sources`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the\n'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed\nmust be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent\n'AccessLevel' will cause an error. If no 'AccessLevel' names are listed,\nresources within the perimeter can only be accessed via Google Cloud calls\nwith request origins within the perimeter.\nExample 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.'\nIf * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object.\n - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter.\nRequests from these resources will be allowed to access perimeter data.\nCurrently only projects are allowed. Format 'projects/{project_number}'\nThe project may be in any Google Cloud organization, not just the\norganization that the perimeter is defined in. '*' is not allowed, the case\nof allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sources` sub block.\n', args=[]), new( access_level=null, resource=null @@ -263,7 +263,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, ingress_to:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.new` constructs a new object with attributes and blocks configured for the `ingress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `resources` (`list`): A list of resources, currently only projects in the form \n'projects/<projectnumber>', protected by this 'ServicePerimeter'\nthat are allowed to be accessed by sources defined in the\ncorresponding 'IngressFrom'. A request matches if it contains\na resource in this list. If '*' is specified for resources,\nthen this 'IngressTo' rule will authorize access to all \nresources inside the perimeter, provided that the request\nalso matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' \nare allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.operations.new](#fn-service_perimetersservice_perimetersstatusingress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_to` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.new` constructs a new object with attributes and blocks configured for the `ingress_to`\nTerraform sub block.\n\n\n\n**Args**:\n - `resources` (`list`): A list of resources, currently only projects in the form\n'projects/<projectnumber>', protected by this 'ServicePerimeter'\nthat are allowed to be accessed by sources defined in the\ncorresponding 'IngressFrom'. A request matches if it contains\na resource in this list. If '*' is specified for resources,\nthen this 'IngressTo' rule will authorize access to all\nresources inside the perimeter, provided that the request\nalso matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object.\n - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom'\nare allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.operations.new](#fn-service_perimetersservice_perimetersstatusingress_policiesoperationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ingress_to` sub block.\n', args=[]), new( operations=null, resources=null @@ -273,7 +273,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), operations:: { method_selectors:: { - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for method should be a valid method name for the corresponding \nserviceName in 'ApiOperation'. If '*' used as value for 'method', then \nALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the \ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.operations.method_selectors.new` constructs a new object with attributes and blocks configured for the `method_selectors`\nTerraform sub block.\n\n\n\n**Args**:\n - `method` (`string`): Value for method should be a valid method name for the corresponding\nserviceName in 'ApiOperation'. If '*' used as value for 'method', then\nALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object.\n - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the\ncorresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `method_selectors` sub block.\n', args=[]), new( method=null, permission=null @@ -282,7 +282,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); permission: permission, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or \n'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' \nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to \nthe service specified by serviceName field. A single 'MethodSelector' entry \nwith '*' specified for the method field will allow all methods AND \npermissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersstatusingress_policiesingress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.operations.new` constructs a new object with attributes and blocks configured for the `operations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or\n'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName'\nfield set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object.\n - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to\nthe service specified by serviceName field. A single 'MethodSelector' entry\nwith '*' specified for the method field will allow all methods AND\npermissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersstatusingress_policiesingress_tomethod_selectorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `operations` sub block.\n', args=[]), new( method_selectors=null, service_name=null @@ -301,7 +301,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ingress_to: ingress_to, }), }, - '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.new` constructs a new object with attributes and blocks configured for the `status`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_levels` (`list`): A list of AccessLevel resource names that allow resources within\nthe ServicePerimeter to be accessed from the internet.\nAccessLevels listed must be in the same policy as this\nServicePerimeter. Referencing a nonexistent AccessLevel is a\nsyntax error. If no AccessLevel names are listed, resources within\nthe perimeter can only be accessed via GCP calls with request\norigins within the perimeter. For Service Perimeter Bridge, must\nbe empty.\n\nFormat: accessPolicies/{policy_id}/accessLevels/{access_level_name} When `null`, the `access_levels` field will be omitted from the resulting object.\n - `resources` (`list`): A list of GCP resources that are inside of the service perimeter.\nCurrently only projects are allowed.\nFormat: projects/{project_number} When `null`, the `resources` field will be omitted from the resulting object.\n - `restricted_services` (`list`): GCP services that are subject to the Service Perimeter\nrestrictions. Must contain a list of services. For example, if\n'storage.googleapis.com' is specified, access to the storage\nbuckets inside the perimeter must meet the perimeter's access\nrestrictions. When `null`, the `restricted_services` field will be omitted from the resulting object.\n - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may \nhave multiple EgressPolicies, each of which is evaluated separately.\nAccess is granted if any EgressPolicy grants it. Must be empty for \na perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.new](#fn-service_perimetersservice_perimetersegress_policiesnew) constructor.\n - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may\nhave multiple 'IngressPolicies', each of which is evaluated\nseparately. Access is granted if any 'Ingress Policy' grants it.\nMust be empty for a perimeter bridge. When `null`, the `ingress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.new](#fn-service_perimetersservice_perimetersingress_policiesnew) constructor.\n - `vpc_accessible_services` (`list[obj]`): Specifies how APIs are allowed to communicate within the Service\nPerimeter. When `null`, the `vpc_accessible_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.vpc_accessible_services.new](#fn-service_perimetersservice_perimetersvpc_accessible_servicesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `status` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.new` constructs a new object with attributes and blocks configured for the `status`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_levels` (`list`): A list of AccessLevel resource names that allow resources within\nthe ServicePerimeter to be accessed from the internet.\nAccessLevels listed must be in the same policy as this\nServicePerimeter. Referencing a nonexistent AccessLevel is a\nsyntax error. If no AccessLevel names are listed, resources within\nthe perimeter can only be accessed via GCP calls with request\norigins within the perimeter. For Service Perimeter Bridge, must\nbe empty.\n\nFormat: accessPolicies/{policy_id}/accessLevels/{access_level_name} When `null`, the `access_levels` field will be omitted from the resulting object.\n - `resources` (`list`): A list of GCP resources that are inside of the service perimeter.\nCurrently only projects are allowed.\nFormat: projects/{project_number} When `null`, the `resources` field will be omitted from the resulting object.\n - `restricted_services` (`list`): GCP services that are subject to the Service Perimeter\nrestrictions. Must contain a list of services. For example, if\n'storage.googleapis.com' is specified, access to the storage\nbuckets inside the perimeter must meet the perimeter's access\nrestrictions. When `null`, the `restricted_services` field will be omitted from the resulting object.\n - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may\nhave multiple EgressPolicies, each of which is evaluated separately.\nAccess is granted if any EgressPolicy grants it. Must be empty for\na perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.new](#fn-service_perimetersservice_perimetersegress_policiesnew) constructor.\n - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may\nhave multiple 'IngressPolicies', each of which is evaluated\nseparately. Access is granted if any 'Ingress Policy' grants it.\nMust be empty for a perimeter bridge. When `null`, the `ingress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.new](#fn-service_perimetersservice_perimetersingress_policiesnew) constructor.\n - `vpc_accessible_services` (`list[obj]`): Specifies how APIs are allowed to communicate within the Service\nPerimeter. When `null`, the `vpc_accessible_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.vpc_accessible_services.new](#fn-service_perimetersservice_perimetersvpc_accessible_servicesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `status` sub block.\n', args=[]), new( access_levels=null, egress_policies=null, diff --git a/4.x/_gen/resources/active_directory_domain.libsonnet b/4.x/_gen/resources/active_directory_domain.libsonnet index 81bed723..4dbfdb8b 100644 --- a/4.x/_gen/resources/active_directory_domain.libsonnet +++ b/4.x/_gen/resources/active_directory_domain.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='google_active_directory_domain', url='', help='`google_active_directory_domain` represents the `google-beta_google_active_directory_domain` 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-beta.google_active_directory_domain.new` injects a new `google-beta_google_active_directory_domain` 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-beta.google_active_directory_domain.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_active_directory_domain` using the reference:\n\n $._ref.google-beta_google_active_directory_domain.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_active_directory_domain.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 - `admin` (`string`): The name of delegated administrator account used to perform Active Directory operations. \nIf not specified, setupadmin will be used. When `null`, the `admin` field will be omitted from the resulting object.\n - `authorized_networks` (`list`): The full names of the Google Compute Engine networks the domain instance is connected to. The domain is only available on networks listed in authorizedNetworks.\nIf CIDR subnets overlap between networks, domain creation will fail. When `null`, the `authorized_networks` field will be omitted from the resulting object.\n - `domain_name` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, \nhttps://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.\n - `labels` (`obj`): Resource labels that can contain user-provided metadata When `null`, the `labels` field will be omitted from the resulting object.\n - `locations` (`list`): Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/] \ne.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 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 - `reserved_ip_range` (`string`): The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. \nRanges must be unique and non-overlapping with existing subnets in authorizedNetworks\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-beta.google_active_directory_domain.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-beta.google_active_directory_domain.new` injects a new `google-beta_google_active_directory_domain` 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-beta.google_active_directory_domain.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_active_directory_domain` using the reference:\n\n $._ref.google-beta_google_active_directory_domain.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_active_directory_domain.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 - `admin` (`string`): The name of delegated administrator account used to perform Active Directory operations.\nIf not specified, setupadmin will be used. When `null`, the `admin` field will be omitted from the resulting object.\n - `authorized_networks` (`list`): The full names of the Google Compute Engine networks the domain instance is connected to. The domain is only available on networks listed in authorizedNetworks.\nIf CIDR subnets overlap between networks, domain creation will fail. When `null`, the `authorized_networks` field will be omitted from the resulting object.\n - `domain_name` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions,\nhttps://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.\n - `labels` (`obj`): Resource labels that can contain user-provided metadata When `null`, the `labels` field will be omitted from the resulting object.\n - `locations` (`list`): Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/]\ne.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 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 - `reserved_ip_range` (`string`): The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger.\nRanges must be unique and non-overlapping with existing subnets in authorizedNetworks\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-beta.google_active_directory_domain.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, domain_name, @@ -29,7 +29,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_active_directory_domain.newAttrs` constructs a new object with attributes and blocks configured for the `google_active_directory_domain`\nTerraform resource.\n\nUnlike [google-beta.google_active_directory_domain.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 - `admin` (`string`): The name of delegated administrator account used to perform Active Directory operations. \nIf not specified, setupadmin will be used. When `null`, the `admin` field will be omitted from the resulting object.\n - `authorized_networks` (`list`): The full names of the Google Compute Engine networks the domain instance is connected to. The domain is only available on networks listed in authorizedNetworks.\nIf CIDR subnets overlap between networks, domain creation will fail. When `null`, the `authorized_networks` field will be omitted from the resulting object.\n - `domain_name` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, \nhttps://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.\n - `labels` (`obj`): Resource labels that can contain user-provided metadata When `null`, the `labels` field will be omitted from the resulting object.\n - `locations` (`list`): Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/] \ne.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `reserved_ip_range` (`string`): The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. \nRanges must be unique and non-overlapping with existing subnets in authorizedNetworks\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-beta.google_active_directory_domain.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 `google_active_directory_domain` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_active_directory_domain.newAttrs` constructs a new object with attributes and blocks configured for the `google_active_directory_domain`\nTerraform resource.\n\nUnlike [google-beta.google_active_directory_domain.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 - `admin` (`string`): The name of delegated administrator account used to perform Active Directory operations.\nIf not specified, setupadmin will be used. When `null`, the `admin` field will be omitted from the resulting object.\n - `authorized_networks` (`list`): The full names of the Google Compute Engine networks the domain instance is connected to. The domain is only available on networks listed in authorizedNetworks.\nIf CIDR subnets overlap between networks, domain creation will fail. When `null`, the `authorized_networks` field will be omitted from the resulting object.\n - `domain_name` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions,\nhttps://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.\n - `labels` (`obj`): Resource labels that can contain user-provided metadata When `null`, the `labels` field will be omitted from the resulting object.\n - `locations` (`list`): Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/]\ne.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `reserved_ip_range` (`string`): The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger.\nRanges must be unique and non-overlapping with existing subnets in authorizedNetworks\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-beta.google_active_directory_domain.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 `google_active_directory_domain` resource into the root Terraform configuration.\n', args=[]), newAttrs( domain_name, locations, diff --git a/4.x/_gen/resources/active_directory_domain_trust.libsonnet b/4.x/_gen/resources/active_directory_domain_trust.libsonnet index 3abf8858..cb2fd733 100644 --- a/4.x/_gen/resources/active_directory_domain_trust.libsonnet +++ b/4.x/_gen/resources/active_directory_domain_trust.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='google_active_directory_domain_trust', url='', help='`google_active_directory_domain_trust` represents the `google-beta_google_active_directory_domain_trust` 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-beta.google_active_directory_domain_trust.new` injects a new `google-beta_google_active_directory_domain_trust` 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-beta.google_active_directory_domain_trust.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_active_directory_domain_trust` using the reference:\n\n $._ref.google-beta_google_active_directory_domain_trust.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_active_directory_domain_trust.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 - `domain` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, \nhttps://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.\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 - `selective_authentication` (`bool`): Whether the trusted side has forest/domain wide access or selective access to an approved set of resources. When `null`, the `selective_authentication` field will be omitted from the resulting object.\n - `target_dns_ip_addresses` (`list`): The target DNS server IP addresses which can resolve the remote domain involved in the trust.\n - `target_domain_name` (`string`): The fully qualified target domain name which will be in trust with the current domain.\n - `trust_direction` (`string`): The trust direction, which decides if the current domain is trusted, trusting, or both. Possible values: [\u0026#34;INBOUND\u0026#34;, \u0026#34;OUTBOUND\u0026#34;, \u0026#34;BIDIRECTIONAL\u0026#34;]\n - `trust_handshake_secret` (`string`): The trust secret used for the handshake with the target domain. This will not be stored.\n - `trust_type` (`string`): The type of trust represented by the trust resource. Possible values: [\u0026#34;FOREST\u0026#34;, \u0026#34;EXTERNAL\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-beta.google_active_directory_domain_trust.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-beta.google_active_directory_domain_trust.new` injects a new `google-beta_google_active_directory_domain_trust` 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-beta.google_active_directory_domain_trust.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_active_directory_domain_trust` using the reference:\n\n $._ref.google-beta_google_active_directory_domain_trust.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_active_directory_domain_trust.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 - `domain` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions,\nhttps://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.\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 - `selective_authentication` (`bool`): Whether the trusted side has forest/domain wide access or selective access to an approved set of resources. When `null`, the `selective_authentication` field will be omitted from the resulting object.\n - `target_dns_ip_addresses` (`list`): The target DNS server IP addresses which can resolve the remote domain involved in the trust.\n - `target_domain_name` (`string`): The fully qualified target domain name which will be in trust with the current domain.\n - `trust_direction` (`string`): The trust direction, which decides if the current domain is trusted, trusting, or both. Possible values: [\u0026#34;INBOUND\u0026#34;, \u0026#34;OUTBOUND\u0026#34;, \u0026#34;BIDIRECTIONAL\u0026#34;]\n - `trust_handshake_secret` (`string`): The trust secret used for the handshake with the target domain. This will not be stored.\n - `trust_type` (`string`): The type of trust represented by the trust resource. Possible values: [\u0026#34;FOREST\u0026#34;, \u0026#34;EXTERNAL\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-beta.google_active_directory_domain_trust.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, domain, @@ -31,7 +31,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_active_directory_domain_trust.newAttrs` constructs a new object with attributes and blocks configured for the `google_active_directory_domain_trust`\nTerraform resource.\n\nUnlike [google-beta.google_active_directory_domain_trust.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 - `domain` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, \nhttps://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `selective_authentication` (`bool`): Whether the trusted side has forest/domain wide access or selective access to an approved set of resources. When `null`, the `selective_authentication` field will be omitted from the resulting object.\n - `target_dns_ip_addresses` (`list`): The target DNS server IP addresses which can resolve the remote domain involved in the trust.\n - `target_domain_name` (`string`): The fully qualified target domain name which will be in trust with the current domain.\n - `trust_direction` (`string`): The trust direction, which decides if the current domain is trusted, trusting, or both. Possible values: ["INBOUND", "OUTBOUND", "BIDIRECTIONAL"]\n - `trust_handshake_secret` (`string`): The trust secret used for the handshake with the target domain. This will not be stored.\n - `trust_type` (`string`): The type of trust represented by the trust resource. Possible values: ["FOREST", "EXTERNAL"]\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-beta.google_active_directory_domain_trust.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 `google_active_directory_domain_trust` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_active_directory_domain_trust.newAttrs` constructs a new object with attributes and blocks configured for the `google_active_directory_domain_trust`\nTerraform resource.\n\nUnlike [google-beta.google_active_directory_domain_trust.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 - `domain` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions,\nhttps://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `selective_authentication` (`bool`): Whether the trusted side has forest/domain wide access or selective access to an approved set of resources. When `null`, the `selective_authentication` field will be omitted from the resulting object.\n - `target_dns_ip_addresses` (`list`): The target DNS server IP addresses which can resolve the remote domain involved in the trust.\n - `target_domain_name` (`string`): The fully qualified target domain name which will be in trust with the current domain.\n - `trust_direction` (`string`): The trust direction, which decides if the current domain is trusted, trusting, or both. Possible values: ["INBOUND", "OUTBOUND", "BIDIRECTIONAL"]\n - `trust_handshake_secret` (`string`): The trust secret used for the handshake with the target domain. This will not be stored.\n - `trust_type` (`string`): The type of trust represented by the trust resource. Possible values: ["FOREST", "EXTERNAL"]\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-beta.google_active_directory_domain_trust.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 `google_active_directory_domain_trust` resource into the root Terraform configuration.\n', args=[]), newAttrs( domain, target_dns_ip_addresses, diff --git a/4.x/_gen/resources/alloydb_backup.libsonnet b/4.x/_gen/resources/alloydb_backup.libsonnet index 17ec60dc..6c0c0a38 100644 --- a/4.x/_gen/resources/alloydb_backup.libsonnet +++ b/4.x/_gen/resources/alloydb_backup.libsonnet @@ -2,13 +2,22 @@ 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='google_alloydb_backup', url='', help='`google_alloydb_backup` represents the `google-beta_google_alloydb_backup` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google-beta.google_alloydb_backup.new` injects a new `google-beta_google_alloydb_backup` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_alloydb_backup.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_alloydb_backup` using the reference:\n\n $._ref.google-beta_google_alloydb_backup.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_alloydb_backup.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `backup_id` (`string`): The ID of the alloydb backup.\n - `cluster_name` (`string`): The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).\n - `description` (`string`): User-provided description of the backup. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb backup should reside.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_backup.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + encryption_config:: { + '#new':: d.fn(help='\n`google-beta.google_alloydb_backup.encryption_config.new` constructs a new object with attributes and blocks configured for the `encryption_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_name` (`string`): The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `encryption_config` sub block.\n', args=[]), + new( + kms_key_name=null + ):: std.prune(a={ + kms_key_name: kms_key_name, + }), + }, + '#new':: d.fn(help="\n`google-beta.google_alloydb_backup.new` injects a new `google-beta_google_alloydb_backup` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_alloydb_backup.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_alloydb_backup` using the reference:\n\n $._ref.google-beta_google_alloydb_backup.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_alloydb_backup.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `backup_id` (`string`): The ID of the alloydb backup.\n - `cluster_name` (`string`): The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).\n - `description` (`string`): User-provided description of the backup. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb backup should reside.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `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-beta.google_alloydb_backup.encryption_config.new](#fn-encryption_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-beta.google_alloydb_backup.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, backup_id, cluster_name, location, description=null, + encryption_config=null, labels=null, project=null, timeouts=null, @@ -20,6 +29,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); backup_id=backup_id, cluster_name=cluster_name, description=description, + encryption_config=encryption_config, labels=labels, location=location, project=project, @@ -27,12 +37,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_alloydb_backup.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_backup`\nTerraform resource.\n\nUnlike [google-beta.google_alloydb_backup.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `backup_id` (`string`): The ID of the alloydb backup.\n - `cluster_name` (`string`): The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).\n - `description` (`string`): User-provided description of the backup. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb backup should reside.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_backup.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_alloydb_backup` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_alloydb_backup.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_backup`\nTerraform resource.\n\nUnlike [google-beta.google_alloydb_backup.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `backup_id` (`string`): The ID of the alloydb backup.\n - `cluster_name` (`string`): The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).\n - `description` (`string`): User-provided description of the backup. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb backup should reside.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `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-beta.google_alloydb_backup.encryption_config.new](#fn-encryption_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-beta.google_alloydb_backup.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_alloydb_backup` resource into the root Terraform configuration.\n', args=[]), newAttrs( backup_id, cluster_name, location, description=null, + encryption_config=null, labels=null, project=null, timeouts=null @@ -40,6 +51,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); backup_id: backup_id, cluster_name: cluster_name, description: description, + encryption_config: encryption_config, labels: labels, location: location, project: project, @@ -87,6 +99,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withEncryptionConfig':: d.fn(help='`google-beta.list[obj].withEncryptionConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the encryption_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-beta.list[obj].withEncryptionConfigMixin](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 `encryption_config` field.\n', args=[]), + withEncryptionConfig(resourceLabel, value): { + resource+: { + google_alloydb_backup+: { + [resourceLabel]+: { + encryption_config: value, + }, + }, + }, + }, + '#withEncryptionConfigMixin':: d.fn(help='`google-beta.list[obj].withEncryptionConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the encryption_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-beta.list[obj].withEncryptionConfig](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 `encryption_config` field.\n', args=[]), + withEncryptionConfigMixin(resourceLabel, value): { + resource+: { + google_alloydb_backup+: { + [resourceLabel]+: { + encryption_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withLabels':: d.fn(help='`google-beta.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+: { diff --git a/4.x/_gen/resources/alloydb_cluster.libsonnet b/4.x/_gen/resources/alloydb_cluster.libsonnet index bfdc0abc..b9cdc899 100644 --- a/4.x/_gen/resources/alloydb_cluster.libsonnet +++ b/4.x/_gen/resources/alloydb_cluster.libsonnet @@ -3,10 +3,19 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_alloydb_cluster', url='', help='`google_alloydb_cluster` represents the `google-beta_google_alloydb_cluster` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), automated_backup_policy:: { - '#new':: d.fn(help='\n`google-beta.google_alloydb_cluster.automated_backup_policy.new` constructs a new object with attributes and blocks configured for the `automated_backup_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `backup_window` (`string`): The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.\n\nThe backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour.\n\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `backup_window` field will be omitted from the resulting object.\n - `enabled` (`bool`): Whether automated backups are enabled. When `null`, the `enabled` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to backups created using this configuration. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. When `null`, the `location` field will be omitted from the resulting object.\n - `quantity_based_retention` (`list[obj]`): Quantity-based Backup retention policy to retain recent backups. When `null`, the `quantity_based_retention` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.quantity_based_retention.new](#fn-automated_backup_policyquantity_based_retentionnew) constructor.\n - `time_based_retention` (`list[obj]`): Time-based Backup retention policy. When `null`, the `time_based_retention` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.time_based_retention.new](#fn-automated_backup_policytime_based_retentionnew) constructor.\n - `weekly_schedule` (`list[obj]`): Weekly schedule for the Backup. When `null`, the `weekly_schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.weekly_schedule.new](#fn-automated_backup_policyweekly_schedulenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `automated_backup_policy` sub block.\n', args=[]), + encryption_config:: { + '#new':: d.fn(help='\n`google-beta.google_alloydb_cluster.automated_backup_policy.encryption_config.new` constructs a new object with attributes and blocks configured for the `encryption_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_name` (`string`): The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `encryption_config` sub block.\n', args=[]), + new( + kms_key_name=null + ):: std.prune(a={ + kms_key_name: kms_key_name, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_alloydb_cluster.automated_backup_policy.new` constructs a new object with attributes and blocks configured for the `automated_backup_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `backup_window` (`string`): The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.\n\nThe backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour.\n\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `backup_window` field will be omitted from the resulting object.\n - `enabled` (`bool`): Whether automated backups are enabled. When `null`, the `enabled` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to backups created using this configuration. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. When `null`, the `location` field will be omitted from the resulting object.\n - `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-beta.google_alloydb_cluster.automated_backup_policy.encryption_config.new](#fn-automated_backup_policyencryption_confignew) constructor.\n - `quantity_based_retention` (`list[obj]`): Quantity-based Backup retention policy to retain recent backups. Conflicts with 'time_based_retention', both can't be set together. When `null`, the `quantity_based_retention` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.quantity_based_retention.new](#fn-automated_backup_policyquantity_based_retentionnew) constructor.\n - `time_based_retention` (`list[obj]`): Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. When `null`, the `time_based_retention` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.time_based_retention.new](#fn-automated_backup_policytime_based_retentionnew) constructor.\n - `weekly_schedule` (`list[obj]`): Weekly schedule for the Backup. When `null`, the `weekly_schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.weekly_schedule.new](#fn-automated_backup_policyweekly_schedulenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `automated_backup_policy` sub block.\n', args=[]), new( backup_window=null, enabled=null, + encryption_config=null, labels=null, location=null, quantity_based_retention=null, @@ -15,6 +24,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ):: std.prune(a={ backup_window: backup_window, enabled: enabled, + encryption_config: encryption_config, labels: labels, location: location, quantity_based_retention: quantity_based_retention, @@ -47,7 +57,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); start_times: start_times, }), start_times:: { - '#new':: d.fn(help='\n`google-beta.google_alloydb_cluster.automated_backup_policy.weekly_schedule.start_times.new` constructs a new object with attributes and blocks configured for the `start_times`\nTerraform sub block.\n\n\n\n**Args**:\n - `hours` (`number`): Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. When `null`, the `hours` field will be omitted from the resulting object.\n - `minutes` (`number`): Minutes of hour of day. Must be from 0 to 59. When `null`, the `minutes` field will be omitted from the resulting object.\n - `nanos` (`number`): Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. When `null`, the `nanos` field will be omitted from the resulting object.\n - `seconds` (`number`): Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. When `null`, the `seconds` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `start_times` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_alloydb_cluster.automated_backup_policy.weekly_schedule.start_times.new` constructs a new object with attributes and blocks configured for the `start_times`\nTerraform sub block.\n\n\n\n**Args**:\n - `hours` (`number`): Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. When `null`, the `hours` field will be omitted from the resulting object.\n - `minutes` (`number`): Minutes of hour of day. Currently, only the value 0 is supported. When `null`, the `minutes` field will be omitted from the resulting object.\n - `nanos` (`number`): Fractions of seconds in nanoseconds. Currently, only the value 0 is supported. When `null`, the `nanos` field will be omitted from the resulting object.\n - `seconds` (`number`): Seconds of minutes of the time. Currently, only the value 0 is supported. When `null`, the `seconds` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `start_times` sub block.\n', args=[]), new( hours=null, minutes=null, @@ -62,6 +72,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + encryption_config:: { + '#new':: d.fn(help='\n`google-beta.google_alloydb_cluster.encryption_config.new` constructs a new object with attributes and blocks configured for the `encryption_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_name` (`string`): The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `encryption_config` sub block.\n', args=[]), + new( + kms_key_name=null + ):: std.prune(a={ + kms_key_name: kms_key_name, + }), + }, initial_user:: { '#new':: d.fn(help='\n`google-beta.google_alloydb_cluster.initial_user.new` constructs a new object with attributes and blocks configured for the `initial_user`\nTerraform sub block.\n\n\n\n**Args**:\n - `password` (`string`): The initial password for the user.\n - `user` (`string`): The database username. When `null`, the `user` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `initial_user` sub block.\n', args=[]), new( @@ -72,7 +90,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); user: user, }), }, - '#new':: d.fn(help="\n`google-beta.google_alloydb_cluster.new` injects a new `google-beta_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-beta.google_alloydb_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_alloydb_cluster` using the reference:\n\n $._ref.google-beta_google_alloydb_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_alloydb_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n\u0026#34;projects/{projectNumber}/global/networks/{network_id}\u0026#34;.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_alloydb_cluster.new` injects a new `google-beta_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-beta.google_alloydb_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_alloydb_cluster` using the reference:\n\n $._ref.google-beta_google_alloydb_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_alloydb_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n\u0026#34;projects/{projectNumber}/global/networks/{network_id}\u0026#34;.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) 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-beta.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-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.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, @@ -80,6 +98,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); network, automated_backup_policy=null, display_name=null, + encryption_config=null, initial_user=null, labels=null, project=null, @@ -92,6 +111,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); automated_backup_policy=automated_backup_policy, cluster_id=cluster_id, display_name=display_name, + encryption_config=encryption_config, initial_user=initial_user, labels=labels, location=location, @@ -101,13 +121,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_alloydb_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_cluster`\nTerraform resource.\n\nUnlike [google-beta.google_alloydb_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n"projects/{projectNumber}/global/networks/{network_id}".\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.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 `google_alloydb_cluster` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_alloydb_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_cluster`\nTerraform resource.\n\nUnlike [google-beta.google_alloydb_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n"projects/{projectNumber}/global/networks/{network_id}".\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) 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-beta.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-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.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 `google_alloydb_cluster` resource into the root Terraform configuration.\n', args=[]), newAttrs( cluster_id, location, network, automated_backup_policy=null, display_name=null, + encryption_config=null, initial_user=null, labels=null, project=null, @@ -116,6 +137,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); automated_backup_policy: automated_backup_policy, cluster_id: cluster_id, display_name: display_name, + encryption_config: encryption_config, initial_user: initial_user, labels: labels, location: location, @@ -175,6 +197,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withEncryptionConfig':: d.fn(help='`google-beta.list[obj].withEncryptionConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the encryption_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-beta.list[obj].withEncryptionConfigMixin](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 `encryption_config` field.\n', args=[]), + withEncryptionConfig(resourceLabel, value): { + resource+: { + google_alloydb_cluster+: { + [resourceLabel]+: { + encryption_config: value, + }, + }, + }, + }, + '#withEncryptionConfigMixin':: d.fn(help='`google-beta.list[obj].withEncryptionConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the encryption_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-beta.list[obj].withEncryptionConfig](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 `encryption_config` field.\n', args=[]), + withEncryptionConfigMixin(resourceLabel, value): { + resource+: { + google_alloydb_cluster+: { + [resourceLabel]+: { + encryption_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withInitialUser':: d.fn(help='`google-beta.list[obj].withInitialUser` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the initial_user 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-beta.list[obj].withInitialUserMixin](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 `initial_user` field.\n', args=[]), withInitialUser(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/apigee_keystores_aliases_self_signed_cert.libsonnet b/4.x/_gen/resources/apigee_keystores_aliases_self_signed_cert.libsonnet index fe0e7cbc..2ba43967 100644 --- a/4.x/_gen/resources/apigee_keystores_aliases_self_signed_cert.libsonnet +++ b/4.x/_gen/resources/apigee_keystores_aliases_self_signed_cert.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='google_apigee_keystores_aliases_self_signed_cert', url='', help='`google_apigee_keystores_aliases_self_signed_cert` represents the `google-beta_google_apigee_keystores_aliases_self_signed_cert` 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-beta.google_apigee_keystores_aliases_self_signed_cert.new` injects a new `google-beta_google_apigee_keystores_aliases_self_signed_cert` 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-beta.google_apigee_keystores_aliases_self_signed_cert.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_apigee_keystores_aliases_self_signed_cert` using the reference:\n\n $._ref.google-beta_google_apigee_keystores_aliases_self_signed_cert.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_apigee_keystores_aliases_self_signed_cert.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 - `alias` (`string`): Alias for the key/certificate pair. Values must match the regular expression [\\w\\s-.]{1,255}. \nThis must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either \nthis parameter or the JSON body.\n - `cert_validity_in_days` (`number`): Validity duration of certificate, in days. Accepts positive non-zero value. Defaults to 365. When `null`, the `cert_validity_in_days` field will be omitted from the resulting object.\n - `environment` (`string`): The Apigee environment name\n - `key_size` (`string`): Key size. Default and maximum value is 2048 bits. When `null`, the `key_size` field will be omitted from the resulting object.\n - `keystore` (`string`): The Apigee keystore name associated in an Apigee environment\n - `org_id` (`string`): The Apigee Organization name associated with the Apigee environment\n - `sig_alg` (`string`): Signature algorithm to generate private key. Valid values are SHA512withRSA, SHA384withRSA, and SHA256withRSA\n - `subject` (`list[obj]`): Subject details. When `null`, the `subject` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_apigee_keystores_aliases_self_signed_cert.subject.new](#fn-subjectnew) constructor.\n - `subject_alternative_dns_names` (`list[obj]`): List of alternative host names. Maximum length is 255 characters for each value. When `null`, the `subject_alternative_dns_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-beta.google_apigee_keystores_aliases_self_signed_cert.subject_alternative_dns_names.new](#fn-subject_alternative_dns_namesnew) 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-beta.google_apigee_keystores_aliases_self_signed_cert.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-beta.google_apigee_keystores_aliases_self_signed_cert.new` injects a new `google-beta_google_apigee_keystores_aliases_self_signed_cert` 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-beta.google_apigee_keystores_aliases_self_signed_cert.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_apigee_keystores_aliases_self_signed_cert` using the reference:\n\n $._ref.google-beta_google_apigee_keystores_aliases_self_signed_cert.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_apigee_keystores_aliases_self_signed_cert.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 - `alias` (`string`): Alias for the key/certificate pair. Values must match the regular expression [\\w\\s-.]{1,255}.\nThis must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either\nthis parameter or the JSON body.\n - `cert_validity_in_days` (`number`): Validity duration of certificate, in days. Accepts positive non-zero value. Defaults to 365. When `null`, the `cert_validity_in_days` field will be omitted from the resulting object.\n - `environment` (`string`): The Apigee environment name\n - `key_size` (`string`): Key size. Default and maximum value is 2048 bits. When `null`, the `key_size` field will be omitted from the resulting object.\n - `keystore` (`string`): The Apigee keystore name associated in an Apigee environment\n - `org_id` (`string`): The Apigee Organization name associated with the Apigee environment\n - `sig_alg` (`string`): Signature algorithm to generate private key. Valid values are SHA512withRSA, SHA384withRSA, and SHA256withRSA\n - `subject` (`list[obj]`): Subject details. When `null`, the `subject` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_apigee_keystores_aliases_self_signed_cert.subject.new](#fn-subjectnew) constructor.\n - `subject_alternative_dns_names` (`list[obj]`): List of alternative host names. Maximum length is 255 characters for each value. When `null`, the `subject_alternative_dns_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-beta.google_apigee_keystores_aliases_self_signed_cert.subject_alternative_dns_names.new](#fn-subject_alternative_dns_namesnew) 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-beta.google_apigee_keystores_aliases_self_signed_cert.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, alias, @@ -33,7 +33,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_apigee_keystores_aliases_self_signed_cert.newAttrs` constructs a new object with attributes and blocks configured for the `google_apigee_keystores_aliases_self_signed_cert`\nTerraform resource.\n\nUnlike [google-beta.google_apigee_keystores_aliases_self_signed_cert.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 - `alias` (`string`): Alias for the key/certificate pair. Values must match the regular expression [\\w\\s-.]{1,255}. \nThis must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either \nthis parameter or the JSON body.\n - `cert_validity_in_days` (`number`): Validity duration of certificate, in days. Accepts positive non-zero value. Defaults to 365. When `null`, the `cert_validity_in_days` field will be omitted from the resulting object.\n - `environment` (`string`): The Apigee environment name\n - `key_size` (`string`): Key size. Default and maximum value is 2048 bits. When `null`, the `key_size` field will be omitted from the resulting object.\n - `keystore` (`string`): The Apigee keystore name associated in an Apigee environment\n - `org_id` (`string`): The Apigee Organization name associated with the Apigee environment\n - `sig_alg` (`string`): Signature algorithm to generate private key. Valid values are SHA512withRSA, SHA384withRSA, and SHA256withRSA\n - `subject` (`list[obj]`): Subject details. When `null`, the `subject` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_apigee_keystores_aliases_self_signed_cert.subject.new](#fn-subjectnew) constructor.\n - `subject_alternative_dns_names` (`list[obj]`): List of alternative host names. Maximum length is 255 characters for each value. When `null`, the `subject_alternative_dns_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-beta.google_apigee_keystores_aliases_self_signed_cert.subject_alternative_dns_names.new](#fn-subject_alternative_dns_namesnew) 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-beta.google_apigee_keystores_aliases_self_signed_cert.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 `google_apigee_keystores_aliases_self_signed_cert` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_apigee_keystores_aliases_self_signed_cert.newAttrs` constructs a new object with attributes and blocks configured for the `google_apigee_keystores_aliases_self_signed_cert`\nTerraform resource.\n\nUnlike [google-beta.google_apigee_keystores_aliases_self_signed_cert.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 - `alias` (`string`): Alias for the key/certificate pair. Values must match the regular expression [\\w\\s-.]{1,255}.\nThis must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either\nthis parameter or the JSON body.\n - `cert_validity_in_days` (`number`): Validity duration of certificate, in days. Accepts positive non-zero value. Defaults to 365. When `null`, the `cert_validity_in_days` field will be omitted from the resulting object.\n - `environment` (`string`): The Apigee environment name\n - `key_size` (`string`): Key size. Default and maximum value is 2048 bits. When `null`, the `key_size` field will be omitted from the resulting object.\n - `keystore` (`string`): The Apigee keystore name associated in an Apigee environment\n - `org_id` (`string`): The Apigee Organization name associated with the Apigee environment\n - `sig_alg` (`string`): Signature algorithm to generate private key. Valid values are SHA512withRSA, SHA384withRSA, and SHA256withRSA\n - `subject` (`list[obj]`): Subject details. When `null`, the `subject` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_apigee_keystores_aliases_self_signed_cert.subject.new](#fn-subjectnew) constructor.\n - `subject_alternative_dns_names` (`list[obj]`): List of alternative host names. Maximum length is 255 characters for each value. When `null`, the `subject_alternative_dns_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-beta.google_apigee_keystores_aliases_self_signed_cert.subject_alternative_dns_names.new](#fn-subject_alternative_dns_namesnew) 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-beta.google_apigee_keystores_aliases_self_signed_cert.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 `google_apigee_keystores_aliases_self_signed_cert` resource into the root Terraform configuration.\n', args=[]), newAttrs( alias, environment, diff --git a/4.x/_gen/resources/billing_budget.libsonnet b/4.x/_gen/resources/billing_budget.libsonnet index 02923b1e..a248afbc 100644 --- a/4.x/_gen/resources/billing_budget.libsonnet +++ b/4.x/_gen/resources/billing_budget.libsonnet @@ -52,7 +52,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); year: year, }), }, - '#new':: d.fn(help='\n`google-beta.google_billing_budget.budget_filter.custom_period.new` constructs a new object with attributes and blocks configured for the `custom_period`\nTerraform sub block.\n\n\n\n**Args**:\n - `end_date` (`list[obj]`): Optional. The end date of the time period. Budgets with elapsed end date won't be processed. \nIf unset, specifies to track all usage incurred since the startDate. When `null`, the `end_date` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_billing_budget.budget_filter.custom_period.end_date.new](#fn-budget_filterbudget_filterend_datenew) constructor.\n - `start_date` (`list[obj]`): A start date is required. The start date must be after January 1, 2017. When `null`, the `start_date` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_billing_budget.budget_filter.custom_period.start_date.new](#fn-budget_filterbudget_filterstart_datenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_period` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_billing_budget.budget_filter.custom_period.new` constructs a new object with attributes and blocks configured for the `custom_period`\nTerraform sub block.\n\n\n\n**Args**:\n - `end_date` (`list[obj]`): Optional. The end date of the time period. Budgets with elapsed end date won't be processed.\nIf unset, specifies to track all usage incurred since the startDate. When `null`, the `end_date` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_billing_budget.budget_filter.custom_period.end_date.new](#fn-budget_filterbudget_filterend_datenew) constructor.\n - `start_date` (`list[obj]`): A start date is required. The start date must be after January 1, 2017. When `null`, the `start_date` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_billing_budget.budget_filter.custom_period.start_date.new](#fn-budget_filterbudget_filterstart_datenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_period` sub block.\n', args=[]), new( end_date=null, start_date=null diff --git a/4.x/_gen/resources/certificate_manager_certificate.libsonnet b/4.x/_gen/resources/certificate_manager_certificate.libsonnet index 29fdd404..a47cd15d 100644 --- a/4.x/_gen/resources/certificate_manager_certificate.libsonnet +++ b/4.x/_gen/resources/certificate_manager_certificate.libsonnet @@ -12,12 +12,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); domains: domains, }), }, - '#new':: d.fn(help="\n`google-beta.google_certificate_manager_certificate.new` injects a new `google-beta_google_certificate_manager_certificate` 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-beta.google_certificate_manager_certificate.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_certificate_manager_certificate` using the reference:\n\n $._ref.google-beta_google_certificate_manager_certificate.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_certificate_manager_certificate.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 human-readable description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the Certificate resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): A user-defined name of the certificate. Certificate names must be unique\nThe name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter,\nand all following characters must be a dash, underscore, letter or digit.\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 - `scope` (`string`): The scope of the certificate.\n\nDEFAULT: Certificates with default scope are served from core Google data centers.\nIf unsure, choose this option.\n\nEDGE_CACHE: Certificates with scope EDGE_CACHE are special-purposed certificates,\nserved from non-core Google data centers.\nCurrently allowed only for managed certificates. When `null`, the `scope` field will be omitted from the resulting object.\n - `managed` (`list[obj]`): Configuration and state of a Managed Certificate.\nCertificate Manager provisions and renews Managed Certificates\nautomatically, for as long as it\u0026#39;s authorized to do so. When `null`, the `managed` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate.managed.new](#fn-managednew) constructor.\n - `self_managed` (`list[obj]`): Certificate data for a SelfManaged Certificate.\nSelfManaged Certificates are uploaded by the user. Updating such\ncertificates before they expire remains the user\u0026#39;s responsibility. When `null`, the `self_managed` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate.self_managed.new](#fn-self_managednew) 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-beta.google_certificate_manager_certificate.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-beta.google_certificate_manager_certificate.new` injects a new `google-beta_google_certificate_manager_certificate` 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-beta.google_certificate_manager_certificate.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_certificate_manager_certificate` using the reference:\n\n $._ref.google-beta_google_certificate_manager_certificate.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_certificate_manager_certificate.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 human-readable description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the Certificate resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The Certificate Manager location. If not specified, \u0026#34;global\u0026#34; is used. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): A user-defined name of the certificate. Certificate names must be unique\nThe name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter,\nand all following characters must be a dash, underscore, letter or digit.\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 - `scope` (`string`): The scope of the certificate.\n\nDEFAULT: Certificates with default scope are served from core Google data centers.\nIf unsure, choose this option.\n\nEDGE_CACHE: Certificates with scope EDGE_CACHE are special-purposed certificates,\nserved from non-core Google data centers.\nCurrently allowed only for managed certificates. When `null`, the `scope` field will be omitted from the resulting object.\n - `managed` (`list[obj]`): Configuration and state of a Managed Certificate.\nCertificate Manager provisions and renews Managed Certificates\nautomatically, for as long as it\u0026#39;s authorized to do so. When `null`, the `managed` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate.managed.new](#fn-managednew) constructor.\n - `self_managed` (`list[obj]`): Certificate data for a SelfManaged Certificate.\nSelfManaged Certificates are uploaded by the user. Updating such\ncertificates before they expire remains the user\u0026#39;s responsibility. When `null`, the `self_managed` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate.self_managed.new](#fn-self_managednew) 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-beta.google_certificate_manager_certificate.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, description=null, labels=null, + location=null, managed=null, project=null, scope=null, @@ -30,6 +31,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs( description=description, labels=labels, + location=location, managed=managed, name=name, project=project, @@ -39,11 +41,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_certificate_manager_certificate.newAttrs` constructs a new object with attributes and blocks configured for the `google_certificate_manager_certificate`\nTerraform resource.\n\nUnlike [google-beta.google_certificate_manager_certificate.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 human-readable description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the Certificate resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): A user-defined name of the certificate. Certificate names must be unique\nThe name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter,\nand all following characters must be a dash, underscore, letter or digit.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `scope` (`string`): The scope of the certificate.\n\nDEFAULT: Certificates with default scope are served from core Google data centers.\nIf unsure, choose this option.\n\nEDGE_CACHE: Certificates with scope EDGE_CACHE are special-purposed certificates,\nserved from non-core Google data centers.\nCurrently allowed only for managed certificates. When `null`, the `scope` field will be omitted from the resulting object.\n - `managed` (`list[obj]`): Configuration and state of a Managed Certificate.\nCertificate Manager provisions and renews Managed Certificates\nautomatically, for as long as it's authorized to do so. When `null`, the `managed` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate.managed.new](#fn-managednew) constructor.\n - `self_managed` (`list[obj]`): Certificate data for a SelfManaged Certificate.\nSelfManaged Certificates are uploaded by the user. Updating such\ncertificates before they expire remains the user's responsibility. When `null`, the `self_managed` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate.self_managed.new](#fn-self_managednew) 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-beta.google_certificate_manager_certificate.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 `google_certificate_manager_certificate` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_certificate_manager_certificate.newAttrs` constructs a new object with attributes and blocks configured for the `google_certificate_manager_certificate`\nTerraform resource.\n\nUnlike [google-beta.google_certificate_manager_certificate.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 human-readable description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the Certificate resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The Certificate Manager location. If not specified, "global" is used. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): A user-defined name of the certificate. Certificate names must be unique\nThe name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter,\nand all following characters must be a dash, underscore, letter or digit.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `scope` (`string`): The scope of the certificate.\n\nDEFAULT: Certificates with default scope are served from core Google data centers.\nIf unsure, choose this option.\n\nEDGE_CACHE: Certificates with scope EDGE_CACHE are special-purposed certificates,\nserved from non-core Google data centers.\nCurrently allowed only for managed certificates. When `null`, the `scope` field will be omitted from the resulting object.\n - `managed` (`list[obj]`): Configuration and state of a Managed Certificate.\nCertificate Manager provisions and renews Managed Certificates\nautomatically, for as long as it's authorized to do so. When `null`, the `managed` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate.managed.new](#fn-managednew) constructor.\n - `self_managed` (`list[obj]`): Certificate data for a SelfManaged Certificate.\nSelfManaged Certificates are uploaded by the user. Updating such\ncertificates before they expire remains the user's responsibility. When `null`, the `self_managed` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate.self_managed.new](#fn-self_managednew) 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-beta.google_certificate_manager_certificate.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 `google_certificate_manager_certificate` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, description=null, labels=null, + location=null, managed=null, project=null, scope=null, @@ -52,6 +55,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ):: std.prune(a={ description: description, labels: labels, + location: location, managed: managed, name: name, project: project, @@ -105,6 +109,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withLocation':: d.fn(help='`google-beta.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_certificate_manager_certificate+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, '#withManaged':: d.fn(help='`google-beta.list[obj].withManaged` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the managed 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-beta.list[obj].withManagedMixin](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 `managed` field.\n', args=[]), withManaged(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/certificate_manager_certificate_map_entry.libsonnet b/4.x/_gen/resources/certificate_manager_certificate_map_entry.libsonnet index cf43672a..51e31f69 100644 --- a/4.x/_gen/resources/certificate_manager_certificate_map_entry.libsonnet +++ b/4.x/_gen/resources/certificate_manager_certificate_map_entry.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='google_certificate_manager_certificate_map_entry', url='', help='`google_certificate_manager_certificate_map_entry` represents the `google-beta_google_certificate_manager_certificate_map_entry` 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-beta.google_certificate_manager_certificate_map_entry.new` injects a new `google-beta_google_certificate_manager_certificate_map_entry` 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-beta.google_certificate_manager_certificate_map_entry.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_certificate_manager_certificate_map_entry` using the reference:\n\n $._ref.google-beta_google_certificate_manager_certificate_map_entry.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_certificate_manager_certificate_map_entry.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 - `certificates` (`list`): A set of Certificates defines for the given hostname.\nThere can be defined up to fifteen certificates in each Certificate Map Entry.\nEach certificate must match pattern projects/*/locations/*/certificates/*.\n - `description` (`string`): A human-readable description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `hostname` (`string`): A Hostname (FQDN, e.g. example.com) or a wildcard hostname expression (*.example.com)\nfor a set of hostnames with common suffix. Used as Server Name Indication (SNI) for\nselecting a proper certificate. When `null`, the `hostname` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of labels associated with a Certificate Map Entry.\nAn object containing a list of \u0026#34;key\u0026#34;: 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 - `map` (`string`): A map entry that is inputted into the cetrificate map\n - `matcher` (`string`): A predefined matcher for particular cases, other than SNI selection When `null`, the `matcher` field will be omitted from the resulting object.\n - `name` (`string`): A user-defined name of the Certificate Map Entry. Certificate Map Entry \nnames must be unique globally and match pattern \n\u0026#39;projects/*/locations/*/certificateMaps/*/certificateMapEntries/*\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 - `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-beta.google_certificate_manager_certificate_map_entry.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-beta.google_certificate_manager_certificate_map_entry.new` injects a new `google-beta_google_certificate_manager_certificate_map_entry` 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-beta.google_certificate_manager_certificate_map_entry.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_certificate_manager_certificate_map_entry` using the reference:\n\n $._ref.google-beta_google_certificate_manager_certificate_map_entry.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_certificate_manager_certificate_map_entry.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 - `certificates` (`list`): A set of Certificates defines for the given hostname.\nThere can be defined up to fifteen certificates in each Certificate Map Entry.\nEach certificate must match pattern projects/*/locations/*/certificates/*.\n - `description` (`string`): A human-readable description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `hostname` (`string`): A Hostname (FQDN, e.g. example.com) or a wildcard hostname expression (*.example.com)\nfor a set of hostnames with common suffix. Used as Server Name Indication (SNI) for\nselecting a proper certificate. When `null`, the `hostname` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of labels associated with a Certificate Map Entry.\nAn object containing a list of \u0026#34;key\u0026#34;: 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 - `map` (`string`): A map entry that is inputted into the cetrificate map\n - `matcher` (`string`): A predefined matcher for particular cases, other than SNI selection When `null`, the `matcher` field will be omitted from the resulting object.\n - `name` (`string`): A user-defined name of the Certificate Map Entry. Certificate Map Entry\nnames must be unique globally and match pattern\n\u0026#39;projects/*/locations/*/certificateMaps/*/certificateMapEntries/*\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 - `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-beta.google_certificate_manager_certificate_map_entry.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, certificates, @@ -31,7 +31,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_certificate_manager_certificate_map_entry.newAttrs` constructs a new object with attributes and blocks configured for the `google_certificate_manager_certificate_map_entry`\nTerraform resource.\n\nUnlike [google-beta.google_certificate_manager_certificate_map_entry.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 - `certificates` (`list`): A set of Certificates defines for the given hostname.\nThere can be defined up to fifteen certificates in each Certificate Map Entry.\nEach certificate must match pattern projects/*/locations/*/certificates/*.\n - `description` (`string`): A human-readable description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `hostname` (`string`): A Hostname (FQDN, e.g. example.com) or a wildcard hostname expression (*.example.com)\nfor a set of hostnames with common suffix. Used as Server Name Indication (SNI) for\nselecting a proper certificate. When `null`, the `hostname` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of labels associated with a Certificate Map Entry.\nAn object containing a 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 - `map` (`string`): A map entry that is inputted into the cetrificate map\n - `matcher` (`string`): A predefined matcher for particular cases, other than SNI selection When `null`, the `matcher` field will be omitted from the resulting object.\n - `name` (`string`): A user-defined name of the Certificate Map Entry. Certificate Map Entry \nnames must be unique globally and match pattern \n'projects/*/locations/*/certificateMaps/*/certificateMapEntries/*'\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate_map_entry.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 `google_certificate_manager_certificate_map_entry` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_certificate_manager_certificate_map_entry.newAttrs` constructs a new object with attributes and blocks configured for the `google_certificate_manager_certificate_map_entry`\nTerraform resource.\n\nUnlike [google-beta.google_certificate_manager_certificate_map_entry.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 - `certificates` (`list`): A set of Certificates defines for the given hostname.\nThere can be defined up to fifteen certificates in each Certificate Map Entry.\nEach certificate must match pattern projects/*/locations/*/certificates/*.\n - `description` (`string`): A human-readable description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `hostname` (`string`): A Hostname (FQDN, e.g. example.com) or a wildcard hostname expression (*.example.com)\nfor a set of hostnames with common suffix. Used as Server Name Indication (SNI) for\nselecting a proper certificate. When `null`, the `hostname` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of labels associated with a Certificate Map Entry.\nAn object containing a 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 - `map` (`string`): A map entry that is inputted into the cetrificate map\n - `matcher` (`string`): A predefined matcher for particular cases, other than SNI selection When `null`, the `matcher` field will be omitted from the resulting object.\n - `name` (`string`): A user-defined name of the Certificate Map Entry. Certificate Map Entry\nnames must be unique globally and match pattern\n'projects/*/locations/*/certificateMaps/*/certificateMapEntries/*'\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate_map_entry.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 `google_certificate_manager_certificate_map_entry` resource into the root Terraform configuration.\n', args=[]), newAttrs( certificates, map, diff --git a/4.x/_gen/resources/cloud_asset_folder_feed.libsonnet b/4.x/_gen/resources/cloud_asset_folder_feed.libsonnet index 61407994..b0e7b06f 100644 --- a/4.x/_gen/resources/cloud_asset_folder_feed.libsonnet +++ b/4.x/_gen/resources/cloud_asset_folder_feed.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_cloud_asset_folder_feed', url='', help='`google_cloud_asset_folder_feed` represents the `google-beta_google_cloud_asset_folder_feed` 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-beta.google_cloud_asset_folder_feed.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`): Description of the expression. This is a longer text which describes the expression,\ne.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 file \nname 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.\nThis 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.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_asset_folder_feed.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`): Description of the expression. This is a longer text which describes the expression,\ne.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 file\nname 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.\nThis 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.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), new( expression, description=null, @@ -32,7 +32,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help="\n`google-beta.google_cloud_asset_folder_feed.new` injects a new `google-beta_google_cloud_asset_folder_feed` 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-beta.google_cloud_asset_folder_feed.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_asset_folder_feed` using the reference:\n\n $._ref.google-beta_google_cloud_asset_folder_feed.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_asset_folder_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of \nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: \u0026#34;compute.googleapis.com/Disk\u0026#34;\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API \nenablement check, quota, and billing.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: [\u0026#34;CONTENT_TYPE_UNSPECIFIED\u0026#34;, \u0026#34;RESOURCE\u0026#34;, \u0026#34;IAM_POLICY\u0026#34;, \u0026#34;ORG_POLICY\u0026#34;, \u0026#34;OS_INVENTORY\u0026#34;, \u0026#34;ACCESS_POLICY\u0026#34;] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\n - `folder` (`string`): The folder this feed should be created in.\n - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression \u0026#34;temporal_asset.deleted == true\u0026#34; will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_folder_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_folder_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_folder_feed.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-beta.google_cloud_asset_folder_feed.new` injects a new `google-beta_google_cloud_asset_folder_feed` 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-beta.google_cloud_asset_folder_feed.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_asset_folder_feed` using the reference:\n\n $._ref.google-beta_google_cloud_asset_folder_feed.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_asset_folder_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of\nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: \u0026#34;compute.googleapis.com/Disk\u0026#34;\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API\nenablement check, quota, and billing.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: [\u0026#34;CONTENT_TYPE_UNSPECIFIED\u0026#34;, \u0026#34;RESOURCE\u0026#34;, \u0026#34;IAM_POLICY\u0026#34;, \u0026#34;ORG_POLICY\u0026#34;, \u0026#34;OS_INVENTORY\u0026#34;, \u0026#34;ACCESS_POLICY\u0026#34;] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\n - `folder` (`string`): The folder this feed should be created in.\n - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression \u0026#34;temporal_asset.deleted == true\u0026#34; will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_folder_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_folder_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_folder_feed.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, billing_project, @@ -61,7 +61,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_asset_folder_feed.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_asset_folder_feed`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_asset_folder_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of \nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: "compute.googleapis.com/Disk"\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API \nenablement check, quota, and billing.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\n - `folder` (`string`): The folder this feed should be created in.\n - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression "temporal_asset.deleted == true" will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_folder_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_folder_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_folder_feed.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 `google_cloud_asset_folder_feed` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_asset_folder_feed.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_asset_folder_feed`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_asset_folder_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of\nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: "compute.googleapis.com/Disk"\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API\nenablement check, quota, and billing.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\n - `folder` (`string`): The folder this feed should be created in.\n - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression "temporal_asset.deleted == true" will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_folder_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_folder_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_folder_feed.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 `google_cloud_asset_folder_feed` resource into the root Terraform configuration.\n', args=[]), newAttrs( billing_project, feed_id, diff --git a/4.x/_gen/resources/cloud_asset_organization_feed.libsonnet b/4.x/_gen/resources/cloud_asset_organization_feed.libsonnet index 788bb8b4..af00155b 100644 --- a/4.x/_gen/resources/cloud_asset_organization_feed.libsonnet +++ b/4.x/_gen/resources/cloud_asset_organization_feed.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_cloud_asset_organization_feed', url='', help='`google_cloud_asset_organization_feed` represents the `google-beta_google_cloud_asset_organization_feed` 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-beta.google_cloud_asset_organization_feed.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`): Description of the expression. This is a longer text which describes the expression,\ne.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 file \nname 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.\nThis 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.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_asset_organization_feed.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`): Description of the expression. This is a longer text which describes the expression,\ne.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 file\nname 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.\nThis 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.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), new( expression, description=null, @@ -32,7 +32,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help="\n`google-beta.google_cloud_asset_organization_feed.new` injects a new `google-beta_google_cloud_asset_organization_feed` 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-beta.google_cloud_asset_organization_feed.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_asset_organization_feed` using the reference:\n\n $._ref.google-beta_google_cloud_asset_organization_feed.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_asset_organization_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of \nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: \u0026#34;compute.googleapis.com/Disk\u0026#34;\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API \nenablement check, quota, and billing.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: [\u0026#34;CONTENT_TYPE_UNSPECIFIED\u0026#34;, \u0026#34;RESOURCE\u0026#34;, \u0026#34;IAM_POLICY\u0026#34;, \u0026#34;ORG_POLICY\u0026#34;, \u0026#34;OS_INVENTORY\u0026#34;, \u0026#34;ACCESS_POLICY\u0026#34;] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\n - `org_id` (`string`): The organization this feed should be created in.\n - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression \u0026#34;temporal_asset.deleted == true\u0026#34; will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_organization_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_organization_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_organization_feed.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-beta.google_cloud_asset_organization_feed.new` injects a new `google-beta_google_cloud_asset_organization_feed` 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-beta.google_cloud_asset_organization_feed.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_asset_organization_feed` using the reference:\n\n $._ref.google-beta_google_cloud_asset_organization_feed.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_asset_organization_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of\nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: \u0026#34;compute.googleapis.com/Disk\u0026#34;\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API\nenablement check, quota, and billing.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: [\u0026#34;CONTENT_TYPE_UNSPECIFIED\u0026#34;, \u0026#34;RESOURCE\u0026#34;, \u0026#34;IAM_POLICY\u0026#34;, \u0026#34;ORG_POLICY\u0026#34;, \u0026#34;OS_INVENTORY\u0026#34;, \u0026#34;ACCESS_POLICY\u0026#34;] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\n - `org_id` (`string`): The organization this feed should be created in.\n - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression \u0026#34;temporal_asset.deleted == true\u0026#34; will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_organization_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_organization_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_organization_feed.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, billing_project, @@ -61,7 +61,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_asset_organization_feed.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_asset_organization_feed`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_asset_organization_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of \nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: "compute.googleapis.com/Disk"\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API \nenablement check, quota, and billing.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\n - `org_id` (`string`): The organization this feed should be created in.\n - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression "temporal_asset.deleted == true" will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_organization_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_organization_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_organization_feed.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 `google_cloud_asset_organization_feed` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_asset_organization_feed.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_asset_organization_feed`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_asset_organization_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of\nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: "compute.googleapis.com/Disk"\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API\nenablement check, quota, and billing.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\n - `org_id` (`string`): The organization this feed should be created in.\n - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression "temporal_asset.deleted == true" will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_organization_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_organization_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_organization_feed.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 `google_cloud_asset_organization_feed` resource into the root Terraform configuration.\n', args=[]), newAttrs( billing_project, feed_id, diff --git a/4.x/_gen/resources/cloud_asset_project_feed.libsonnet b/4.x/_gen/resources/cloud_asset_project_feed.libsonnet index 83cb6797..88b6a4e0 100644 --- a/4.x/_gen/resources/cloud_asset_project_feed.libsonnet +++ b/4.x/_gen/resources/cloud_asset_project_feed.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_cloud_asset_project_feed', url='', help='`google_cloud_asset_project_feed` represents the `google-beta_google_cloud_asset_project_feed` 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-beta.google_cloud_asset_project_feed.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`): Description of the expression. This is a longer text which describes the expression,\ne.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 file \nname 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.\nThis 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.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_asset_project_feed.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`): Description of the expression. This is a longer text which describes the expression,\ne.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 file\nname 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.\nThis 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.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), new( expression, description=null, @@ -32,7 +32,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help="\n`google-beta.google_cloud_asset_project_feed.new` injects a new `google-beta_google_cloud_asset_project_feed` 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-beta.google_cloud_asset_project_feed.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_asset_project_feed` using the reference:\n\n $._ref.google-beta_google_cloud_asset_project_feed.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_asset_project_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of \nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: \u0026#34;compute.googleapis.com/Disk\u0026#34;\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API \nenablement check, quota, and billing. If not specified, the resource\u0026#39;s\nproject will be used. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: [\u0026#34;CONTENT_TYPE_UNSPECIFIED\u0026#34;, \u0026#34;RESOURCE\u0026#34;, \u0026#34;IAM_POLICY\u0026#34;, \u0026#34;ORG_POLICY\u0026#34;, \u0026#34;OS_INVENTORY\u0026#34;, \u0026#34;ACCESS_POLICY\u0026#34;] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\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 - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression \u0026#34;temporal_asset.deleted == true\u0026#34; will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_project_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_project_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_project_feed.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-beta.google_cloud_asset_project_feed.new` injects a new `google-beta_google_cloud_asset_project_feed` 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-beta.google_cloud_asset_project_feed.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_asset_project_feed` using the reference:\n\n $._ref.google-beta_google_cloud_asset_project_feed.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_asset_project_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of\nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: \u0026#34;compute.googleapis.com/Disk\u0026#34;\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API\nenablement check, quota, and billing. If not specified, the resource\u0026#39;s\nproject will be used. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: [\u0026#34;CONTENT_TYPE_UNSPECIFIED\u0026#34;, \u0026#34;RESOURCE\u0026#34;, \u0026#34;IAM_POLICY\u0026#34;, \u0026#34;ORG_POLICY\u0026#34;, \u0026#34;OS_INVENTORY\u0026#34;, \u0026#34;ACCESS_POLICY\u0026#34;] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\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 - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression \u0026#34;temporal_asset.deleted == true\u0026#34; will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_project_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_project_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_project_feed.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, feed_id, @@ -61,7 +61,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_asset_project_feed.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_asset_project_feed`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_asset_project_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of \nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: "compute.googleapis.com/Disk"\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API \nenablement check, quota, and billing. If not specified, the resource's\nproject will be used. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression "temporal_asset.deleted == true" will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_project_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_project_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_project_feed.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 `google_cloud_asset_project_feed` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_asset_project_feed.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_asset_project_feed`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_asset_project_feed.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 - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of\nassetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are\nexported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.\nSee https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object.\n - `asset_types` (`list`): A list of types of the assets to receive updates. You must specify either or both of assetNames\nand assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to\nthe feed. For example: "compute.googleapis.com/Disk"\nSee https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all\nsupported asset types. When `null`, the `asset_types` field will be omitted from the resulting object.\n - `billing_project` (`string`): The project whose identity will be used when sending messages to the\ndestination pubsub topic. It also specifies the project for API\nenablement check, quota, and billing. If not specified, the resource's\nproject will be used. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object.\n - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `condition` (`list[obj]`): A condition which determines whether an asset update should be published. If specified, an asset\nwill be returned only when the expression evaluates to true. When set, expression field\nmust be a valid CEL expression on a TemporalAsset with name temporal_asset. Example: a Feed with\nexpression "temporal_asset.deleted == true" will only publish Asset deletions. Other fields of\ncondition are optional. 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-beta.google_cloud_asset_project_feed.condition.new](#fn-conditionnew) constructor.\n - `feed_output_config` (`list[obj]`): Output configuration for asset feed destination. When `null`, the `feed_output_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-beta.google_cloud_asset_project_feed.feed_output_config.new](#fn-feed_output_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-beta.google_cloud_asset_project_feed.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 `google_cloud_asset_project_feed` resource into the root Terraform configuration.\n', args=[]), newAttrs( feed_id, asset_names=null, diff --git a/4.x/_gen/resources/cloud_run_service.libsonnet b/4.x/_gen/resources/cloud_run_service.libsonnet index 8048486d..03c78344 100644 --- a/4.x/_gen/resources/cloud_run_service.libsonnet +++ b/4.x/_gen/resources/cloud_run_service.libsonnet @@ -105,7 +105,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); secret_key_ref: secret_key_ref, }), secret_key_ref:: { - '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.env.value_from.secret_key_ref.new` constructs a new object with attributes and blocks configured for the `secret_key_ref`\nTerraform sub block.\n\n\n\n**Args**:\n - `key` (`string`): A Cloud Secret Manager secret version. Must be 'latest' for the latest\nversion or an integer for a specific version.\n - `name` (`string`): The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. \nIf the secret is in another project, you must define an alias. \nAn alias definition has the form: :projects/{project-id|project-number}/secrets/. \nIf multiple alias definitions are needed, they must be separated by commas. \nThe alias definitions must be set on the run.googleapis.com/secrets annotation.\n\n**Returns**:\n - An attribute object that represents the `secret_key_ref` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.env.value_from.secret_key_ref.new` constructs a new object with attributes and blocks configured for the `secret_key_ref`\nTerraform sub block.\n\n\n\n**Args**:\n - `key` (`string`): A Cloud Secret Manager secret version. Must be 'latest' for the latest\nversion or an integer for a specific version.\n - `name` (`string`): The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project.\nIf the secret is in another project, you must define an alias.\nAn alias definition has the form: :projects/{project-id|project-number}/secrets/.\nIf multiple alias definitions are needed, they must be separated by commas.\nThe alias definitions must be set on the run.googleapis.com/secrets annotation.\n\n**Returns**:\n - An attribute object that represents the `secret_key_ref` sub block.\n', args=[]), new( key, name @@ -166,7 +166,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, liveness_probe:: { grpc:: { - '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.liveness_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. When `null`, the `port` field will be omitted from the resulting object.\n - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\nIf this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grpc` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.liveness_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535.\nIf not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\nIf this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grpc` sub block.\n', args=[]), new( port=null, service=null @@ -186,13 +186,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); value: value, }), }, - '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.liveness_probe.http_get.new` constructs a new object with attributes and blocks configured for the `http_get`\nTerraform sub block.\n\n\n\n**Args**:\n - `path` (`string`): Path to access on the HTTP server. If set, it should not be empty string. When `null`, the `path` field will be omitted from the resulting object.\n - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_service.template.spec.containers.liveness_probe.http_get.http_headers.new](#fn-templatetemplatespeccontainersliveness_probehttp_headersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_get` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.liveness_probe.http_get.new` constructs a new object with attributes and blocks configured for the `http_get`\nTerraform sub block.\n\n\n\n**Args**:\n - `path` (`string`): Path to access on the HTTP server. If set, it should not be empty string. When `null`, the `path` field will be omitted from the resulting object.\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535.\nIf not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_service.template.spec.containers.liveness_probe.http_get.http_headers.new](#fn-templatetemplatespeccontainersliveness_probehttp_headersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_get` sub block.\n', args=[]), new( http_headers=null, - path=null + path=null, + port=null ):: std.prune(a={ http_headers: http_headers, path: path, + port: port, }), }, '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.liveness_probe.new` constructs a new object with attributes and blocks configured for the `liveness_probe`\nTerraform sub block.\n\n\n\n**Args**:\n - `failure_threshold` (`number`): Minimum consecutive failures for the probe to be considered failed after\nhaving succeeded. Defaults to 3. Minimum value is 1. When `null`, the `failure_threshold` field will be omitted from the resulting object.\n - `initial_delay_seconds` (`number`): Number of seconds after the container has started before the probe is\ninitiated.\nDefaults to 0 seconds. Minimum value is 0. Maximum value is 3600. When `null`, the `initial_delay_seconds` field will be omitted from the resulting object.\n - `period_seconds` (`number`): How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1. Maximum value is 3600. When `null`, the `period_seconds` field will be omitted from the resulting object.\n - `timeout_seconds` (`number`): Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1. Maximum value is 3600.\nMust be smaller than period_seconds. When `null`, the `timeout_seconds` field will be omitted from the resulting object.\n - `grpc` (`list[obj]`): GRPC specifies an action involving a GRPC port. When `null`, the `grpc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_service.template.spec.containers.liveness_probe.grpc.new](#fn-templatetemplatespeccontainersgrpcnew) constructor.\n - `http_get` (`list[obj]`): HttpGet specifies the http request to perform. When `null`, the `http_get` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_service.template.spec.containers.liveness_probe.http_get.new](#fn-templatetemplatespeccontainershttp_getnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `liveness_probe` sub block.\n', args=[]), @@ -262,7 +264,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, startup_probe:: { grpc:: { - '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.startup_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. When `null`, the `port` field will be omitted from the resulting object.\n - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\nIf this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grpc` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.startup_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535.\nIf not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\nIf this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grpc` sub block.\n', args=[]), new( port=null, service=null @@ -282,13 +284,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); value: value, }), }, - '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.startup_probe.http_get.new` constructs a new object with attributes and blocks configured for the `http_get`\nTerraform sub block.\n\n\n\n**Args**:\n - `path` (`string`): Path to access on the HTTP server. If set, it should not be empty string. When `null`, the `path` field will be omitted from the resulting object.\n - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_service.template.spec.containers.startup_probe.http_get.http_headers.new](#fn-templatetemplatespeccontainersstartup_probehttp_headersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_get` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.startup_probe.http_get.new` constructs a new object with attributes and blocks configured for the `http_get`\nTerraform sub block.\n\n\n\n**Args**:\n - `path` (`string`): Path to access on the HTTP server. If set, it should not be empty string. When `null`, the `path` field will be omitted from the resulting object.\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535.\nIf not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_service.template.spec.containers.startup_probe.http_get.http_headers.new](#fn-templatetemplatespeccontainersstartup_probehttp_headersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_get` sub block.\n', args=[]), new( http_headers=null, - path=null + path=null, + port=null ):: std.prune(a={ http_headers: http_headers, path: path, + port: port, }), }, '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.startup_probe.new` constructs a new object with attributes and blocks configured for the `startup_probe`\nTerraform sub block.\n\n\n\n**Args**:\n - `failure_threshold` (`number`): Minimum consecutive failures for the probe to be considered failed after\nhaving succeeded. Defaults to 3. Minimum value is 1. When `null`, the `failure_threshold` field will be omitted from the resulting object.\n - `initial_delay_seconds` (`number`): Number of seconds after the container has started before the probe is\ninitiated.\nDefaults to 0 seconds. Minimum value is 0. Maximum value is 240. When `null`, the `initial_delay_seconds` field will be omitted from the resulting object.\n - `period_seconds` (`number`): How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1. Maximum value is 240. When `null`, the `period_seconds` field will be omitted from the resulting object.\n - `timeout_seconds` (`number`): Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1. Maximum value is 3600.\nMust be smaller than periodSeconds. When `null`, the `timeout_seconds` field will be omitted from the resulting object.\n - `grpc` (`list[obj]`): GRPC specifies an action involving a GRPC port. When `null`, the `grpc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_service.template.spec.containers.startup_probe.grpc.new](#fn-templatetemplatespeccontainersgrpcnew) constructor.\n - `http_get` (`list[obj]`): HttpGet specifies the http request to perform. When `null`, the `http_get` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_service.template.spec.containers.startup_probe.http_get.new](#fn-templatetemplatespeccontainershttp_getnew) constructor.\n - `tcp_socket` (`list[obj]`): TcpSocket specifies an action involving a TCP port. When `null`, the `tcp_socket` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_service.template.spec.containers.startup_probe.tcp_socket.new](#fn-templatetemplatespeccontainerstcp_socketnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `startup_probe` sub block.\n', args=[]), @@ -310,7 +314,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeout_seconds: timeout_seconds, }), tcp_socket:: { - '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.startup_probe.tcp_socket.new` constructs a new object with attributes and blocks configured for the `tcp_socket`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. When `null`, the `port` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `tcp_socket` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_service.template.spec.containers.startup_probe.tcp_socket.new` constructs a new object with attributes and blocks configured for the `tcp_socket`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535.\nIf not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `tcp_socket` sub block.\n', args=[]), new( port=null ):: std.prune(a={ diff --git a/4.x/_gen/resources/cloud_run_v2_job.libsonnet b/4.x/_gen/resources/cloud_run_v2_job.libsonnet index 3a70add2..164cd53c 100644 --- a/4.x/_gen/resources/cloud_run_v2_job.libsonnet +++ b/4.x/_gen/resources/cloud_run_v2_job.libsonnet @@ -12,7 +12,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); use_default: use_default, }), }, - '#new':: d.fn(help="\n`google-beta.google_cloud_run_v2_job.new` injects a new `google-beta_google_cloud_run_v2_job` 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-beta.google_cloud_run_v2_job.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_run_v2_job` using the reference:\n\n $._ref.google-beta_google_cloud_run_v2_job.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_run_v2_job.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 - `client` (`string`): Arbitrary identifier for the API client. When `null`, the `client` field will be omitted from the resulting object.\n - `client_version` (`string`): Arbitrary version identifier for the API client. When `null`, the `client_version` field will be omitted from the resulting object.\n - `labels` (`obj`): KRM-style labels for the resource. User-provided labels are shared with Google\u0026#39;s billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with \u0026#39;run.googleapis.com\u0026#39; or \u0026#39;serving.knative.dev\u0026#39; namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object.\n - `launch_stage` (`string`): The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Possible values: [\u0026#34;UNIMPLEMENTED\u0026#34;, \u0026#34;PRELAUNCH\u0026#34;, \u0026#34;EARLY_ACCESS\u0026#34;, \u0026#34;ALPHA\u0026#34;, \u0026#34;BETA\u0026#34;, \u0026#34;GA\u0026#34;, \u0026#34;DEPRECATED\u0026#34;] When `null`, the `launch_stage` field will be omitted from the resulting object.\n - `location` (`string`): The location of the cloud run job When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Job.\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 - `binary_authorization` (`list[obj]`): Settings 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-beta.google_cloud_run_v2_job.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `template` (`list[obj]`): The template used to create executions for this Job. When `null`, the `template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_job.template.new](#fn-templatenew) 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-beta.google_cloud_run_v2_job.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-beta.google_cloud_run_v2_job.new` injects a new `google-beta_google_cloud_run_v2_job` 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-beta.google_cloud_run_v2_job.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_run_v2_job` using the reference:\n\n $._ref.google-beta_google_cloud_run_v2_job.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_run_v2_job.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 - `client` (`string`): Arbitrary identifier for the API client. When `null`, the `client` field will be omitted from the resulting object.\n - `client_version` (`string`): Arbitrary version identifier for the API client. When `null`, the `client_version` field will be omitted from the resulting object.\n - `labels` (`obj`): KRM-style labels for the resource. User-provided labels are shared with Google\u0026#39;s billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with \u0026#39;run.googleapis.com\u0026#39; or \u0026#39;serving.knative.dev\u0026#39; namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object.\n - `launch_stage` (`string`): The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA.\nIf no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.\n\nFor example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: [\u0026#34;UNIMPLEMENTED\u0026#34;, \u0026#34;PRELAUNCH\u0026#34;, \u0026#34;EARLY_ACCESS\u0026#34;, \u0026#34;ALPHA\u0026#34;, \u0026#34;BETA\u0026#34;, \u0026#34;GA\u0026#34;, \u0026#34;DEPRECATED\u0026#34;] When `null`, the `launch_stage` field will be omitted from the resulting object.\n - `location` (`string`): The location of the cloud run job When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Job.\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 - `binary_authorization` (`list[obj]`): Settings 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-beta.google_cloud_run_v2_job.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `template` (`list[obj]`): The template used to create executions for this Job. When `null`, the `template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_job.template.new](#fn-templatenew) 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-beta.google_cloud_run_v2_job.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, @@ -43,7 +43,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_run_v2_job.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_run_v2_job`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_run_v2_job.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 - `client` (`string`): Arbitrary identifier for the API client. When `null`, the `client` field will be omitted from the resulting object.\n - `client_version` (`string`): Arbitrary version identifier for the API client. When `null`, the `client_version` field will be omitted from the resulting object.\n - `labels` (`obj`): KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object.\n - `launch_stage` (`string`): The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object.\n - `location` (`string`): The location of the cloud run job When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Job.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `binary_authorization` (`list[obj]`): Settings 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-beta.google_cloud_run_v2_job.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `template` (`list[obj]`): The template used to create executions for this Job. When `null`, the `template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_job.template.new](#fn-templatenew) 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-beta.google_cloud_run_v2_job.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 `google_cloud_run_v2_job` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_run_v2_job.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_run_v2_job`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_run_v2_job.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 - `client` (`string`): Arbitrary identifier for the API client. When `null`, the `client` field will be omitted from the resulting object.\n - `client_version` (`string`): Arbitrary version identifier for the API client. When `null`, the `client_version` field will be omitted from the resulting object.\n - `labels` (`obj`): KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object.\n - `launch_stage` (`string`): The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA.\nIf no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.\n\nFor example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object.\n - `location` (`string`): The location of the cloud run job When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Job.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `binary_authorization` (`list[obj]`): Settings 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-beta.google_cloud_run_v2_job.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `template` (`list[obj]`): The template used to create executions for this Job. When `null`, the `template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_job.template.new](#fn-templatenew) 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-beta.google_cloud_run_v2_job.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 `google_cloud_run_v2_job` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, binary_authorization=null, diff --git a/4.x/_gen/resources/cloud_run_v2_service.libsonnet b/4.x/_gen/resources/cloud_run_v2_service.libsonnet index c9a98a04..63caebd9 100644 --- a/4.x/_gen/resources/cloud_run_v2_service.libsonnet +++ b/4.x/_gen/resources/cloud_run_v2_service.libsonnet @@ -12,7 +12,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); use_default: use_default, }), }, - '#new':: d.fn(help="\n`google-beta.google_cloud_run_v2_service.new` injects a new `google-beta_google_cloud_run_v2_service` 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-beta.google_cloud_run_v2_service.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_run_v2_service` using the reference:\n\n $._ref.google-beta_google_cloud_run_v2_service.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_run_v2_service.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`): Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run will populate some annotations using \u0026#39;run.googleapis.com\u0026#39; or \u0026#39;serving.knative.dev\u0026#39; namespaces. This field follows Kubernetes annotations\u0026#39; namespacing, limits, and rules. More info: https://kubernetes.io/docs/user-guide/annotations When `null`, the `annotations` field will be omitted from the resulting object.\n - `client` (`string`): Arbitrary identifier for the API client. When `null`, the `client` field will be omitted from the resulting object.\n - `client_version` (`string`): Arbitrary version identifier for the API client. When `null`, the `client_version` field will be omitted from the resulting object.\n - `description` (`string`): User-provided description of the Service. This field currently has a 512-character limit. When `null`, the `description` field will be omitted from the resulting object.\n - `ingress` (`string`): Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Possible values: [\u0026#34;INGRESS_TRAFFIC_ALL\u0026#34;, \u0026#34;INGRESS_TRAFFIC_INTERNAL_ONLY\u0026#34;, \u0026#34;INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER\u0026#34;] When `null`, the `ingress` field will be omitted from the resulting object.\n - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize objects. User-provided labels are shared with Google\u0026#39;s billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with \u0026#39;run.googleapis.com\u0026#39; or \u0026#39;serving.knative.dev\u0026#39; namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object.\n - `launch_stage` (`string`): The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Possible values: [\u0026#34;UNIMPLEMENTED\u0026#34;, \u0026#34;PRELAUNCH\u0026#34;, \u0026#34;EARLY_ACCESS\u0026#34;, \u0026#34;ALPHA\u0026#34;, \u0026#34;BETA\u0026#34;, \u0026#34;GA\u0026#34;, \u0026#34;DEPRECATED\u0026#34;] When `null`, the `launch_stage` field will be omitted from the resulting object.\n - `location` (`string`): The location of the cloud run service When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Service.\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 - `binary_authorization` (`list[obj]`): Settings 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-beta.google_cloud_run_v2_service.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `template` (`list[obj]`): The template used to create revisions for this Service. When `null`, the `template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.new](#fn-templatenew) 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-beta.google_cloud_run_v2_service.timeouts.new](#fn-timeoutsnew) constructor.\n - `traffic` (`list[obj]`): Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision. When `null`, the `traffic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.traffic.new](#fn-trafficnew) 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-beta.google_cloud_run_v2_service.new` injects a new `google-beta_google_cloud_run_v2_service` 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-beta.google_cloud_run_v2_service.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_run_v2_service` using the reference:\n\n $._ref.google-beta_google_cloud_run_v2_service.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_run_v2_service.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`): Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run will populate some annotations using \u0026#39;run.googleapis.com\u0026#39; or \u0026#39;serving.knative.dev\u0026#39; namespaces. This field follows Kubernetes annotations\u0026#39; namespacing, limits, and rules. More info: https://kubernetes.io/docs/user-guide/annotations When `null`, the `annotations` field will be omitted from the resulting object.\n - `client` (`string`): Arbitrary identifier for the API client. When `null`, the `client` field will be omitted from the resulting object.\n - `client_version` (`string`): Arbitrary version identifier for the API client. When `null`, the `client_version` field will be omitted from the resulting object.\n - `description` (`string`): User-provided description of the Service. This field currently has a 512-character limit. When `null`, the `description` field will be omitted from the resulting object.\n - `ingress` (`string`): Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Possible values: [\u0026#34;INGRESS_TRAFFIC_ALL\u0026#34;, \u0026#34;INGRESS_TRAFFIC_INTERNAL_ONLY\u0026#34;, \u0026#34;INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER\u0026#34;] When `null`, the `ingress` field will be omitted from the resulting object.\n - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize objects. User-provided labels are shared with Google\u0026#39;s billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with \u0026#39;run.googleapis.com\u0026#39; or \u0026#39;serving.knative.dev\u0026#39; namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object.\n - `launch_stage` (`string`): The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA.\nIf no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.\n\nFor example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: [\u0026#34;UNIMPLEMENTED\u0026#34;, \u0026#34;PRELAUNCH\u0026#34;, \u0026#34;EARLY_ACCESS\u0026#34;, \u0026#34;ALPHA\u0026#34;, \u0026#34;BETA\u0026#34;, \u0026#34;GA\u0026#34;, \u0026#34;DEPRECATED\u0026#34;] When `null`, the `launch_stage` field will be omitted from the resulting object.\n - `location` (`string`): The location of the cloud run service When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Service.\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 - `binary_authorization` (`list[obj]`): Settings 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-beta.google_cloud_run_v2_service.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `template` (`list[obj]`): The template used to create revisions for this Service. When `null`, the `template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.new](#fn-templatenew) 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-beta.google_cloud_run_v2_service.timeouts.new](#fn-timeoutsnew) constructor.\n - `traffic` (`list[obj]`): Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision. When `null`, the `traffic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.traffic.new](#fn-trafficnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -51,7 +51,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_run_v2_service`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_run_v2_service.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`): Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run will populate some annotations using 'run.googleapis.com' or 'serving.knative.dev' namespaces. This field follows Kubernetes annotations' namespacing, limits, and rules. More info: https://kubernetes.io/docs/user-guide/annotations When `null`, the `annotations` field will be omitted from the resulting object.\n - `client` (`string`): Arbitrary identifier for the API client. When `null`, the `client` field will be omitted from the resulting object.\n - `client_version` (`string`): Arbitrary version identifier for the API client. When `null`, the `client_version` field will be omitted from the resulting object.\n - `description` (`string`): User-provided description of the Service. This field currently has a 512-character limit. When `null`, the `description` field will be omitted from the resulting object.\n - `ingress` (`string`): Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Possible values: ["INGRESS_TRAFFIC_ALL", "INGRESS_TRAFFIC_INTERNAL_ONLY", "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER"] When `null`, the `ingress` field will be omitted from the resulting object.\n - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object.\n - `launch_stage` (`string`): The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object.\n - `location` (`string`): The location of the cloud run service When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Service.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `binary_authorization` (`list[obj]`): Settings 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-beta.google_cloud_run_v2_service.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `template` (`list[obj]`): The template used to create revisions for this Service. When `null`, the `template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.new](#fn-templatenew) 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-beta.google_cloud_run_v2_service.timeouts.new](#fn-timeoutsnew) constructor.\n - `traffic` (`list[obj]`): Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision. When `null`, the `traffic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.traffic.new](#fn-trafficnew) 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 `google_cloud_run_v2_service` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_run_v2_service`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_run_v2_service.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`): Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run will populate some annotations using 'run.googleapis.com' or 'serving.knative.dev' namespaces. This field follows Kubernetes annotations' namespacing, limits, and rules. More info: https://kubernetes.io/docs/user-guide/annotations When `null`, the `annotations` field will be omitted from the resulting object.\n - `client` (`string`): Arbitrary identifier for the API client. When `null`, the `client` field will be omitted from the resulting object.\n - `client_version` (`string`): Arbitrary version identifier for the API client. When `null`, the `client_version` field will be omitted from the resulting object.\n - `description` (`string`): User-provided description of the Service. This field currently has a 512-character limit. When `null`, the `description` field will be omitted from the resulting object.\n - `ingress` (`string`): Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Possible values: ["INGRESS_TRAFFIC_ALL", "INGRESS_TRAFFIC_INTERNAL_ONLY", "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER"] When `null`, the `ingress` field will be omitted from the resulting object.\n - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object.\n - `launch_stage` (`string`): The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA.\nIf no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.\n\nFor example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object.\n - `location` (`string`): The location of the cloud run service When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Service.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `binary_authorization` (`list[obj]`): Settings 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-beta.google_cloud_run_v2_service.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `template` (`list[obj]`): The template used to create revisions for this Service. When `null`, the `template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.new](#fn-templatenew) 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-beta.google_cloud_run_v2_service.timeouts.new](#fn-timeoutsnew) constructor.\n - `traffic` (`list[obj]`): Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision. When `null`, the `traffic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.traffic.new](#fn-trafficnew) 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 `google_cloud_run_v2_service` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, annotations=null, @@ -117,7 +117,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, liveness_probe:: { grpc:: { - '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.liveness_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\nIf this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grpc` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.liveness_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535.\nIf not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\nIf this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grpc` sub block.\n', args=[]), new( port=null, service=null @@ -137,13 +137,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); value: value, }), }, - '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.liveness_probe.http_get.new` constructs a new object with attributes and blocks configured for the `http_get`\nTerraform sub block.\n\n\n\n**Args**:\n - `path` (`string`): Path to access on the HTTP server. Defaults to '/'. When `null`, the `path` field will be omitted from the resulting object.\n - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.liveness_probe.http_get.http_headers.new](#fn-templatetemplatecontainersliveness_probehttp_headersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_get` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.liveness_probe.http_get.new` constructs a new object with attributes and blocks configured for the `http_get`\nTerraform sub block.\n\n\n\n**Args**:\n - `path` (`string`): Path to access on the HTTP server. Defaults to '/'. When `null`, the `path` field will be omitted from the resulting object.\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535.\nIf not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.liveness_probe.http_get.http_headers.new](#fn-templatetemplatecontainersliveness_probehttp_headersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_get` sub block.\n', args=[]), new( http_headers=null, - path=null + path=null, + port=null ):: std.prune(a={ http_headers: http_headers, path: path, + port: port, }), }, '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.liveness_probe.new` constructs a new object with attributes and blocks configured for the `liveness_probe`\nTerraform sub block.\n\n\n\n**Args**:\n - `failure_threshold` (`number`): Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. When `null`, the `failure_threshold` field will be omitted from the resulting object.\n - `initial_delay_seconds` (`number`): Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `initial_delay_seconds` field will be omitted from the resulting object.\n - `period_seconds` (`number`): How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds When `null`, the `period_seconds` field will be omitted from the resulting object.\n - `timeout_seconds` (`number`): Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `timeout_seconds` field will be omitted from the resulting object.\n - `grpc` (`list[obj]`): GRPC specifies an action involving a GRPC port. When `null`, the `grpc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.liveness_probe.grpc.new](#fn-templatetemplatecontainersgrpcnew) constructor.\n - `http_get` (`list[obj]`): HTTPGet specifies the http request to perform. When `null`, the `http_get` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.liveness_probe.http_get.new](#fn-templatetemplatecontainershttp_getnew) constructor.\n - `tcp_socket` (`list[obj]`): TCPSocket specifies an action involving a TCP port. This field is not supported in liveness probe currently. When `null`, the `tcp_socket` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.liveness_probe.tcp_socket.new](#fn-templatetemplatecontainerstcp_socketnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `liveness_probe` sub block.\n', args=[]), @@ -210,18 +212,20 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, resources:: { - '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.resources.new` constructs a new object with attributes and blocks configured for the `resources`\nTerraform sub block.\n\n\n\n**Args**:\n - `cpu_idle` (`bool`): Determines whether CPU should be throttled or not outside of requests. When `null`, the `cpu_idle` field will be omitted from the resulting object.\n - `limits` (`obj`): Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go When `null`, the `limits` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `resources` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.resources.new` constructs a new object with attributes and blocks configured for the `resources`\nTerraform sub block.\n\n\n\n**Args**:\n - `cpu_idle` (`bool`): Determines whether CPU should be throttled or not outside of requests. When `null`, the `cpu_idle` field will be omitted from the resulting object.\n - `limits` (`obj`): Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go When `null`, the `limits` field will be omitted from the resulting object.\n - `startup_cpu_boost` (`bool`): Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. When `null`, the `startup_cpu_boost` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `resources` sub block.\n', args=[]), new( cpu_idle=null, - limits=null + limits=null, + startup_cpu_boost=null ):: std.prune(a={ cpu_idle: cpu_idle, limits: limits, + startup_cpu_boost: startup_cpu_boost, }), }, startup_probe:: { grpc:: { - '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.startup_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\nIf this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grpc` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.startup_probe.grpc.new` constructs a new object with attributes and blocks configured for the `grpc`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535.\nIf not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\nIf this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grpc` sub block.\n', args=[]), new( port=null, service=null @@ -241,13 +245,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); value: value, }), }, - '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.startup_probe.http_get.new` constructs a new object with attributes and blocks configured for the `http_get`\nTerraform sub block.\n\n\n\n**Args**:\n - `path` (`string`): Path to access on the HTTP server. Defaults to '/'. When `null`, the `path` field will be omitted from the resulting object.\n - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.startup_probe.http_get.http_headers.new](#fn-templatetemplatecontainersstartup_probehttp_headersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_get` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.startup_probe.http_get.new` constructs a new object with attributes and blocks configured for the `http_get`\nTerraform sub block.\n\n\n\n**Args**:\n - `path` (`string`): Path to access on the HTTP server. Defaults to '/'. When `null`, the `path` field will be omitted from the resulting object.\n - `port` (`number`): Port number to access on the container. Must be in the range 1 to 65535.\nIf not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.startup_probe.http_get.http_headers.new](#fn-templatetemplatecontainersstartup_probehttp_headersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_get` sub block.\n', args=[]), new( http_headers=null, - path=null + path=null, + port=null ):: std.prune(a={ http_headers: http_headers, path: path, + port: port, }), }, '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.startup_probe.new` constructs a new object with attributes and blocks configured for the `startup_probe`\nTerraform sub block.\n\n\n\n**Args**:\n - `failure_threshold` (`number`): Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. When `null`, the `failure_threshold` field will be omitted from the resulting object.\n - `initial_delay_seconds` (`number`): Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `initial_delay_seconds` field will be omitted from the resulting object.\n - `period_seconds` (`number`): How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds When `null`, the `period_seconds` field will be omitted from the resulting object.\n - `timeout_seconds` (`number`): Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When `null`, the `timeout_seconds` field will be omitted from the resulting object.\n - `grpc` (`list[obj]`): GRPC specifies an action involving a GRPC port. When `null`, the `grpc` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.startup_probe.grpc.new](#fn-templatetemplatecontainersgrpcnew) constructor.\n - `http_get` (`list[obj]`): HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. When `null`, the `http_get` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.startup_probe.http_get.new](#fn-templatetemplatecontainershttp_getnew) constructor.\n - `tcp_socket` (`list[obj]`): TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. When `null`, the `tcp_socket` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.startup_probe.tcp_socket.new](#fn-templatetemplatecontainerstcp_socketnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `startup_probe` sub block.\n', args=[]), @@ -269,7 +275,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeout_seconds: timeout_seconds, }), tcp_socket:: { - '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.startup_probe.tcp_socket.new` constructs a new object with attributes and blocks configured for the `tcp_socket`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to 8080. When `null`, the `port` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `tcp_socket` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.containers.startup_probe.tcp_socket.new` constructs a new object with attributes and blocks configured for the `tcp_socket`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): Port number to access on the container. Must be in the range 1 to 65535.\nIf not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `tcp_socket` sub block.\n', args=[]), new( port=null ):: std.prune(a={ @@ -288,7 +294,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.new` constructs a new object with attributes and blocks configured for the `template`\nTerraform sub block.\n\n\n\n**Args**:\n - `annotations` (`obj`): KRM-style annotations for the resource. When `null`, the `annotations` field will be omitted from the resulting object.\n - `encryption_key` (`string`): A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek When `null`, the `encryption_key` field will be omitted from the resulting object.\n - `execution_environment` (`string`): The sandbox environment to host this Revision. Possible values: ["EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2"] When `null`, the `execution_environment` field will be omitted from the resulting object.\n - `labels` (`obj`): KRM-style labels for the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `max_instance_request_concurrency` (`number`): Sets the maximum number of requests that each serving instance can receive. When `null`, the `max_instance_request_concurrency` field will be omitted from the resulting object.\n - `revision` (`string`): The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name. When `null`, the `revision` field will be omitted from the resulting object.\n - `service_account` (`string`): Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. When `null`, the `service_account` field will be omitted from the resulting object.\n - `timeout` (`string`): Max allowed time for an instance to respond to a request.\n\nA duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". When `null`, the `timeout` field will be omitted from the resulting object.\n - `containers` (`list[obj]`): Holds the single container that defines the unit of execution for this task. When `null`, the `containers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.new](#fn-templatecontainersnew) constructor.\n - `scaling` (`list[obj]`): Scaling settings for this Revision. When `null`, the `scaling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.scaling.new](#fn-templatescalingnew) constructor.\n - `volumes` (`list[obj]`): A list of Volumes to make available to containers. When `null`, the `volumes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.volumes.new](#fn-templatevolumesnew) constructor.\n - `vpc_access` (`list[obj]`): VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. When `null`, the `vpc_access` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.vpc_access.new](#fn-templatevpc_accessnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `template` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_run_v2_service.template.new` constructs a new object with attributes and blocks configured for the `template`\nTerraform sub block.\n\n\n\n**Args**:\n - `annotations` (`obj`): KRM-style annotations for the resource. When `null`, the `annotations` field will be omitted from the resulting object.\n - `encryption_key` (`string`): A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek When `null`, the `encryption_key` field will be omitted from the resulting object.\n - `execution_environment` (`string`): The sandbox environment to host this Revision. Possible values: ["EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2"] When `null`, the `execution_environment` field will be omitted from the resulting object.\n - `labels` (`obj`): KRM-style labels for the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `max_instance_request_concurrency` (`number`): Sets the maximum number of requests that each serving instance can receive. When `null`, the `max_instance_request_concurrency` field will be omitted from the resulting object.\n - `revision` (`string`): The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name. When `null`, the `revision` field will be omitted from the resulting object.\n - `service_account` (`string`): Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. When `null`, the `service_account` field will be omitted from the resulting object.\n - `session_affinity` (`bool`): Enables session affinity. For more information, go to https://cloud.google.com/run/docs/configuring/session-affinity When `null`, the `session_affinity` field will be omitted from the resulting object.\n - `timeout` (`string`): Max allowed time for an instance to respond to a request.\n\nA duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". When `null`, the `timeout` field will be omitted from the resulting object.\n - `containers` (`list[obj]`): Holds the single container that defines the unit of execution for this task. When `null`, the `containers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.new](#fn-templatecontainersnew) constructor.\n - `scaling` (`list[obj]`): Scaling settings for this Revision. When `null`, the `scaling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.scaling.new](#fn-templatescalingnew) constructor.\n - `volumes` (`list[obj]`): A list of Volumes to make available to containers. When `null`, the `volumes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.volumes.new](#fn-templatevolumesnew) constructor.\n - `vpc_access` (`list[obj]`): VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. When `null`, the `vpc_access` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.vpc_access.new](#fn-templatevpc_accessnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `template` sub block.\n', args=[]), new( annotations=null, containers=null, @@ -299,6 +305,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); revision=null, scaling=null, service_account=null, + session_affinity=null, timeout=null, volumes=null, vpc_access=null @@ -312,6 +319,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); revision: revision, scaling: scaling, service_account: service_account, + session_affinity: session_affinity, timeout: timeout, volumes: volumes, vpc_access: vpc_access, diff --git a/4.x/_gen/resources/cloud_scheduler_job.libsonnet b/4.x/_gen/resources/cloud_scheduler_job.libsonnet index 6a0e46d9..0613706c 100644 --- a/4.x/_gen/resources/cloud_scheduler_job.libsonnet +++ b/4.x/_gen/resources/cloud_scheduler_job.libsonnet @@ -15,7 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); version: version, }), }, - '#new':: d.fn(help='\n`google-beta.google_cloud_scheduler_job.app_engine_http_target.new` constructs a new object with attributes and blocks configured for the `app_engine_http_target`\nTerraform sub block.\n\n\n\n**Args**:\n - `body` (`string`): HTTP request body. \nA request body is allowed only if the HTTP method is POST or PUT. \nIt will result in invalid argument error to set a body on a job with an incompatible HttpMethod.\n\nA base64-encoded string. When `null`, the `body` field will be omitted from the resulting object.\n - `headers` (`obj`): HTTP request headers.\nThis map contains the header field names and values. \nHeaders can be set when the job is created. When `null`, the `headers` field will be omitted from the resulting object.\n - `http_method` (`string`): Which HTTP method to use for the request. When `null`, the `http_method` field will be omitted from the resulting object.\n - `relative_uri` (`string`): The relative URI.\nThe relative URL must begin with "/" and must be a valid HTTP relative URL. \nIt can contain a path, query string arguments, and \\# fragments. \nIf the relative URL is empty, then the root path "/" will be used. \nNo spaces are allowed, and the maximum length allowed is 2083 characters\n - `app_engine_routing` (`list[obj]`): App Engine Routing setting for the job. When `null`, the `app_engine_routing` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.app_engine_http_target.app_engine_routing.new](#fn-app_engine_http_targetapp_engine_routingnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `app_engine_http_target` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_scheduler_job.app_engine_http_target.new` constructs a new object with attributes and blocks configured for the `app_engine_http_target`\nTerraform sub block.\n\n\n\n**Args**:\n - `body` (`string`): HTTP request body.\nA request body is allowed only if the HTTP method is POST or PUT.\nIt will result in invalid argument error to set a body on a job with an incompatible HttpMethod.\n\nA base64-encoded string. When `null`, the `body` field will be omitted from the resulting object.\n - `headers` (`obj`): HTTP request headers.\nThis map contains the header field names and values.\nHeaders can be set when the job is created. When `null`, the `headers` field will be omitted from the resulting object.\n - `http_method` (`string`): Which HTTP method to use for the request. When `null`, the `http_method` field will be omitted from the resulting object.\n - `relative_uri` (`string`): The relative URI.\nThe relative URL must begin with "/" and must be a valid HTTP relative URL.\nIt can contain a path, query string arguments, and \\# fragments.\nIf the relative URL is empty, then the root path "/" will be used.\nNo spaces are allowed, and the maximum length allowed is 2083 characters\n - `app_engine_routing` (`list[obj]`): App Engine Routing setting for the job. When `null`, the `app_engine_routing` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.app_engine_http_target.app_engine_routing.new](#fn-app_engine_http_targetapp_engine_routingnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `app_engine_http_target` sub block.\n', args=[]), new( relative_uri, app_engine_routing=null, @@ -31,7 +31,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, http_target:: { - '#new':: d.fn(help='\n`google-beta.google_cloud_scheduler_job.http_target.new` constructs a new object with attributes and blocks configured for the `http_target`\nTerraform sub block.\n\n\n\n**Args**:\n - `body` (`string`): HTTP request body. \nA request body is allowed only if the HTTP method is POST, PUT, or PATCH. \nIt is an error to set body on a job with an incompatible HttpMethod.\n\nA base64-encoded string. When `null`, the `body` field will be omitted from the resulting object.\n - `headers` (`obj`): This map contains the header field names and values. \nRepeated headers are not supported, but a header value can contain commas. When `null`, the `headers` field will be omitted from the resulting object.\n - `http_method` (`string`): Which HTTP method to use for the request. When `null`, the `http_method` field will be omitted from the resulting object.\n - `uri` (`string`): The full URI path that the request will be sent to.\n - `oauth_token` (`list[obj]`): Contains information needed for generating an OAuth token.\nThis type of authorization should be used when sending requests to a GCP endpoint. When `null`, the `oauth_token` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.http_target.oauth_token.new](#fn-http_targetoauth_tokennew) constructor.\n - `oidc_token` (`list[obj]`): Contains information needed for generating an OpenID Connect token.\nThis type of authorization should be used when sending requests to third party endpoints or Cloud Run. When `null`, the `oidc_token` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.http_target.oidc_token.new](#fn-http_targetoidc_tokennew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_target` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_scheduler_job.http_target.new` constructs a new object with attributes and blocks configured for the `http_target`\nTerraform sub block.\n\n\n\n**Args**:\n - `body` (`string`): HTTP request body.\nA request body is allowed only if the HTTP method is POST, PUT, or PATCH.\nIt is an error to set body on a job with an incompatible HttpMethod.\n\nA base64-encoded string. When `null`, the `body` field will be omitted from the resulting object.\n - `headers` (`obj`): This map contains the header field names and values.\nRepeated headers are not supported, but a header value can contain commas. When `null`, the `headers` field will be omitted from the resulting object.\n - `http_method` (`string`): Which HTTP method to use for the request. When `null`, the `http_method` field will be omitted from the resulting object.\n - `uri` (`string`): The full URI path that the request will be sent to.\n - `oauth_token` (`list[obj]`): Contains information needed for generating an OAuth token.\nThis type of authorization should be used when sending requests to a GCP endpoint. When `null`, the `oauth_token` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.http_target.oauth_token.new](#fn-http_targetoauth_tokennew) constructor.\n - `oidc_token` (`list[obj]`): Contains information needed for generating an OpenID Connect token.\nThis type of authorization should be used when sending requests to third party endpoints or Cloud Run. When `null`, the `oidc_token` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.http_target.oidc_token.new](#fn-http_targetoidc_tokennew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_target` sub block.\n', args=[]), new( uri, body=null, @@ -68,7 +68,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help="\n`google-beta.google_cloud_scheduler_job.new` injects a new `google-beta_google_cloud_scheduler_job` 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-beta.google_cloud_scheduler_job.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_scheduler_job` using the reference:\n\n $._ref.google-beta_google_cloud_scheduler_job.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_scheduler_job.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 - `attempt_deadline` (`string`): The deadline for job attempts. If the request handler does not respond by this deadline then the request is\ncancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in\nexecution logs. Cloud Scheduler will retry the job according to the RetryConfig.\nThe allowed duration for this deadline is:\n* For HTTP targets, between 15 seconds and 30 minutes.\n* For App Engine HTTP targets, between 15 seconds and 24 hours.\n* **Note**: For PubSub targets, this field is ignored - setting it will introduce an unresolvable diff.\nA duration in seconds with up to nine fractional digits, terminated by \u0026#39;s\u0026#39;. Example: \u0026#34;3.5s\u0026#34; When `null`, the `attempt_deadline` field will be omitted from the resulting object.\n - `description` (`string`): A human-readable description for the job. \nThis string must not contain more than 500 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): The name of the job.\n - `paused` (`bool`): Sets the job to a paused state. Jobs default to being enabled when this property is not set. When `null`, the `paused` 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 - `region` (`string`): Region where the scheduler job resides. If it is not provided, Terraform will use the provider default. When `null`, the `region` field will be omitted from the resulting object.\n - `schedule` (`string`): Describes the schedule on which the job will be executed. When `null`, the `schedule` field will be omitted from the resulting object.\n - `time_zone` (`string`): Specifies the time zone to be used in interpreting schedule.\nThe value of this field must be a time zone name from the tz database. When `null`, the `time_zone` field will be omitted from the resulting object.\n - `app_engine_http_target` (`list[obj]`): App Engine HTTP target.\nIf the job providers a App Engine HTTP target the cron will \nsend a request to the service instance When `null`, the `app_engine_http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.app_engine_http_target.new](#fn-app_engine_http_targetnew) constructor.\n - `http_target` (`list[obj]`): HTTP target.\nIf the job providers a http_target the cron will \nsend a request to the targeted url When `null`, the `http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.http_target.new](#fn-http_targetnew) constructor.\n - `pubsub_target` (`list[obj]`): Pub/Sub target\nIf the job providers a Pub/Sub target the cron will publish\na message to the provided topic When `null`, the `pubsub_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.pubsub_target.new](#fn-pubsub_targetnew) constructor.\n - `retry_config` (`list[obj]`): By default, if a job does not complete successfully, \nmeaning that an acknowledgement is not received from the handler, \nthen it will be retried with exponential backoff according to the settings When `null`, the `retry_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-beta.google_cloud_scheduler_job.retry_config.new](#fn-retry_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-beta.google_cloud_scheduler_job.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-beta.google_cloud_scheduler_job.new` injects a new `google-beta_google_cloud_scheduler_job` 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-beta.google_cloud_scheduler_job.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloud_scheduler_job` using the reference:\n\n $._ref.google-beta_google_cloud_scheduler_job.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloud_scheduler_job.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 - `attempt_deadline` (`string`): The deadline for job attempts. If the request handler does not respond by this deadline then the request is\ncancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in\nexecution logs. Cloud Scheduler will retry the job according to the RetryConfig.\nThe allowed duration for this deadline is:\n* For HTTP targets, between 15 seconds and 30 minutes.\n* For App Engine HTTP targets, between 15 seconds and 24 hours.\n* **Note**: For PubSub targets, this field is ignored - setting it will introduce an unresolvable diff.\nA duration in seconds with up to nine fractional digits, terminated by \u0026#39;s\u0026#39;. Example: \u0026#34;3.5s\u0026#34; When `null`, the `attempt_deadline` field will be omitted from the resulting object.\n - `description` (`string`): A human-readable description for the job.\nThis string must not contain more than 500 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): The name of the job.\n - `paused` (`bool`): Sets the job to a paused state. Jobs default to being enabled when this property is not set. When `null`, the `paused` 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 - `region` (`string`): Region where the scheduler job resides. If it is not provided, Terraform will use the provider default. When `null`, the `region` field will be omitted from the resulting object.\n - `schedule` (`string`): Describes the schedule on which the job will be executed. When `null`, the `schedule` field will be omitted from the resulting object.\n - `time_zone` (`string`): Specifies the time zone to be used in interpreting schedule.\nThe value of this field must be a time zone name from the tz database. When `null`, the `time_zone` field will be omitted from the resulting object.\n - `app_engine_http_target` (`list[obj]`): App Engine HTTP target.\nIf the job providers a App Engine HTTP target the cron will\nsend a request to the service instance When `null`, the `app_engine_http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.app_engine_http_target.new](#fn-app_engine_http_targetnew) constructor.\n - `http_target` (`list[obj]`): HTTP target.\nIf the job providers a http_target the cron will\nsend a request to the targeted url When `null`, the `http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.http_target.new](#fn-http_targetnew) constructor.\n - `pubsub_target` (`list[obj]`): Pub/Sub target\nIf the job providers a Pub/Sub target the cron will publish\na message to the provided topic When `null`, the `pubsub_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.pubsub_target.new](#fn-pubsub_targetnew) constructor.\n - `retry_config` (`list[obj]`): By default, if a job does not complete successfully,\nmeaning that an acknowledgement is not received from the handler,\nthen it will be retried with exponential backoff according to the settings When `null`, the `retry_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-beta.google_cloud_scheduler_job.retry_config.new](#fn-retry_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-beta.google_cloud_scheduler_job.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, @@ -105,7 +105,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_scheduler_job.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_scheduler_job`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_scheduler_job.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 - `attempt_deadline` (`string`): The deadline for job attempts. If the request handler does not respond by this deadline then the request is\ncancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in\nexecution logs. Cloud Scheduler will retry the job according to the RetryConfig.\nThe allowed duration for this deadline is:\n* For HTTP targets, between 15 seconds and 30 minutes.\n* For App Engine HTTP targets, between 15 seconds and 24 hours.\n* **Note**: For PubSub targets, this field is ignored - setting it will introduce an unresolvable diff.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s" When `null`, the `attempt_deadline` field will be omitted from the resulting object.\n - `description` (`string`): A human-readable description for the job. \nThis string must not contain more than 500 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): The name of the job.\n - `paused` (`bool`): Sets the job to a paused state. Jobs default to being enabled when this property is not set. When `null`, the `paused` 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 - `region` (`string`): Region where the scheduler job resides. If it is not provided, Terraform will use the provider default. When `null`, the `region` field will be omitted from the resulting object.\n - `schedule` (`string`): Describes the schedule on which the job will be executed. When `null`, the `schedule` field will be omitted from the resulting object.\n - `time_zone` (`string`): Specifies the time zone to be used in interpreting schedule.\nThe value of this field must be a time zone name from the tz database. When `null`, the `time_zone` field will be omitted from the resulting object.\n - `app_engine_http_target` (`list[obj]`): App Engine HTTP target.\nIf the job providers a App Engine HTTP target the cron will \nsend a request to the service instance When `null`, the `app_engine_http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.app_engine_http_target.new](#fn-app_engine_http_targetnew) constructor.\n - `http_target` (`list[obj]`): HTTP target.\nIf the job providers a http_target the cron will \nsend a request to the targeted url When `null`, the `http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.http_target.new](#fn-http_targetnew) constructor.\n - `pubsub_target` (`list[obj]`): Pub/Sub target\nIf the job providers a Pub/Sub target the cron will publish\na message to the provided topic When `null`, the `pubsub_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.pubsub_target.new](#fn-pubsub_targetnew) constructor.\n - `retry_config` (`list[obj]`): By default, if a job does not complete successfully, \nmeaning that an acknowledgement is not received from the handler, \nthen it will be retried with exponential backoff according to the settings When `null`, the `retry_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-beta.google_cloud_scheduler_job.retry_config.new](#fn-retry_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-beta.google_cloud_scheduler_job.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 `google_cloud_scheduler_job` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_cloud_scheduler_job.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloud_scheduler_job`\nTerraform resource.\n\nUnlike [google-beta.google_cloud_scheduler_job.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 - `attempt_deadline` (`string`): The deadline for job attempts. If the request handler does not respond by this deadline then the request is\ncancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in\nexecution logs. Cloud Scheduler will retry the job according to the RetryConfig.\nThe allowed duration for this deadline is:\n* For HTTP targets, between 15 seconds and 30 minutes.\n* For App Engine HTTP targets, between 15 seconds and 24 hours.\n* **Note**: For PubSub targets, this field is ignored - setting it will introduce an unresolvable diff.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s" When `null`, the `attempt_deadline` field will be omitted from the resulting object.\n - `description` (`string`): A human-readable description for the job.\nThis string must not contain more than 500 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): The name of the job.\n - `paused` (`bool`): Sets the job to a paused state. Jobs default to being enabled when this property is not set. When `null`, the `paused` 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 - `region` (`string`): Region where the scheduler job resides. If it is not provided, Terraform will use the provider default. When `null`, the `region` field will be omitted from the resulting object.\n - `schedule` (`string`): Describes the schedule on which the job will be executed. When `null`, the `schedule` field will be omitted from the resulting object.\n - `time_zone` (`string`): Specifies the time zone to be used in interpreting schedule.\nThe value of this field must be a time zone name from the tz database. When `null`, the `time_zone` field will be omitted from the resulting object.\n - `app_engine_http_target` (`list[obj]`): App Engine HTTP target.\nIf the job providers a App Engine HTTP target the cron will\nsend a request to the service instance When `null`, the `app_engine_http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.app_engine_http_target.new](#fn-app_engine_http_targetnew) constructor.\n - `http_target` (`list[obj]`): HTTP target.\nIf the job providers a http_target the cron will\nsend a request to the targeted url When `null`, the `http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.http_target.new](#fn-http_targetnew) constructor.\n - `pubsub_target` (`list[obj]`): Pub/Sub target\nIf the job providers a Pub/Sub target the cron will publish\na message to the provided topic When `null`, the `pubsub_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.pubsub_target.new](#fn-pubsub_targetnew) constructor.\n - `retry_config` (`list[obj]`): By default, if a job does not complete successfully,\nmeaning that an acknowledgement is not received from the handler,\nthen it will be retried with exponential backoff according to the settings When `null`, the `retry_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-beta.google_cloud_scheduler_job.retry_config.new](#fn-retry_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-beta.google_cloud_scheduler_job.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 `google_cloud_scheduler_job` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, app_engine_http_target=null, @@ -148,7 +148,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, retry_config:: { - '#new':: d.fn(help='\n`google-beta.google_cloud_scheduler_job.retry_config.new` constructs a new object with attributes and blocks configured for the `retry_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_backoff_duration` (`string`): The maximum amount of time to wait before retrying a job after it fails.\nA duration in seconds with up to nine fractional digits, terminated by 's'. When `null`, the `max_backoff_duration` field will be omitted from the resulting object.\n - `max_doublings` (`number`): The time between retries will double maxDoublings times.\nA job's retry interval starts at minBackoffDuration, \nthen doubles maxDoublings times, then increases linearly, \nand finally retries retries at intervals of maxBackoffDuration up to retryCount times. When `null`, the `max_doublings` field will be omitted from the resulting object.\n - `max_retry_duration` (`string`): The time limit for retrying a failed job, measured from time when an execution was first attempted. \nIf specified with retryCount, the job will be retried until both limits are reached.\nA duration in seconds with up to nine fractional digits, terminated by 's'. When `null`, the `max_retry_duration` field will be omitted from the resulting object.\n - `min_backoff_duration` (`string`): The minimum amount of time to wait before retrying a job after it fails.\nA duration in seconds with up to nine fractional digits, terminated by 's'. When `null`, the `min_backoff_duration` field will be omitted from the resulting object.\n - `retry_count` (`number`): The number of attempts that the system will make to run a \njob using the exponential backoff procedure described by maxDoublings.\nValues greater than 5 and negative values are not allowed. When `null`, the `retry_count` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `retry_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloud_scheduler_job.retry_config.new` constructs a new object with attributes and blocks configured for the `retry_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_backoff_duration` (`string`): The maximum amount of time to wait before retrying a job after it fails.\nA duration in seconds with up to nine fractional digits, terminated by 's'. When `null`, the `max_backoff_duration` field will be omitted from the resulting object.\n - `max_doublings` (`number`): The time between retries will double maxDoublings times.\nA job's retry interval starts at minBackoffDuration,\nthen doubles maxDoublings times, then increases linearly,\nand finally retries retries at intervals of maxBackoffDuration up to retryCount times. When `null`, the `max_doublings` field will be omitted from the resulting object.\n - `max_retry_duration` (`string`): The time limit for retrying a failed job, measured from time when an execution was first attempted.\nIf specified with retryCount, the job will be retried until both limits are reached.\nA duration in seconds with up to nine fractional digits, terminated by 's'. When `null`, the `max_retry_duration` field will be omitted from the resulting object.\n - `min_backoff_duration` (`string`): The minimum amount of time to wait before retrying a job after it fails.\nA duration in seconds with up to nine fractional digits, terminated by 's'. When `null`, the `min_backoff_duration` field will be omitted from the resulting object.\n - `retry_count` (`number`): The number of attempts that the system will make to run a\njob using the exponential backoff procedure described by maxDoublings.\nValues greater than 5 and negative values are not allowed. When `null`, the `retry_count` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `retry_config` sub block.\n', args=[]), new( max_backoff_duration=null, max_doublings=null, diff --git a/4.x/_gen/resources/cloudbuild_bitbucket_server_config.libsonnet b/4.x/_gen/resources/cloudbuild_bitbucket_server_config.libsonnet index df7de405..cc8ba5a6 100644 --- a/4.x/_gen/resources/cloudbuild_bitbucket_server_config.libsonnet +++ b/4.x/_gen/resources/cloudbuild_bitbucket_server_config.libsonnet @@ -12,7 +12,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); repo_slug: repo_slug, }), }, - '#new':: d.fn(help="\n`google-beta.google_cloudbuild_bitbucket_server_config.new` injects a new `google-beta_google_cloudbuild_bitbucket_server_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-beta.google_cloudbuild_bitbucket_server_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloudbuild_bitbucket_server_config` using the reference:\n\n $._ref.google-beta_google_cloudbuild_bitbucket_server_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloudbuild_bitbucket_server_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 - `api_key` (`string`): Immutable. API Key that will be attached to webhook. Once this field has been set, it cannot be changed.\nChanging this field will result in deleting/ recreating the resource.\n - `config_id` (`string`): The ID to use for the BitbucketServerConfig, which will become the final component of the BitbucketServerConfig\u0026#39;s resource name.\n - `host_uri` (`string`): Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed.\nIf you need to change it, please create another BitbucketServerConfig.\n - `location` (`string`): The location of this bitbucket server config.\n - `peered_network` (`string`): The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. \nThis should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, \nno network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format \nprojects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project. When `null`, the `peered_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 - `ssl_ca` (`string`): SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of .pem, .cer, or .crt. When `null`, the `ssl_ca` field will be omitted from the resulting object.\n - `username` (`string`): Username of the account Cloud Build will use on Bitbucket Server.\n - `connected_repositories` (`list[obj]`): Connected Bitbucket Server repositories for this config. When `null`, the `connected_repositories` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_bitbucket_server_config.connected_repositories.new](#fn-connected_repositoriesnew) constructor.\n - `secrets` (`list[obj]`): Secret Manager secrets needed by the config. When `null`, the `secrets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_bitbucket_server_config.secrets.new](#fn-secretsnew) 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-beta.google_cloudbuild_bitbucket_server_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-beta.google_cloudbuild_bitbucket_server_config.new` injects a new `google-beta_google_cloudbuild_bitbucket_server_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-beta.google_cloudbuild_bitbucket_server_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloudbuild_bitbucket_server_config` using the reference:\n\n $._ref.google-beta_google_cloudbuild_bitbucket_server_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloudbuild_bitbucket_server_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 - `api_key` (`string`): Immutable. API Key that will be attached to webhook. Once this field has been set, it cannot be changed.\nChanging this field will result in deleting/ recreating the resource.\n - `config_id` (`string`): The ID to use for the BitbucketServerConfig, which will become the final component of the BitbucketServerConfig\u0026#39;s resource name.\n - `host_uri` (`string`): Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed.\nIf you need to change it, please create another BitbucketServerConfig.\n - `location` (`string`): The location of this bitbucket server config.\n - `peered_network` (`string`): The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection.\nThis should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty,\nno network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format\nprojects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project. When `null`, the `peered_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 - `ssl_ca` (`string`): SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of .pem, .cer, or .crt. When `null`, the `ssl_ca` field will be omitted from the resulting object.\n - `username` (`string`): Username of the account Cloud Build will use on Bitbucket Server.\n - `connected_repositories` (`list[obj]`): Connected Bitbucket Server repositories for this config. When `null`, the `connected_repositories` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_bitbucket_server_config.connected_repositories.new](#fn-connected_repositoriesnew) constructor.\n - `secrets` (`list[obj]`): Secret Manager secrets needed by the config. When `null`, the `secrets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_bitbucket_server_config.secrets.new](#fn-secretsnew) 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-beta.google_cloudbuild_bitbucket_server_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, api_key, @@ -45,7 +45,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_cloudbuild_bitbucket_server_config.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloudbuild_bitbucket_server_config`\nTerraform resource.\n\nUnlike [google-beta.google_cloudbuild_bitbucket_server_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 - `api_key` (`string`): Immutable. API Key that will be attached to webhook. Once this field has been set, it cannot be changed.\nChanging this field will result in deleting/ recreating the resource.\n - `config_id` (`string`): The ID to use for the BitbucketServerConfig, which will become the final component of the BitbucketServerConfig's resource name.\n - `host_uri` (`string`): Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed.\nIf you need to change it, please create another BitbucketServerConfig.\n - `location` (`string`): The location of this bitbucket server config.\n - `peered_network` (`string`): The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. \nThis should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, \nno network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format \nprojects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project. When `null`, the `peered_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 - `ssl_ca` (`string`): SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of .pem, .cer, or .crt. When `null`, the `ssl_ca` field will be omitted from the resulting object.\n - `username` (`string`): Username of the account Cloud Build will use on Bitbucket Server.\n - `connected_repositories` (`list[obj]`): Connected Bitbucket Server repositories for this config. When `null`, the `connected_repositories` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_bitbucket_server_config.connected_repositories.new](#fn-connected_repositoriesnew) constructor.\n - `secrets` (`list[obj]`): Secret Manager secrets needed by the config. When `null`, the `secrets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_bitbucket_server_config.secrets.new](#fn-secretsnew) 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-beta.google_cloudbuild_bitbucket_server_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 `google_cloudbuild_bitbucket_server_config` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_cloudbuild_bitbucket_server_config.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloudbuild_bitbucket_server_config`\nTerraform resource.\n\nUnlike [google-beta.google_cloudbuild_bitbucket_server_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 - `api_key` (`string`): Immutable. API Key that will be attached to webhook. Once this field has been set, it cannot be changed.\nChanging this field will result in deleting/ recreating the resource.\n - `config_id` (`string`): The ID to use for the BitbucketServerConfig, which will become the final component of the BitbucketServerConfig's resource name.\n - `host_uri` (`string`): Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed.\nIf you need to change it, please create another BitbucketServerConfig.\n - `location` (`string`): The location of this bitbucket server config.\n - `peered_network` (`string`): The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection.\nThis should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty,\nno network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format\nprojects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project. When `null`, the `peered_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 - `ssl_ca` (`string`): SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of .pem, .cer, or .crt. When `null`, the `ssl_ca` field will be omitted from the resulting object.\n - `username` (`string`): Username of the account Cloud Build will use on Bitbucket Server.\n - `connected_repositories` (`list[obj]`): Connected Bitbucket Server repositories for this config. When `null`, the `connected_repositories` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_bitbucket_server_config.connected_repositories.new](#fn-connected_repositoriesnew) constructor.\n - `secrets` (`list[obj]`): Secret Manager secrets needed by the config. When `null`, the `secrets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_bitbucket_server_config.secrets.new](#fn-secretsnew) 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-beta.google_cloudbuild_bitbucket_server_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 `google_cloudbuild_bitbucket_server_config` resource into the root Terraform configuration.\n', args=[]), newAttrs( api_key, config_id, diff --git a/4.x/_gen/resources/cloudbuild_trigger.libsonnet b/4.x/_gen/resources/cloudbuild_trigger.libsonnet index 44c0a77a..15faf85c 100644 --- a/4.x/_gen/resources/cloudbuild_trigger.libsonnet +++ b/4.x/_gen/resources/cloudbuild_trigger.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_cloudbuild_trigger', url='', help='`google_cloudbuild_trigger` represents the `google-beta_google_cloudbuild_trigger` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), approval_config:: { - '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.approval_config.new` constructs a new object with attributes and blocks configured for the `approval_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `approval_required` (`bool`): Whether or not approval is needed. If this is set on a build, it will become pending when run, \nand will need to be explicitly approved to start. When `null`, the `approval_required` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `approval_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.approval_config.new` constructs a new object with attributes and blocks configured for the `approval_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `approval_required` (`bool`): Whether or not approval is needed. If this is set on a build, it will become pending when run,\nand will need to be explicitly approved to start. When `null`, the `approval_required` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `approval_config` sub block.\n', args=[]), new( approval_required=null ):: std.prune(a={ @@ -89,7 +89,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.build.new` constructs a new object with attributes and blocks configured for the `build`\nTerraform sub block.\n\n\n\n**Args**:\n - `images` (`list`): A list of images to be pushed upon the successful completion of all build steps.\nThe images are pushed using the builder service account's credentials.\nThe digests of the pushed images will be stored in the Build resource's results field.\nIf any of the images fail to be pushed, the build status is marked FAILURE. When `null`, the `images` field will be omitted from the resulting object.\n - `logs_bucket` (`string`): Google Cloud Storage bucket where logs should be written. \nLogs file names will be of the format ${logsBucket}/log-${build_id}.txt. When `null`, the `logs_bucket` field will be omitted from the resulting object.\n - `queue_ttl` (`string`): TTL in queue for this build. If provided and the build is enqueued longer than this value, \nthe build will expire and the build status will be EXPIRED.\nThe TTL starts ticking from createTime.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `queue_ttl` field will be omitted from the resulting object.\n - `substitutions` (`obj`): Substitutions data for Build resource. When `null`, the `substitutions` field will be omitted from the resulting object.\n - `tags` (`list`): Tags for annotation of a Build. These are not docker tags. When `null`, the `tags` field will be omitted from the resulting object.\n - `timeout` (`string`): Amount of time that this build should be allowed to run, to second granularity.\nIf this amount of time elapses, work on the build will cease and the build status will be TIMEOUT.\nThis timeout must be equal to or greater than the sum of the timeouts for build steps within the build.\nThe expected format is the number of seconds followed by s.\nDefault time is ten minutes (600s). When `null`, the `timeout` field will be omitted from the resulting object.\n - `artifacts` (`list[obj]`): Artifacts produced by the build that should be uploaded upon successful completion of all build steps. When `null`, the `artifacts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.artifacts.new](#fn-buildartifactsnew) constructor.\n - `available_secrets` (`list[obj]`): Secrets and secret environment variables. When `null`, the `available_secrets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.available_secrets.new](#fn-buildavailable_secretsnew) constructor.\n - `options` (`list[obj]`): Special options for this build. When `null`, the `options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.options.new](#fn-buildoptionsnew) constructor.\n - `secret` (`list[obj]`): Secrets to decrypt using Cloud Key Management Service. When `null`, the `secret` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.secret.new](#fn-buildsecretnew) constructor.\n - `source` (`list[obj]`): The location of the source files to build.\n\nOne of 'storageSource' or 'repoSource' must be provided. When `null`, the `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-beta.google_cloudbuild_trigger.build.source.new](#fn-buildsourcenew) constructor.\n - `step` (`list[obj]`): The operations to be performed on the workspace. When `null`, the `step` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.step.new](#fn-buildstepnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `build` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.build.new` constructs a new object with attributes and blocks configured for the `build`\nTerraform sub block.\n\n\n\n**Args**:\n - `images` (`list`): A list of images to be pushed upon the successful completion of all build steps.\nThe images are pushed using the builder service account's credentials.\nThe digests of the pushed images will be stored in the Build resource's results field.\nIf any of the images fail to be pushed, the build status is marked FAILURE. When `null`, the `images` field will be omitted from the resulting object.\n - `logs_bucket` (`string`): Google Cloud Storage bucket where logs should be written.\nLogs file names will be of the format ${logsBucket}/log-${build_id}.txt. When `null`, the `logs_bucket` field will be omitted from the resulting object.\n - `queue_ttl` (`string`): TTL in queue for this build. If provided and the build is enqueued longer than this value,\nthe build will expire and the build status will be EXPIRED.\nThe TTL starts ticking from createTime.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `queue_ttl` field will be omitted from the resulting object.\n - `substitutions` (`obj`): Substitutions data for Build resource. When `null`, the `substitutions` field will be omitted from the resulting object.\n - `tags` (`list`): Tags for annotation of a Build. These are not docker tags. When `null`, the `tags` field will be omitted from the resulting object.\n - `timeout` (`string`): Amount of time that this build should be allowed to run, to second granularity.\nIf this amount of time elapses, work on the build will cease and the build status will be TIMEOUT.\nThis timeout must be equal to or greater than the sum of the timeouts for build steps within the build.\nThe expected format is the number of seconds followed by s.\nDefault time is ten minutes (600s). When `null`, the `timeout` field will be omitted from the resulting object.\n - `artifacts` (`list[obj]`): Artifacts produced by the build that should be uploaded upon successful completion of all build steps. When `null`, the `artifacts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.artifacts.new](#fn-buildartifactsnew) constructor.\n - `available_secrets` (`list[obj]`): Secrets and secret environment variables. When `null`, the `available_secrets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.available_secrets.new](#fn-buildavailable_secretsnew) constructor.\n - `options` (`list[obj]`): Special options for this build. When `null`, the `options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.options.new](#fn-buildoptionsnew) constructor.\n - `secret` (`list[obj]`): Secrets to decrypt using Cloud Key Management Service. When `null`, the `secret` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.secret.new](#fn-buildsecretnew) constructor.\n - `source` (`list[obj]`): The location of the source files to build.\n\nOne of 'storageSource' or 'repoSource' must be provided. When `null`, the `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-beta.google_cloudbuild_trigger.build.source.new](#fn-buildsourcenew) constructor.\n - `step` (`list[obj]`): The operations to be performed on the workspace. When `null`, the `step` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.step.new](#fn-buildstepnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `build` sub block.\n', args=[]), new( artifacts=null, available_secrets=null, @@ -158,7 +158,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, secret:: { - '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.build.secret.new` constructs a new object with attributes and blocks configured for the `secret`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_name` (`string`): Cloud KMS key name to use to decrypt these envs.\n - `secret_env` (`obj`): Map of environment variable name to its encrypted value.\nSecret environment variables must be unique across all of a build's secrets, \nand must be used by at least one build step. Values can be at most 64 KB in size. \nThere can be at most 100 secret values across all of a build's secrets. When `null`, the `secret_env` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `secret` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.build.secret.new` constructs a new object with attributes and blocks configured for the `secret`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_name` (`string`): Cloud KMS key name to use to decrypt these envs.\n - `secret_env` (`obj`): Map of environment variable name to its encrypted value.\nSecret environment variables must be unique across all of a build's secrets,\nand must be used by at least one build step. Values can be at most 64 KB in size.\nThere can be at most 100 secret values across all of a build's secrets. When `null`, the `secret_env` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `secret` sub block.\n', args=[]), new( kms_key_name, secret_env=null @@ -177,7 +177,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); storage_source: storage_source, }), repo_source:: { - '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.build.source.repo_source.new` constructs a new object with attributes and blocks configured for the `repo_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `branch_name` (`string`): Regex matching branches to build. Exactly one a of branch name, tag, or commit SHA must be provided.\nThe syntax of the regular expressions accepted is the syntax accepted by RE2 and \ndescribed at https://github.com/google/re2/wiki/Syntax When `null`, the `branch_name` field will be omitted from the resulting object.\n - `commit_sha` (`string`): Explicit commit SHA to build. Exactly one a of branch name, tag, or commit SHA must be provided. When `null`, the `commit_sha` field will be omitted from the resulting object.\n - `dir` (`string`): Directory, relative to the source root, in which to run the build.\nThis must be a relative path. If a step's dir is specified and is an absolute path, \nthis value is ignored for that step's execution. When `null`, the `dir` field will be omitted from the resulting object.\n - `invert_regex` (`bool`): Only trigger a build if the revision regex does NOT match the revision regex. When `null`, the `invert_regex` field will be omitted from the resulting object.\n - `project_id` (`string`): ID of the project that owns the Cloud Source Repository. \nIf omitted, the project ID requesting the build is assumed. When `null`, the `project_id` field will be omitted from the resulting object.\n - `repo_name` (`string`): Name of the Cloud Source Repository.\n - `substitutions` (`obj`): Substitutions to use in a triggered build. Should only be used with triggers.run When `null`, the `substitutions` field will be omitted from the resulting object.\n - `tag_name` (`string`): Regex matching tags to build. Exactly one a of branch name, tag, or commit SHA must be provided.\nThe syntax of the regular expressions accepted is the syntax accepted by RE2 and \ndescribed at https://github.com/google/re2/wiki/Syntax When `null`, the `tag_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `repo_source` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.build.source.repo_source.new` constructs a new object with attributes and blocks configured for the `repo_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `branch_name` (`string`): Regex matching branches to build. Exactly one a of branch name, tag, or commit SHA must be provided.\nThe syntax of the regular expressions accepted is the syntax accepted by RE2 and\ndescribed at https://github.com/google/re2/wiki/Syntax When `null`, the `branch_name` field will be omitted from the resulting object.\n - `commit_sha` (`string`): Explicit commit SHA to build. Exactly one a of branch name, tag, or commit SHA must be provided. When `null`, the `commit_sha` field will be omitted from the resulting object.\n - `dir` (`string`): Directory, relative to the source root, in which to run the build.\nThis must be a relative path. If a step's dir is specified and is an absolute path,\nthis value is ignored for that step's execution. When `null`, the `dir` field will be omitted from the resulting object.\n - `invert_regex` (`bool`): Only trigger a build if the revision regex does NOT match the revision regex. When `null`, the `invert_regex` field will be omitted from the resulting object.\n - `project_id` (`string`): ID of the project that owns the Cloud Source Repository.\nIf omitted, the project ID requesting the build is assumed. When `null`, the `project_id` field will be omitted from the resulting object.\n - `repo_name` (`string`): Name of the Cloud Source Repository.\n - `substitutions` (`obj`): Substitutions to use in a triggered build. Should only be used with triggers.run When `null`, the `substitutions` field will be omitted from the resulting object.\n - `tag_name` (`string`): Regex matching tags to build. Exactly one a of branch name, tag, or commit SHA must be provided.\nThe syntax of the regular expressions accepted is the syntax accepted by RE2 and\ndescribed at https://github.com/google/re2/wiki/Syntax When `null`, the `tag_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `repo_source` sub block.\n', args=[]), new( repo_name, branch_name=null, @@ -199,7 +199,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, storage_source:: { - '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.build.source.storage_source.new` constructs a new object with attributes and blocks configured for the `storage_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `bucket` (`string`): Google Cloud Storage bucket containing the source.\n - `generation` (`string`): Google Cloud Storage generation for the object. \nIf the generation is omitted, the latest generation will be used When `null`, the `generation` field will be omitted from the resulting object.\n - `object` (`string`): Google Cloud Storage object containing the source.\nThis object must be a gzipped archive file (.tar.gz) containing source to build.\n\n**Returns**:\n - An attribute object that represents the `storage_source` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.build.source.storage_source.new` constructs a new object with attributes and blocks configured for the `storage_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `bucket` (`string`): Google Cloud Storage bucket containing the source.\n - `generation` (`string`): Google Cloud Storage generation for the object.\nIf the generation is omitted, the latest generation will be used When `null`, the `generation` field will be omitted from the resulting object.\n - `object` (`string`): Google Cloud Storage object containing the source.\nThis object must be a gzipped archive file (.tar.gz) containing source to build.\n\n**Returns**:\n - An attribute object that represents the `storage_source` sub block.\n', args=[]), new( bucket, object, @@ -212,7 +212,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, step:: { - '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.build.step.new` constructs a new object with attributes and blocks configured for the `step`\nTerraform sub block.\n\n\n\n**Args**:\n - `args` (`list`): A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, the args\nare used as arguments to that entrypoint. If the image does not define an\nentrypoint, the first element in args is used as the entrypoint, and the\nremainder will be used as arguments. When `null`, the `args` field will be omitted from the resulting object.\n - `dir` (`string`): Working directory to use when running this step's container.\n\nIf this value is a relative path, it is relative to the build's working\ndirectory. If this value is absolute, it may be outside the build's working\ndirectory, in which case the contents of the path may not be persisted\nacross build step executions, unless a 'volume' for that path is specified.\n\nIf the build specifies a 'RepoSource' with 'dir' and a step with a\n'dir',\nwhich specifies an absolute path, the 'RepoSource' 'dir' is ignored\nfor the step's execution. When `null`, the `dir` field will be omitted from the resulting object.\n - `entrypoint` (`string`): Entrypoint to be used instead of the build step image's\ndefault entrypoint.\nIf unset, the image's default entrypoint is used When `null`, the `entrypoint` field will be omitted from the resulting object.\n - `env` (`list`): A list of environment variable definitions to be used when\nrunning a step.\n\nThe elements are of the form "KEY=VALUE" for the environment variable\n"KEY" being given the value "VALUE". When `null`, the `env` field will be omitted from the resulting object.\n - `name` (`string`): The name of the container image that will run this particular build step.\n\nIf the image is available in the host's Docker daemon's cache, it will be\nrun directly. If not, the host will attempt to pull the image first, using\nthe builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps (see https://github.com/GoogleCloudPlatform/cloud-builders \nfor images and examples).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like "ubuntu", "debian", but they will be refreshed at the time\nyou attempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.\n - `script` (`string`): A shell script to be executed in the step. \nWhen script is provided, the user cannot specify the entrypoint or args. When `null`, the `script` field will be omitted from the resulting object.\n - `secret_env` (`list`): A list of environment variables which are encrypted using\na Cloud Key\nManagement Service crypto key. These values must be specified in\nthe build's 'Secret'. When `null`, the `secret_env` field will be omitted from the resulting object.\n - `timeout` (`string`): Time limit for executing this build step. If not defined,\nthe step has no\ntime limit and will be allowed to continue to run until either it\ncompletes or the build itself times out. When `null`, the `timeout` field will be omitted from the resulting object.\n - `timing` (`string`): Output only. Stores timing information for executing this\nbuild step. When `null`, the `timing` field will be omitted from the resulting object.\n - `wait_for` (`list`): The ID(s) of the step(s) that this build step depends on.\n\nThis build step will not start until all the build steps in 'wait_for'\nhave completed successfully. If 'wait_for' is empty, this build step\nwill start when all previous build steps in the 'Build.Steps' list\nhave completed successfully. When `null`, the `wait_for` field will be omitted from the resulting object.\n - `volumes` (`list[obj]`): List of volumes to mount into the build step.\n\nEach volume is created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents\nare discarded.\n\nUsing a named volume in only one step is not valid as it is\nindicative of a build request with an incorrect configuration. When `null`, the `volumes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.step.volumes.new](#fn-buildbuildvolumesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `step` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.build.step.new` constructs a new object with attributes and blocks configured for the `step`\nTerraform sub block.\n\n\n\n**Args**:\n - `args` (`list`): A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, the args\nare used as arguments to that entrypoint. If the image does not define an\nentrypoint, the first element in args is used as the entrypoint, and the\nremainder will be used as arguments. When `null`, the `args` field will be omitted from the resulting object.\n - `dir` (`string`): Working directory to use when running this step's container.\n\nIf this value is a relative path, it is relative to the build's working\ndirectory. If this value is absolute, it may be outside the build's working\ndirectory, in which case the contents of the path may not be persisted\nacross build step executions, unless a 'volume' for that path is specified.\n\nIf the build specifies a 'RepoSource' with 'dir' and a step with a\n'dir',\nwhich specifies an absolute path, the 'RepoSource' 'dir' is ignored\nfor the step's execution. When `null`, the `dir` field will be omitted from the resulting object.\n - `entrypoint` (`string`): Entrypoint to be used instead of the build step image's\ndefault entrypoint.\nIf unset, the image's default entrypoint is used When `null`, the `entrypoint` field will be omitted from the resulting object.\n - `env` (`list`): A list of environment variable definitions to be used when\nrunning a step.\n\nThe elements are of the form "KEY=VALUE" for the environment variable\n"KEY" being given the value "VALUE". When `null`, the `env` field will be omitted from the resulting object.\n - `name` (`string`): The name of the container image that will run this particular build step.\n\nIf the image is available in the host's Docker daemon's cache, it will be\nrun directly. If not, the host will attempt to pull the image first, using\nthe builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps (see https://github.com/GoogleCloudPlatform/cloud-builders\nfor images and examples).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like "ubuntu", "debian", but they will be refreshed at the time\nyou attempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.\n - `script` (`string`): A shell script to be executed in the step.\nWhen script is provided, the user cannot specify the entrypoint or args. When `null`, the `script` field will be omitted from the resulting object.\n - `secret_env` (`list`): A list of environment variables which are encrypted using\na Cloud Key\nManagement Service crypto key. These values must be specified in\nthe build's 'Secret'. When `null`, the `secret_env` field will be omitted from the resulting object.\n - `timeout` (`string`): Time limit for executing this build step. If not defined,\nthe step has no\ntime limit and will be allowed to continue to run until either it\ncompletes or the build itself times out. When `null`, the `timeout` field will be omitted from the resulting object.\n - `timing` (`string`): Output only. Stores timing information for executing this\nbuild step. When `null`, the `timing` field will be omitted from the resulting object.\n - `wait_for` (`list`): The ID(s) of the step(s) that this build step depends on.\n\nThis build step will not start until all the build steps in 'wait_for'\nhave completed successfully. If 'wait_for' is empty, this build step\nwill start when all previous build steps in the 'Build.Steps' list\nhave completed successfully. When `null`, the `wait_for` field will be omitted from the resulting object.\n - `volumes` (`list[obj]`): List of volumes to mount into the build step.\n\nEach volume is created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents\nare discarded.\n\nUsing a named volume in only one step is not valid as it is\nindicative of a build request with an incorrect configuration. When `null`, the `volumes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.step.volumes.new](#fn-buildbuildvolumesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `step` sub block.\n', args=[]), new( name, args=null, @@ -251,7 +251,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, git_file_source:: { - '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.git_file_source.new` constructs a new object with attributes and blocks configured for the `git_file_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `github_enterprise_config` (`string`): The full resource name of the github enterprise config.\nFormat: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}. projects/{project}/githubEnterpriseConfigs/{id}. When `null`, the `github_enterprise_config` field will be omitted from the resulting object.\n - `path` (`string`): The path of the file, with the repo root as the root of the path.\n - `repo_type` (`string`): The type of the repo, since it may not be explicit from the repo field (e.g from a URL). \nValues can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER Possible values: ["UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET_SERVER"]\n - `revision` (`string`): The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the \nfilename (optional). This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions \nIf unspecified, the revision from which the trigger invocation originated is assumed to be the revision from which to read the specified path. When `null`, the `revision` field will be omitted from the resulting object.\n - `uri` (`string`): The URI of the repo (optional). If unspecified, the repo from which the trigger \ninvocation originated is assumed to be the repo from which to read the specified path. When `null`, the `uri` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `git_file_source` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.git_file_source.new` constructs a new object with attributes and blocks configured for the `git_file_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `github_enterprise_config` (`string`): The full resource name of the github enterprise config.\nFormat: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}. projects/{project}/githubEnterpriseConfigs/{id}. When `null`, the `github_enterprise_config` field will be omitted from the resulting object.\n - `path` (`string`): The path of the file, with the repo root as the root of the path.\n - `repo_type` (`string`): The type of the repo, since it may not be explicit from the repo field (e.g from a URL).\nValues can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER Possible values: ["UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET_SERVER"]\n - `revision` (`string`): The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the\nfilename (optional). This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions\nIf unspecified, the revision from which the trigger invocation originated is assumed to be the revision from which to read the specified path. When `null`, the `revision` field will be omitted from the resulting object.\n - `uri` (`string`): The URI of the repo (optional). If unspecified, the repo from which the trigger\ninvocation originated is assumed to be the repo from which to read the specified path. When `null`, the `uri` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `git_file_source` sub block.\n', args=[]), new( path, repo_type, @@ -306,7 +306,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help="\n`google-beta.google_cloudbuild_trigger.new` injects a new `google-beta_google_cloudbuild_trigger` 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-beta.google_cloudbuild_trigger.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloudbuild_trigger` using the reference:\n\n $._ref.google-beta_google_cloudbuild_trigger.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloudbuild_trigger.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`): Human-readable description of the trigger. When `null`, the `description` field will be omitted from the resulting object.\n - `disabled` (`bool`): Whether the trigger is disabled or not. If true, the trigger will never result in a build. When `null`, the `disabled` field will be omitted from the resulting object.\n - `filename` (`string`): Path, from the source root, to a file whose contents is used for the template. \nEither a filename or build template must be provided. Set this only when using trigger_template or github.\nWhen using Pub/Sub, Webhook or Manual set the file name using git_file_source instead. When `null`, the `filename` field will be omitted from the resulting object.\n - `filter` (`string`): A Common Expression Language string. Used only with Pub/Sub and Webhook. When `null`, the `filter` field will be omitted from the resulting object.\n - `ignored_files` (`list`): ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match\nextended with support for \u0026#39;**\u0026#39;.\n\nIf ignoredFiles and changed files are both empty, then they are not\nused to determine whether or not to trigger a build.\n\nIf ignoredFiles is not empty, then we ignore any files that match any\nof the ignored_file globs. If the change has no files that are outside\nof the ignoredFiles globs, then we do not trigger a build. When `null`, the `ignored_files` field will be omitted from the resulting object.\n - `include_build_logs` (`string`): Build logs will be sent back to GitHub as part of the checkrun\nresult. Values can be INCLUDE_BUILD_LOGS_UNSPECIFIED or\nINCLUDE_BUILD_LOGS_WITH_STATUS Possible values: [\u0026#34;INCLUDE_BUILD_LOGS_UNSPECIFIED\u0026#34;, \u0026#34;INCLUDE_BUILD_LOGS_WITH_STATUS\u0026#34;] When `null`, the `include_build_logs` field will be omitted from the resulting object.\n - `included_files` (`list`): ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match\nextended with support for \u0026#39;**\u0026#39;.\n\nIf any of the files altered in the commit pass the ignoredFiles filter\nand includedFiles is empty, then as far as this filter is concerned, we\nshould trigger the build.\n\nIf any of the files altered in the commit pass the ignoredFiles filter\nand includedFiles is not empty, then we make sure that at least one of\nthose files matches a includedFiles glob. If not, then we do not trigger\na build. When `null`, the `included_files` field will be omitted from the resulting object.\n - `location` (`string`): The [Cloud Build location](https://cloud.google.com/build/docs/locations) for the trigger.\nIf not specified, \u0026#34;global\u0026#34; is used. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the trigger. Must be unique within the project. When `null`, the `name` 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 - `service_account` (`string`): The service account used for all user-controlled operations including\ntriggers.patch, triggers.run, builds.create, and builds.cancel.\n\nIf no service account is set, then the standard Cloud Build service account\n([PROJECT_NUM]@system.gserviceaccount.com) will be used instead.\n\nFormat: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL} When `null`, the `service_account` field will be omitted from the resulting object.\n - `substitutions` (`obj`): Substitutions data for Build resource. When `null`, the `substitutions` field will be omitted from the resulting object.\n - `tags` (`list`): Tags for annotation of a BuildTrigger When `null`, the `tags` field will be omitted from the resulting object.\n - `approval_config` (`list[obj]`): Configuration for manual approval to start a build invocation of this BuildTrigger. \nBuilds created by this trigger will require approval before they execute. \nAny user with a Cloud Build Approver role for the project can approve a build. When `null`, the `approval_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-beta.google_cloudbuild_trigger.approval_config.new](#fn-approval_confignew) constructor.\n - `bitbucket_server_trigger_config` (`list[obj]`): BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. When `null`, the `bitbucket_server_trigger_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-beta.google_cloudbuild_trigger.bitbucket_server_trigger_config.new](#fn-bitbucket_server_trigger_confignew) constructor.\n - `build` (`list[obj]`): Contents of the build template. Either a filename or build template must be provided. When `null`, the `build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.new](#fn-buildnew) constructor.\n - `git_file_source` (`list[obj]`): The file source describing the local or remote Build template. When `null`, the `git_file_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-beta.google_cloudbuild_trigger.git_file_source.new](#fn-git_file_sourcenew) constructor.\n - `github` (`list[obj]`): Describes the configuration of a trigger that creates a build whenever a GitHub event is received.\n\nOne of \u0026#39;trigger_template\u0026#39;, \u0026#39;github\u0026#39;, \u0026#39;pubsub_config\u0026#39; or \u0026#39;webhook_config\u0026#39; must be provided. When `null`, the `github` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.github.new](#fn-githubnew) constructor.\n - `pubsub_config` (`list[obj]`): PubsubConfig describes the configuration of a trigger that creates \na build whenever a Pub/Sub message is published.\n\nOne of \u0026#39;trigger_template\u0026#39;, \u0026#39;github\u0026#39;, \u0026#39;pubsub_config\u0026#39; \u0026#39;webhook_config\u0026#39; or \u0026#39;source_to_build\u0026#39; must be provided. When `null`, the `pubsub_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-beta.google_cloudbuild_trigger.pubsub_config.new](#fn-pubsub_confignew) constructor.\n - `repository_event_config` (`list[obj]`): The configuration of a trigger that creates a build whenever an event from Repo API is received. When `null`, the `repository_event_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-beta.google_cloudbuild_trigger.repository_event_config.new](#fn-repository_event_confignew) constructor.\n - `source_to_build` (`list[obj]`): The repo and ref of the repository from which to build. \nThis field is used only for those triggers that do not respond to SCM events. \nTriggers that respond to such events build source at whatever commit caused the event. \nThis field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers.\n\nOne of \u0026#39;trigger_template\u0026#39;, \u0026#39;github\u0026#39;, \u0026#39;pubsub_config\u0026#39; \u0026#39;webhook_config\u0026#39; or \u0026#39;source_to_build\u0026#39; must be provided. When `null`, the `source_to_build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.source_to_build.new](#fn-source_to_buildnew) 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-beta.google_cloudbuild_trigger.timeouts.new](#fn-timeoutsnew) constructor.\n - `trigger_template` (`list[obj]`): Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular\nexpression will trigger a build.\n\nOne of \u0026#39;trigger_template\u0026#39;, \u0026#39;github\u0026#39;, \u0026#39;pubsub_config\u0026#39;, \u0026#39;webhook_config\u0026#39; or \u0026#39;source_to_build\u0026#39; must be provided. When `null`, the `trigger_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.trigger_template.new](#fn-trigger_templatenew) constructor.\n - `webhook_config` (`list[obj]`): WebhookConfig describes the configuration of a trigger that creates \na build whenever a webhook is sent to a trigger\u0026#39;s webhook URL.\n\nOne of \u0026#39;trigger_template\u0026#39;, \u0026#39;github\u0026#39;, \u0026#39;pubsub_config\u0026#39; \u0026#39;webhook_config\u0026#39; or \u0026#39;source_to_build\u0026#39; must be provided. When `null`, the `webhook_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-beta.google_cloudbuild_trigger.webhook_config.new](#fn-webhook_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-beta.google_cloudbuild_trigger.new` injects a new `google-beta_google_cloudbuild_trigger` 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-beta.google_cloudbuild_trigger.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_cloudbuild_trigger` using the reference:\n\n $._ref.google-beta_google_cloudbuild_trigger.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_cloudbuild_trigger.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`): Human-readable description of the trigger. When `null`, the `description` field will be omitted from the resulting object.\n - `disabled` (`bool`): Whether the trigger is disabled or not. If true, the trigger will never result in a build. When `null`, the `disabled` field will be omitted from the resulting object.\n - `filename` (`string`): Path, from the source root, to a file whose contents is used for the template.\nEither a filename or build template must be provided. Set this only when using trigger_template or github.\nWhen using Pub/Sub, Webhook or Manual set the file name using git_file_source instead. When `null`, the `filename` field will be omitted from the resulting object.\n - `filter` (`string`): A Common Expression Language string. Used only with Pub/Sub and Webhook. When `null`, the `filter` field will be omitted from the resulting object.\n - `ignored_files` (`list`): ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match\nextended with support for \u0026#39;**\u0026#39;.\n\nIf ignoredFiles and changed files are both empty, then they are not\nused to determine whether or not to trigger a build.\n\nIf ignoredFiles is not empty, then we ignore any files that match any\nof the ignored_file globs. If the change has no files that are outside\nof the ignoredFiles globs, then we do not trigger a build. When `null`, the `ignored_files` field will be omitted from the resulting object.\n - `include_build_logs` (`string`): Build logs will be sent back to GitHub as part of the checkrun\nresult. Values can be INCLUDE_BUILD_LOGS_UNSPECIFIED or\nINCLUDE_BUILD_LOGS_WITH_STATUS Possible values: [\u0026#34;INCLUDE_BUILD_LOGS_UNSPECIFIED\u0026#34;, \u0026#34;INCLUDE_BUILD_LOGS_WITH_STATUS\u0026#34;] When `null`, the `include_build_logs` field will be omitted from the resulting object.\n - `included_files` (`list`): ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match\nextended with support for \u0026#39;**\u0026#39;.\n\nIf any of the files altered in the commit pass the ignoredFiles filter\nand includedFiles is empty, then as far as this filter is concerned, we\nshould trigger the build.\n\nIf any of the files altered in the commit pass the ignoredFiles filter\nand includedFiles is not empty, then we make sure that at least one of\nthose files matches a includedFiles glob. If not, then we do not trigger\na build. When `null`, the `included_files` field will be omitted from the resulting object.\n - `location` (`string`): The [Cloud Build location](https://cloud.google.com/build/docs/locations) for the trigger.\nIf not specified, \u0026#34;global\u0026#34; is used. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the trigger. Must be unique within the project. When `null`, the `name` 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 - `service_account` (`string`): The service account used for all user-controlled operations including\ntriggers.patch, triggers.run, builds.create, and builds.cancel.\n\nIf no service account is set, then the standard Cloud Build service account\n([PROJECT_NUM]@system.gserviceaccount.com) will be used instead.\n\nFormat: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL} When `null`, the `service_account` field will be omitted from the resulting object.\n - `substitutions` (`obj`): Substitutions data for Build resource. When `null`, the `substitutions` field will be omitted from the resulting object.\n - `tags` (`list`): Tags for annotation of a BuildTrigger When `null`, the `tags` field will be omitted from the resulting object.\n - `approval_config` (`list[obj]`): Configuration for manual approval to start a build invocation of this BuildTrigger.\nBuilds created by this trigger will require approval before they execute.\nAny user with a Cloud Build Approver role for the project can approve a build. When `null`, the `approval_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-beta.google_cloudbuild_trigger.approval_config.new](#fn-approval_confignew) constructor.\n - `bitbucket_server_trigger_config` (`list[obj]`): BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. When `null`, the `bitbucket_server_trigger_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-beta.google_cloudbuild_trigger.bitbucket_server_trigger_config.new](#fn-bitbucket_server_trigger_confignew) constructor.\n - `build` (`list[obj]`): Contents of the build template. Either a filename or build template must be provided. When `null`, the `build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.new](#fn-buildnew) constructor.\n - `git_file_source` (`list[obj]`): The file source describing the local or remote Build template. When `null`, the `git_file_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-beta.google_cloudbuild_trigger.git_file_source.new](#fn-git_file_sourcenew) constructor.\n - `github` (`list[obj]`): Describes the configuration of a trigger that creates a build whenever a GitHub event is received.\n\nOne of \u0026#39;trigger_template\u0026#39;, \u0026#39;github\u0026#39;, \u0026#39;pubsub_config\u0026#39; or \u0026#39;webhook_config\u0026#39; must be provided. When `null`, the `github` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.github.new](#fn-githubnew) constructor.\n - `pubsub_config` (`list[obj]`): PubsubConfig describes the configuration of a trigger that creates\na build whenever a Pub/Sub message is published.\n\nOne of \u0026#39;trigger_template\u0026#39;, \u0026#39;github\u0026#39;, \u0026#39;pubsub_config\u0026#39; \u0026#39;webhook_config\u0026#39; or \u0026#39;source_to_build\u0026#39; must be provided. When `null`, the `pubsub_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-beta.google_cloudbuild_trigger.pubsub_config.new](#fn-pubsub_confignew) constructor.\n - `repository_event_config` (`list[obj]`): The configuration of a trigger that creates a build whenever an event from Repo API is received. When `null`, the `repository_event_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-beta.google_cloudbuild_trigger.repository_event_config.new](#fn-repository_event_confignew) constructor.\n - `source_to_build` (`list[obj]`): The repo and ref of the repository from which to build.\nThis field is used only for those triggers that do not respond to SCM events.\nTriggers that respond to such events build source at whatever commit caused the event.\nThis field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers.\n\nOne of \u0026#39;trigger_template\u0026#39;, \u0026#39;github\u0026#39;, \u0026#39;pubsub_config\u0026#39; \u0026#39;webhook_config\u0026#39; or \u0026#39;source_to_build\u0026#39; must be provided. When `null`, the `source_to_build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.source_to_build.new](#fn-source_to_buildnew) 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-beta.google_cloudbuild_trigger.timeouts.new](#fn-timeoutsnew) constructor.\n - `trigger_template` (`list[obj]`): Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular\nexpression will trigger a build.\n\nOne of \u0026#39;trigger_template\u0026#39;, \u0026#39;github\u0026#39;, \u0026#39;pubsub_config\u0026#39;, \u0026#39;webhook_config\u0026#39; or \u0026#39;source_to_build\u0026#39; must be provided. When `null`, the `trigger_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.trigger_template.new](#fn-trigger_templatenew) constructor.\n - `webhook_config` (`list[obj]`): WebhookConfig describes the configuration of a trigger that creates\na build whenever a webhook is sent to a trigger\u0026#39;s webhook URL.\n\nOne of \u0026#39;trigger_template\u0026#39;, \u0026#39;github\u0026#39;, \u0026#39;pubsub_config\u0026#39; \u0026#39;webhook_config\u0026#39; or \u0026#39;source_to_build\u0026#39; must be provided. When `null`, the `webhook_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-beta.google_cloudbuild_trigger.webhook_config.new](#fn-webhook_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, approval_config=null, @@ -365,7 +365,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloudbuild_trigger`\nTerraform resource.\n\nUnlike [google-beta.google_cloudbuild_trigger.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`): Human-readable description of the trigger. When `null`, the `description` field will be omitted from the resulting object.\n - `disabled` (`bool`): Whether the trigger is disabled or not. If true, the trigger will never result in a build. When `null`, the `disabled` field will be omitted from the resulting object.\n - `filename` (`string`): Path, from the source root, to a file whose contents is used for the template. \nEither a filename or build template must be provided. Set this only when using trigger_template or github.\nWhen using Pub/Sub, Webhook or Manual set the file name using git_file_source instead. When `null`, the `filename` field will be omitted from the resulting object.\n - `filter` (`string`): A Common Expression Language string. Used only with Pub/Sub and Webhook. When `null`, the `filter` field will be omitted from the resulting object.\n - `ignored_files` (`list`): ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match\nextended with support for '**'.\n\nIf ignoredFiles and changed files are both empty, then they are not\nused to determine whether or not to trigger a build.\n\nIf ignoredFiles is not empty, then we ignore any files that match any\nof the ignored_file globs. If the change has no files that are outside\nof the ignoredFiles globs, then we do not trigger a build. When `null`, the `ignored_files` field will be omitted from the resulting object.\n - `include_build_logs` (`string`): Build logs will be sent back to GitHub as part of the checkrun\nresult. Values can be INCLUDE_BUILD_LOGS_UNSPECIFIED or\nINCLUDE_BUILD_LOGS_WITH_STATUS Possible values: ["INCLUDE_BUILD_LOGS_UNSPECIFIED", "INCLUDE_BUILD_LOGS_WITH_STATUS"] When `null`, the `include_build_logs` field will be omitted from the resulting object.\n - `included_files` (`list`): ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match\nextended with support for '**'.\n\nIf any of the files altered in the commit pass the ignoredFiles filter\nand includedFiles is empty, then as far as this filter is concerned, we\nshould trigger the build.\n\nIf any of the files altered in the commit pass the ignoredFiles filter\nand includedFiles is not empty, then we make sure that at least one of\nthose files matches a includedFiles glob. If not, then we do not trigger\na build. When `null`, the `included_files` field will be omitted from the resulting object.\n - `location` (`string`): The [Cloud Build location](https://cloud.google.com/build/docs/locations) for the trigger.\nIf not specified, "global" is used. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the trigger. Must be unique within the project. When `null`, the `name` 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 - `service_account` (`string`): The service account used for all user-controlled operations including\ntriggers.patch, triggers.run, builds.create, and builds.cancel.\n\nIf no service account is set, then the standard Cloud Build service account\n([PROJECT_NUM]@system.gserviceaccount.com) will be used instead.\n\nFormat: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL} When `null`, the `service_account` field will be omitted from the resulting object.\n - `substitutions` (`obj`): Substitutions data for Build resource. When `null`, the `substitutions` field will be omitted from the resulting object.\n - `tags` (`list`): Tags for annotation of a BuildTrigger When `null`, the `tags` field will be omitted from the resulting object.\n - `approval_config` (`list[obj]`): Configuration for manual approval to start a build invocation of this BuildTrigger. \nBuilds created by this trigger will require approval before they execute. \nAny user with a Cloud Build Approver role for the project can approve a build. When `null`, the `approval_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-beta.google_cloudbuild_trigger.approval_config.new](#fn-approval_confignew) constructor.\n - `bitbucket_server_trigger_config` (`list[obj]`): BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. When `null`, the `bitbucket_server_trigger_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-beta.google_cloudbuild_trigger.bitbucket_server_trigger_config.new](#fn-bitbucket_server_trigger_confignew) constructor.\n - `build` (`list[obj]`): Contents of the build template. Either a filename or build template must be provided. When `null`, the `build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.new](#fn-buildnew) constructor.\n - `git_file_source` (`list[obj]`): The file source describing the local or remote Build template. When `null`, the `git_file_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-beta.google_cloudbuild_trigger.git_file_source.new](#fn-git_file_sourcenew) constructor.\n - `github` (`list[obj]`): Describes the configuration of a trigger that creates a build whenever a GitHub event is received.\n\nOne of 'trigger_template', 'github', 'pubsub_config' or 'webhook_config' must be provided. When `null`, the `github` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.github.new](#fn-githubnew) constructor.\n - `pubsub_config` (`list[obj]`): PubsubConfig describes the configuration of a trigger that creates \na build whenever a Pub/Sub message is published.\n\nOne of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `pubsub_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-beta.google_cloudbuild_trigger.pubsub_config.new](#fn-pubsub_confignew) constructor.\n - `repository_event_config` (`list[obj]`): The configuration of a trigger that creates a build whenever an event from Repo API is received. When `null`, the `repository_event_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-beta.google_cloudbuild_trigger.repository_event_config.new](#fn-repository_event_confignew) constructor.\n - `source_to_build` (`list[obj]`): The repo and ref of the repository from which to build. \nThis field is used only for those triggers that do not respond to SCM events. \nTriggers that respond to such events build source at whatever commit caused the event. \nThis field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers.\n\nOne of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `source_to_build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.source_to_build.new](#fn-source_to_buildnew) 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-beta.google_cloudbuild_trigger.timeouts.new](#fn-timeoutsnew) constructor.\n - `trigger_template` (`list[obj]`): Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular\nexpression will trigger a build.\n\nOne of 'trigger_template', 'github', 'pubsub_config', 'webhook_config' or 'source_to_build' must be provided. When `null`, the `trigger_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.trigger_template.new](#fn-trigger_templatenew) constructor.\n - `webhook_config` (`list[obj]`): WebhookConfig describes the configuration of a trigger that creates \na build whenever a webhook is sent to a trigger's webhook URL.\n\nOne of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `webhook_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-beta.google_cloudbuild_trigger.webhook_config.new](#fn-webhook_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 `google_cloudbuild_trigger` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_cloudbuild_trigger.newAttrs` constructs a new object with attributes and blocks configured for the `google_cloudbuild_trigger`\nTerraform resource.\n\nUnlike [google-beta.google_cloudbuild_trigger.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`): Human-readable description of the trigger. When `null`, the `description` field will be omitted from the resulting object.\n - `disabled` (`bool`): Whether the trigger is disabled or not. If true, the trigger will never result in a build. When `null`, the `disabled` field will be omitted from the resulting object.\n - `filename` (`string`): Path, from the source root, to a file whose contents is used for the template.\nEither a filename or build template must be provided. Set this only when using trigger_template or github.\nWhen using Pub/Sub, Webhook or Manual set the file name using git_file_source instead. When `null`, the `filename` field will be omitted from the resulting object.\n - `filter` (`string`): A Common Expression Language string. Used only with Pub/Sub and Webhook. When `null`, the `filter` field will be omitted from the resulting object.\n - `ignored_files` (`list`): ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match\nextended with support for '**'.\n\nIf ignoredFiles and changed files are both empty, then they are not\nused to determine whether or not to trigger a build.\n\nIf ignoredFiles is not empty, then we ignore any files that match any\nof the ignored_file globs. If the change has no files that are outside\nof the ignoredFiles globs, then we do not trigger a build. When `null`, the `ignored_files` field will be omitted from the resulting object.\n - `include_build_logs` (`string`): Build logs will be sent back to GitHub as part of the checkrun\nresult. Values can be INCLUDE_BUILD_LOGS_UNSPECIFIED or\nINCLUDE_BUILD_LOGS_WITH_STATUS Possible values: ["INCLUDE_BUILD_LOGS_UNSPECIFIED", "INCLUDE_BUILD_LOGS_WITH_STATUS"] When `null`, the `include_build_logs` field will be omitted from the resulting object.\n - `included_files` (`list`): ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match\nextended with support for '**'.\n\nIf any of the files altered in the commit pass the ignoredFiles filter\nand includedFiles is empty, then as far as this filter is concerned, we\nshould trigger the build.\n\nIf any of the files altered in the commit pass the ignoredFiles filter\nand includedFiles is not empty, then we make sure that at least one of\nthose files matches a includedFiles glob. If not, then we do not trigger\na build. When `null`, the `included_files` field will be omitted from the resulting object.\n - `location` (`string`): The [Cloud Build location](https://cloud.google.com/build/docs/locations) for the trigger.\nIf not specified, "global" is used. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the trigger. Must be unique within the project. When `null`, the `name` 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 - `service_account` (`string`): The service account used for all user-controlled operations including\ntriggers.patch, triggers.run, builds.create, and builds.cancel.\n\nIf no service account is set, then the standard Cloud Build service account\n([PROJECT_NUM]@system.gserviceaccount.com) will be used instead.\n\nFormat: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL} When `null`, the `service_account` field will be omitted from the resulting object.\n - `substitutions` (`obj`): Substitutions data for Build resource. When `null`, the `substitutions` field will be omitted from the resulting object.\n - `tags` (`list`): Tags for annotation of a BuildTrigger When `null`, the `tags` field will be omitted from the resulting object.\n - `approval_config` (`list[obj]`): Configuration for manual approval to start a build invocation of this BuildTrigger.\nBuilds created by this trigger will require approval before they execute.\nAny user with a Cloud Build Approver role for the project can approve a build. When `null`, the `approval_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-beta.google_cloudbuild_trigger.approval_config.new](#fn-approval_confignew) constructor.\n - `bitbucket_server_trigger_config` (`list[obj]`): BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. When `null`, the `bitbucket_server_trigger_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-beta.google_cloudbuild_trigger.bitbucket_server_trigger_config.new](#fn-bitbucket_server_trigger_confignew) constructor.\n - `build` (`list[obj]`): Contents of the build template. Either a filename or build template must be provided. When `null`, the `build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.new](#fn-buildnew) constructor.\n - `git_file_source` (`list[obj]`): The file source describing the local or remote Build template. When `null`, the `git_file_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-beta.google_cloudbuild_trigger.git_file_source.new](#fn-git_file_sourcenew) constructor.\n - `github` (`list[obj]`): Describes the configuration of a trigger that creates a build whenever a GitHub event is received.\n\nOne of 'trigger_template', 'github', 'pubsub_config' or 'webhook_config' must be provided. When `null`, the `github` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.github.new](#fn-githubnew) constructor.\n - `pubsub_config` (`list[obj]`): PubsubConfig describes the configuration of a trigger that creates\na build whenever a Pub/Sub message is published.\n\nOne of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `pubsub_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-beta.google_cloudbuild_trigger.pubsub_config.new](#fn-pubsub_confignew) constructor.\n - `repository_event_config` (`list[obj]`): The configuration of a trigger that creates a build whenever an event from Repo API is received. When `null`, the `repository_event_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-beta.google_cloudbuild_trigger.repository_event_config.new](#fn-repository_event_confignew) constructor.\n - `source_to_build` (`list[obj]`): The repo and ref of the repository from which to build.\nThis field is used only for those triggers that do not respond to SCM events.\nTriggers that respond to such events build source at whatever commit caused the event.\nThis field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers.\n\nOne of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `source_to_build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.source_to_build.new](#fn-source_to_buildnew) 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-beta.google_cloudbuild_trigger.timeouts.new](#fn-timeoutsnew) constructor.\n - `trigger_template` (`list[obj]`): Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular\nexpression will trigger a build.\n\nOne of 'trigger_template', 'github', 'pubsub_config', 'webhook_config' or 'source_to_build' must be provided. When `null`, the `trigger_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.trigger_template.new](#fn-trigger_templatenew) constructor.\n - `webhook_config` (`list[obj]`): WebhookConfig describes the configuration of a trigger that creates\na build whenever a webhook is sent to a trigger's webhook URL.\n\nOne of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `webhook_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-beta.google_cloudbuild_trigger.webhook_config.new](#fn-webhook_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 `google_cloudbuild_trigger` resource into the root Terraform configuration.\n', args=[]), newAttrs( approval_config=null, bitbucket_server_trigger_config=null, diff --git a/4.x/_gen/resources/cloudfunctions2_function.libsonnet b/4.x/_gen/resources/cloudfunctions2_function.libsonnet index 9ae4fedf..6bb67608 100644 --- a/4.x/_gen/resources/cloudfunctions2_function.libsonnet +++ b/4.x/_gen/resources/cloudfunctions2_function.libsonnet @@ -29,7 +29,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); storage_source: storage_source, }), repo_source:: { - '#new':: d.fn(help='\n`google-beta.google_cloudfunctions2_function.build_config.source.repo_source.new` constructs a new object with attributes and blocks configured for the `repo_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `branch_name` (`string`): Regex matching branches to build. When `null`, the `branch_name` field will be omitted from the resulting object.\n - `commit_sha` (`string`): Regex matching tags to build. When `null`, the `commit_sha` field will be omitted from the resulting object.\n - `dir` (`string`): Directory, relative to the source root, in which to run the build. When `null`, the `dir` field will be omitted from the resulting object.\n - `invert_regex` (`bool`): Only trigger a build if the revision regex does \nNOT match the revision regex. When `null`, the `invert_regex` field will be omitted from the resulting object.\n - `project_id` (`string`): ID of the project that owns the Cloud Source Repository. If omitted, the \nproject ID requesting the build is assumed. When `null`, the `project_id` field will be omitted from the resulting object.\n - `repo_name` (`string`): Name of the Cloud Source Repository. When `null`, the `repo_name` field will be omitted from the resulting object.\n - `tag_name` (`string`): Regex matching tags to build. When `null`, the `tag_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `repo_source` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloudfunctions2_function.build_config.source.repo_source.new` constructs a new object with attributes and blocks configured for the `repo_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `branch_name` (`string`): Regex matching branches to build. When `null`, the `branch_name` field will be omitted from the resulting object.\n - `commit_sha` (`string`): Regex matching tags to build. When `null`, the `commit_sha` field will be omitted from the resulting object.\n - `dir` (`string`): Directory, relative to the source root, in which to run the build. When `null`, the `dir` field will be omitted from the resulting object.\n - `invert_regex` (`bool`): Only trigger a build if the revision regex does\nNOT match the revision regex. When `null`, the `invert_regex` field will be omitted from the resulting object.\n - `project_id` (`string`): ID of the project that owns the Cloud Source Repository. If omitted, the\nproject ID requesting the build is assumed. When `null`, the `project_id` field will be omitted from the resulting object.\n - `repo_name` (`string`): Name of the Cloud Source Repository. When `null`, the `repo_name` field will be omitted from the resulting object.\n - `tag_name` (`string`): Regex matching tags to build. When `null`, the `tag_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `repo_source` sub block.\n', args=[]), new( branch_name=null, commit_sha=null, @@ -49,7 +49,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, storage_source:: { - '#new':: d.fn(help='\n`google-beta.google_cloudfunctions2_function.build_config.source.storage_source.new` constructs a new object with attributes and blocks configured for the `storage_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `bucket` (`string`): Google Cloud Storage bucket containing the source When `null`, the `bucket` field will be omitted from the resulting object.\n - `generation` (`number`): Google Cloud Storage generation for the object. If the generation \nis omitted, the latest generation will be used. When `null`, the `generation` field will be omitted from the resulting object.\n - `object` (`string`): Google Cloud Storage object containing the source. When `null`, the `object` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `storage_source` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_cloudfunctions2_function.build_config.source.storage_source.new` constructs a new object with attributes and blocks configured for the `storage_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `bucket` (`string`): Google Cloud Storage bucket containing the source When `null`, the `bucket` field will be omitted from the resulting object.\n - `generation` (`number`): Google Cloud Storage generation for the object. If the generation\nis omitted, the latest generation will be used. When `null`, the `generation` field will be omitted from the resulting object.\n - `object` (`string`): Google Cloud Storage object containing the source. When `null`, the `object` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `storage_source` sub block.\n', args=[]), new( bucket=null, generation=null, diff --git a/4.x/_gen/resources/compute_backend_service.libsonnet b/4.x/_gen/resources/compute_backend_service.libsonnet index 8469cd32..51741af1 100644 --- a/4.x/_gen/resources/compute_backend_service.libsonnet +++ b/4.x/_gen/resources/compute_backend_service.libsonnet @@ -31,6 +31,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, cdn_policy:: { + bypass_cache_on_request_headers:: { + '#new':: d.fn(help='\n`google-beta.google_compute_backend_service.cdn_policy.bypass_cache_on_request_headers.new` constructs a new object with attributes and blocks configured for the `bypass_cache_on_request_headers`\nTerraform sub block.\n\n\n\n**Args**:\n - `header_name` (`string`): The header field name to match on when bypassing cache. Values are case-insensitive.\n\n**Returns**:\n - An attribute object that represents the `bypass_cache_on_request_headers` sub block.\n', args=[]), + new( + header_name + ):: std.prune(a={ + header_name: header_name, + }), + }, cache_key_policy:: { '#new':: d.fn(help='\n`google-beta.google_compute_backend_service.cdn_policy.cache_key_policy.new` constructs a new object with attributes and blocks configured for the `cache_key_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `include_host` (`bool`): If true requests to different hosts will be cached separately. When `null`, the `include_host` field will be omitted from the resulting object.\n - `include_http_headers` (`list`): Allows HTTP request headers (by name) to be used in the\ncache key. When `null`, the `include_http_headers` field will be omitted from the resulting object.\n - `include_named_cookies` (`list`): Names of cookies to include in cache keys. When `null`, the `include_named_cookies` field will be omitted from the resulting object.\n - `include_protocol` (`bool`): If true, http and https requests will be cached separately. When `null`, the `include_protocol` field will be omitted from the resulting object.\n - `include_query_string` (`bool`): If true, include query string parameters in the cache key\naccording to query_string_whitelist and\nquery_string_blacklist. If neither is set, the entire query\nstring will be included.\n\nIf false, the query string will be excluded from the cache\nkey entirely. When `null`, the `include_query_string` field will be omitted from the resulting object.\n - `query_string_blacklist` (`list`): Names of query string parameters to exclude in cache keys.\n\nAll other parameters will be included. Either specify\nquery_string_whitelist or query_string_blacklist, not both.\n'&' and '=' will be percent encoded and not treated as\ndelimiters. When `null`, the `query_string_blacklist` field will be omitted from the resulting object.\n - `query_string_whitelist` (`list`): Names of query string parameters to include in cache keys.\n\nAll other parameters will be excluded. Either specify\nquery_string_whitelist or query_string_blacklist, not both.\n'&' and '=' will be percent encoded and not treated as\ndelimiters. When `null`, the `query_string_whitelist` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `cache_key_policy` sub block.\n', args=[]), new( @@ -61,8 +69,9 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ttl: ttl, }), }, - '#new':: d.fn(help='\n`google-beta.google_compute_backend_service.cdn_policy.new` constructs a new object with attributes and blocks configured for the `cdn_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `cache_mode` (`string`): Specifies the cache setting for all responses from this backend.\nThe possible values are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"] When `null`, the `cache_mode` field will be omitted from the resulting object.\n - `client_ttl` (`number`): Specifies the maximum allowed TTL for cached content served by this origin. When `null`, the `client_ttl` field will be omitted from the resulting object.\n - `default_ttl` (`number`): Specifies the default TTL for cached content served by this origin for responses\nthat do not have an existing valid TTL (max-age or s-max-age). When `null`, the `default_ttl` field will be omitted from the resulting object.\n - `max_ttl` (`number`): Specifies the maximum allowed TTL for cached content served by this origin. When `null`, the `max_ttl` field will be omitted from the resulting object.\n - `negative_caching` (`bool`): Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. When `null`, the `negative_caching` field will be omitted from the resulting object.\n - `serve_while_stale` (`number`): Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. When `null`, the `serve_while_stale` field will be omitted from the resulting object.\n - `signed_url_cache_max_age_sec` (`number`): Maximum number of seconds the response to a signed URL request\nwill be considered fresh, defaults to 1hr (3600s). After this\ntime period, the response will be revalidated before\nbeing served.\n\nWhen serving responses to signed URL requests, Cloud CDN will\ninternally behave as though all responses from this backend had a\n"Cache-Control: public, max-age=[TTL]" header, regardless of any\nexisting Cache-Control header. The actual headers served in\nresponses will not be altered. When `null`, the `signed_url_cache_max_age_sec` field will be omitted from the resulting object.\n - `cache_key_policy` (`list[obj]`): The CacheKeyPolicy for this CdnPolicy. When `null`, the `cache_key_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-beta.google_compute_backend_service.cdn_policy.cache_key_policy.new](#fn-cdn_policycache_key_policynew) constructor.\n - `negative_caching_policy` (`list[obj]`): Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy.\nOmitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs. When `null`, the `negative_caching_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-beta.google_compute_backend_service.cdn_policy.negative_caching_policy.new](#fn-cdn_policynegative_caching_policynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `cdn_policy` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_compute_backend_service.cdn_policy.new` constructs a new object with attributes and blocks configured for the `cdn_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `cache_mode` (`string`): Specifies the cache setting for all responses from this backend.\nThe possible values are: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL and CACHE_ALL_STATIC Possible values: ["USE_ORIGIN_HEADERS", "FORCE_CACHE_ALL", "CACHE_ALL_STATIC"] When `null`, the `cache_mode` field will be omitted from the resulting object.\n - `client_ttl` (`number`): Specifies the maximum allowed TTL for cached content served by this origin. When `null`, the `client_ttl` field will be omitted from the resulting object.\n - `default_ttl` (`number`): Specifies the default TTL for cached content served by this origin for responses\nthat do not have an existing valid TTL (max-age or s-max-age). When `null`, the `default_ttl` field will be omitted from the resulting object.\n - `max_ttl` (`number`): Specifies the maximum allowed TTL for cached content served by this origin. When `null`, the `max_ttl` field will be omitted from the resulting object.\n - `negative_caching` (`bool`): Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. When `null`, the `negative_caching` field will be omitted from the resulting object.\n - `serve_while_stale` (`number`): Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. When `null`, the `serve_while_stale` field will be omitted from the resulting object.\n - `signed_url_cache_max_age_sec` (`number`): Maximum number of seconds the response to a signed URL request\nwill be considered fresh, defaults to 1hr (3600s). After this\ntime period, the response will be revalidated before\nbeing served.\n\nWhen serving responses to signed URL requests, Cloud CDN will\ninternally behave as though all responses from this backend had a\n"Cache-Control: public, max-age=[TTL]" header, regardless of any\nexisting Cache-Control header. The actual headers served in\nresponses will not be altered. When `null`, the `signed_url_cache_max_age_sec` field will be omitted from the resulting object.\n - `bypass_cache_on_request_headers` (`list[obj]`): Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified.\nThe cache is bypassed for all cdnPolicy.cacheMode settings. When `null`, the `bypass_cache_on_request_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_backend_service.cdn_policy.bypass_cache_on_request_headers.new](#fn-cdn_policybypass_cache_on_request_headersnew) constructor.\n - `cache_key_policy` (`list[obj]`): The CacheKeyPolicy for this CdnPolicy. When `null`, the `cache_key_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-beta.google_compute_backend_service.cdn_policy.cache_key_policy.new](#fn-cdn_policycache_key_policynew) constructor.\n - `negative_caching_policy` (`list[obj]`): Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy.\nOmitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs. When `null`, the `negative_caching_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-beta.google_compute_backend_service.cdn_policy.negative_caching_policy.new](#fn-cdn_policynegative_caching_policynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `cdn_policy` sub block.\n', args=[]), new( + bypass_cache_on_request_headers=null, cache_key_policy=null, cache_mode=null, client_ttl=null, @@ -73,6 +82,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); serve_while_stale=null, signed_url_cache_max_age_sec=null ):: std.prune(a={ + bypass_cache_on_request_headers: bypass_cache_on_request_headers, cache_key_policy: cache_key_policy, cache_mode: cache_mode, client_ttl: client_ttl, diff --git a/4.x/_gen/resources/compute_disk.libsonnet b/4.x/_gen/resources/compute_disk.libsonnet index 6088ca67..2c6a5d1d 100644 --- a/4.x/_gen/resources/compute_disk.libsonnet +++ b/4.x/_gen/resources/compute_disk.libsonnet @@ -2,8 +2,16 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_compute_disk', url='', help='`google_compute_disk` represents the `google-beta_google_compute_disk` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + async_primary_disk:: { + '#new':: d.fn(help='\n`google-beta.google_compute_disk.async_primary_disk.new` constructs a new object with attributes and blocks configured for the `async_primary_disk`\nTerraform sub block.\n\n\n\n**Args**:\n - `disk` (`string`): Primary disk for asynchronous disk replication.\n\n**Returns**:\n - An attribute object that represents the `async_primary_disk` sub block.\n', args=[]), + new( + disk + ):: std.prune(a={ + disk: disk, + }), + }, disk_encryption_key:: { - '#new':: d.fn(help='\n`google-beta.google_compute_disk.disk_encryption_key.new` constructs a new object with attributes and blocks configured for the `disk_encryption_key`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_self_link` (`string`): The self link of the encryption key used to encrypt the disk. Also called KmsKeyName\nin the cloud console. Your project's Compute Engine System service account\n('service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com') must have\n'roles/cloudkms.cryptoKeyEncrypterDecrypter' to use this feature.\nSee https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encrypt_a_new_persistent_disk_with_your_own_keys When `null`, the `kms_key_self_link` field will be omitted from the resulting object.\n - `kms_key_service_account` (`string`): The service account used for the encryption request for the given KMS key.\nIf absent, the Compute Engine Service Agent service account is used. When `null`, the `kms_key_service_account` field will be omitted from the resulting object.\n - `raw_key` (`string`): Specifies a 256-bit customer-supplied encryption key, encoded in\nRFC 4648 base64 to either encrypt or decrypt this resource. When `null`, the `raw_key` field will be omitted from the resulting object.\n - `rsa_encrypted_key` (`string`): Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit \ncustomer-supplied encryption key to either encrypt or decrypt \nthis resource. You can provide either the rawKey or the rsaEncryptedKey. When `null`, the `rsa_encrypted_key` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `disk_encryption_key` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_compute_disk.disk_encryption_key.new` constructs a new object with attributes and blocks configured for the `disk_encryption_key`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_self_link` (`string`): The self link of the encryption key used to encrypt the disk. Also called KmsKeyName\nin the cloud console. Your project's Compute Engine System service account\n('service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com') must have\n'roles/cloudkms.cryptoKeyEncrypterDecrypter' to use this feature.\nSee https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encrypt_a_new_persistent_disk_with_your_own_keys When `null`, the `kms_key_self_link` field will be omitted from the resulting object.\n - `kms_key_service_account` (`string`): The service account used for the encryption request for the given KMS key.\nIf absent, the Compute Engine Service Agent service account is used. When `null`, the `kms_key_service_account` field will be omitted from the resulting object.\n - `raw_key` (`string`): Specifies a 256-bit customer-supplied encryption key, encoded in\nRFC 4648 base64 to either encrypt or decrypt this resource. When `null`, the `raw_key` field will be omitted from the resulting object.\n - `rsa_encrypted_key` (`string`): Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt\nthis resource. You can provide either the rawKey or the rsaEncryptedKey. When `null`, the `rsa_encrypted_key` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `disk_encryption_key` sub block.\n', args=[]), new( kms_key_self_link=null, kms_key_service_account=null, @@ -16,10 +24,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); rsa_encrypted_key: rsa_encrypted_key, }), }, - '#new':: d.fn(help="\n`google-beta.google_compute_disk.new` injects a new `google-beta_google_compute_disk` 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-beta.google_compute_disk.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_disk` using the reference:\n\n $._ref.google-beta_google_compute_disk.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_disk.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `image` (`string`): The image from which to initialize this disk. This can be\none of: the image\u0026#39;s \u0026#39;self_link\u0026#39;, \u0026#39;projects/{project}/global/images/{image}\u0026#39;,\n\u0026#39;projects/{project}/global/images/family/{family}\u0026#39;, \u0026#39;global/images/{image}\u0026#39;,\n\u0026#39;global/images/family/{family}\u0026#39;, \u0026#39;family/{family}\u0026#39;, \u0026#39;{project}/{family}\u0026#39;,\n\u0026#39;{project}/{image}\u0026#39;, \u0026#39;{family}\u0026#39;, or \u0026#39;{image}\u0026#39;. If referred by family, the\nimages names must include the family name. If they don\u0026#39;t, use the\n[google_compute_image data source](/docs/providers/google/d/compute_image.html).\nFor instance, the image \u0026#39;centos-6-v20180104\u0026#39; includes its family name \u0026#39;centos-6\u0026#39;.\nThese images can be referred by family name here. When `null`, the `image` field will be omitted from the resulting object.\n - `interface` (`string`): Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. When `null`, the `interface` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key-\u0026gt;value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `multi_writer` (`bool`): Indicates whether or not the disk can be read/write attached to more than one instance. When `null`, the `multi_writer` 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 - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller\u0026#39;s project. When `null`, the `physical_block_size_bytes` 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 - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk. When `null`, the `provisioned_iops` field will be omitted from the resulting object.\n - `resource_policies` (`list`): Resource policies applied to this disk for automatic snapshot creations.\n\n~\u0026gt;**NOTE** This value does not support updating the\nresource policy, as resource policies can not be updated more than\none at a time. Use\n[\u0026#39;google_compute_disk_resource_policy_attachment\u0026#39;](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_disk_resource_policy_attachment)\nto allow for updating the resource policy attached to the disk. When `null`, the `resource_policies` field will be omitted from the resulting object.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the \u0026#39;image\u0026#39; or\n\u0026#39;snapshot\u0026#39; parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with \u0026#39;image\u0026#39; or \u0026#39;snapshot\u0026#39;,\nthe value must not be less than the size of the image\nor the size of the snapshot.\n\n~\u0026gt;**NOTE** If you change the size, Terraform updates the disk size\nif upsizing is detected but recreates the disk if downsizing is requested.\nYou can add \u0026#39;lifecycle.prevent_destroy\u0026#39; in the config to prevent destroying\nand recreating. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. If the snapshot is in another\nproject than this disk, you must supply a full URL. For example, the\nfollowing are valid values:\n\n* \u0026#39;https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;global/snapshots/snapshot\u0026#39;\n* \u0026#39;snapshot\u0026#39; When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `source_image_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source image. Required if\nthe source image is protected by a customer-supplied encryption key. When `null`, the `source_image_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.source_image_encryption_key.new](#fn-source_image_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) 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-beta.google_compute_disk.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-beta.google_compute_disk.new` injects a new `google-beta_google_compute_disk` 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-beta.google_compute_disk.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_disk` using the reference:\n\n $._ref.google-beta_google_compute_disk.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_disk.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `image` (`string`): The image from which to initialize this disk. This can be\none of: the image\u0026#39;s \u0026#39;self_link\u0026#39;, \u0026#39;projects/{project}/global/images/{image}\u0026#39;,\n\u0026#39;projects/{project}/global/images/family/{family}\u0026#39;, \u0026#39;global/images/{image}\u0026#39;,\n\u0026#39;global/images/family/{family}\u0026#39;, \u0026#39;family/{family}\u0026#39;, \u0026#39;{project}/{family}\u0026#39;,\n\u0026#39;{project}/{image}\u0026#39;, \u0026#39;{family}\u0026#39;, or \u0026#39;{image}\u0026#39;. If referred by family, the\nimages names must include the family name. If they don\u0026#39;t, use the\n[google_compute_image data source](/docs/providers/google/d/compute_image.html).\nFor instance, the image \u0026#39;centos-6-v20180104\u0026#39; includes its family name \u0026#39;centos-6\u0026#39;.\nThese images can be referred by family name here. When `null`, the `image` field will be omitted from the resulting object.\n - `interface` (`string`): Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. When `null`, the `interface` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key-\u0026gt;value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `multi_writer` (`bool`): Indicates whether or not the disk can be read/write attached to more than one instance. When `null`, the `multi_writer` 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 - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller\u0026#39;s project. When `null`, the `physical_block_size_bytes` 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 - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk. When `null`, the `provisioned_iops` field will be omitted from the resulting object.\n - `resource_policies` (`list`): Resource policies applied to this disk for automatic snapshot creations.\n\n~\u0026gt;**NOTE** This value does not support updating the\nresource policy, as resource policies can not be updated more than\none at a time. Use\n[\u0026#39;google_compute_disk_resource_policy_attachment\u0026#39;](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_disk_resource_policy_attachment)\nto allow for updating the resource policy attached to the disk. When `null`, the `resource_policies` field will be omitted from the resulting object.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the \u0026#39;image\u0026#39; or\n\u0026#39;snapshot\u0026#39; parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with \u0026#39;image\u0026#39; or \u0026#39;snapshot\u0026#39;,\nthe value must not be less than the size of the image\nor the size of the snapshot.\n\n~\u0026gt;**NOTE** If you change the size, Terraform updates the disk size\nif upsizing is detected but recreates the disk if downsizing is requested.\nYou can add \u0026#39;lifecycle.prevent_destroy\u0026#39; in the config to prevent destroying\nand recreating. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. If the snapshot is in another\nproject than this disk, you must supply a full URL. For example, the\nfollowing are valid values:\n\n* \u0026#39;https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;global/snapshots/snapshot\u0026#39;\n* \u0026#39;snapshot\u0026#39; When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `async_primary_disk` (`list[obj]`): A nested object resource When `null`, the `async_primary_disk` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.async_primary_disk.new](#fn-async_primary_disknew) constructor.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `source_image_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source image. Required if\nthe source image is protected by a customer-supplied encryption key. When `null`, the `source_image_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.source_image_encryption_key.new](#fn-source_image_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) 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-beta.google_compute_disk.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, + async_primary_disk=null, description=null, disk_encryption_key=null, image=null, @@ -43,6 +52,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='google_compute_disk', label=resourceLabel, attrs=self.newAttrs( + async_primary_disk=async_primary_disk, description=description, disk_encryption_key=disk_encryption_key, image=image, @@ -65,9 +75,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_disk.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_disk`\nTerraform resource.\n\nUnlike [google-beta.google_compute_disk.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `image` (`string`): The image from which to initialize this disk. This can be\none of: the image's 'self_link', 'projects/{project}/global/images/{image}',\n'projects/{project}/global/images/family/{family}', 'global/images/{image}',\n'global/images/family/{family}', 'family/{family}', '{project}/{family}',\n'{project}/{image}', '{family}', or '{image}'. If referred by family, the\nimages names must include the family name. If they don't, use the\n[google_compute_image data source](/docs/providers/google/d/compute_image.html).\nFor instance, the image 'centos-6-v20180104' includes its family name 'centos-6'.\nThese images can be referred by family name here. When `null`, the `image` field will be omitted from the resulting object.\n - `interface` (`string`): Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. When `null`, the `interface` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key->value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `multi_writer` (`bool`): Indicates whether or not the disk can be read/write attached to more than one instance. When `null`, the `multi_writer` 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 - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller's project. When `null`, the `physical_block_size_bytes` 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 - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk. When `null`, the `provisioned_iops` field will be omitted from the resulting object.\n - `resource_policies` (`list`): Resource policies applied to this disk for automatic snapshot creations.\n\n~>**NOTE** This value does not support updating the\nresource policy, as resource policies can not be updated more than\none at a time. Use\n['google_compute_disk_resource_policy_attachment'](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_disk_resource_policy_attachment)\nto allow for updating the resource policy attached to the disk. When `null`, the `resource_policies` field will be omitted from the resulting object.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the 'image' or\n'snapshot' parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with 'image' or 'snapshot',\nthe value must not be less than the size of the image\nor the size of the snapshot.\n\n~>**NOTE** If you change the size, Terraform updates the disk size\nif upsizing is detected but recreates the disk if downsizing is requested.\nYou can add 'lifecycle.prevent_destroy' in the config to prevent destroying\nand recreating. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. If the snapshot is in another\nproject than this disk, you must supply a full URL. For example, the\nfollowing are valid values:\n\n* 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot'\n* 'projects/project/global/snapshots/snapshot'\n* 'global/snapshots/snapshot'\n* 'snapshot' When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `source_image_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source image. Required if\nthe source image is protected by a customer-supplied encryption key. When `null`, the `source_image_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.source_image_encryption_key.new](#fn-source_image_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) 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-beta.google_compute_disk.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 `google_compute_disk` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_disk.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_disk`\nTerraform resource.\n\nUnlike [google-beta.google_compute_disk.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `image` (`string`): The image from which to initialize this disk. This can be\none of: the image's 'self_link', 'projects/{project}/global/images/{image}',\n'projects/{project}/global/images/family/{family}', 'global/images/{image}',\n'global/images/family/{family}', 'family/{family}', '{project}/{family}',\n'{project}/{image}', '{family}', or '{image}'. If referred by family, the\nimages names must include the family name. If they don't, use the\n[google_compute_image data source](/docs/providers/google/d/compute_image.html).\nFor instance, the image 'centos-6-v20180104' includes its family name 'centos-6'.\nThese images can be referred by family name here. When `null`, the `image` field will be omitted from the resulting object.\n - `interface` (`string`): Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. When `null`, the `interface` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key->value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `multi_writer` (`bool`): Indicates whether or not the disk can be read/write attached to more than one instance. When `null`, the `multi_writer` 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 - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller's project. When `null`, the `physical_block_size_bytes` 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 - `provisioned_iops` (`number`): Indicates how many IOPS must be provisioned for the disk. When `null`, the `provisioned_iops` field will be omitted from the resulting object.\n - `resource_policies` (`list`): Resource policies applied to this disk for automatic snapshot creations.\n\n~>**NOTE** This value does not support updating the\nresource policy, as resource policies can not be updated more than\none at a time. Use\n['google_compute_disk_resource_policy_attachment'](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_disk_resource_policy_attachment)\nto allow for updating the resource policy attached to the disk. When `null`, the `resource_policies` field will be omitted from the resulting object.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the 'image' or\n'snapshot' parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with 'image' or 'snapshot',\nthe value must not be less than the size of the image\nor the size of the snapshot.\n\n~>**NOTE** If you change the size, Terraform updates the disk size\nif upsizing is detected but recreates the disk if downsizing is requested.\nYou can add 'lifecycle.prevent_destroy' in the config to prevent destroying\nand recreating. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. If the snapshot is in another\nproject than this disk, you must supply a full URL. For example, the\nfollowing are valid values:\n\n* 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot'\n* 'projects/project/global/snapshots/snapshot'\n* 'global/snapshots/snapshot'\n* 'snapshot' When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `async_primary_disk` (`list[obj]`): A nested object resource When `null`, the `async_primary_disk` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.async_primary_disk.new](#fn-async_primary_disknew) constructor.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `source_image_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source image. Required if\nthe source image is protected by a customer-supplied encryption key. When `null`, the `source_image_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.source_image_encryption_key.new](#fn-source_image_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) 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-beta.google_compute_disk.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 `google_compute_disk` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, + async_primary_disk=null, description=null, disk_encryption_key=null, image=null, @@ -87,6 +98,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type=null, zone=null ):: std.prune(a={ + async_primary_disk: async_primary_disk, description: description, disk_encryption_key: disk_encryption_key, image: image, @@ -143,6 +155,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withAsyncPrimaryDisk':: d.fn(help='`google-beta.list[obj].withAsyncPrimaryDisk` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the async_primary_disk 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-beta.list[obj].withAsyncPrimaryDiskMixin](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 `async_primary_disk` field.\n', args=[]), + withAsyncPrimaryDisk(resourceLabel, value): { + resource+: { + google_compute_disk+: { + [resourceLabel]+: { + async_primary_disk: value, + }, + }, + }, + }, + '#withAsyncPrimaryDiskMixin':: d.fn(help='`google-beta.list[obj].withAsyncPrimaryDiskMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the async_primary_disk 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-beta.list[obj].withAsyncPrimaryDisk](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 `async_primary_disk` field.\n', args=[]), + withAsyncPrimaryDiskMixin(resourceLabel, value): { + resource+: { + google_compute_disk+: { + [resourceLabel]+: { + async_primary_disk+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withDescription':: d.fn(help='`google-beta.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+: { diff --git a/4.x/_gen/resources/compute_firewall_policy_rule.libsonnet b/4.x/_gen/resources/compute_firewall_policy_rule.libsonnet index ef7f929c..1acd05a3 100644 --- a/4.x/_gen/resources/compute_firewall_policy_rule.libsonnet +++ b/4.x/_gen/resources/compute_firewall_policy_rule.libsonnet @@ -13,18 +13,34 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ports: ports, }), }, - '#new':: d.fn(help='\n`google-beta.google_compute_firewall_policy_rule.match.new` constructs a new object with attributes and blocks configured for the `match`\nTerraform sub block.\n\n\n\n**Args**:\n - `dest_ip_ranges` (`list`): CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256. When `null`, the `dest_ip_ranges` field will be omitted from the resulting object.\n - `src_ip_ranges` (`list`): CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256. When `null`, the `src_ip_ranges` field will be omitted from the resulting object.\n - `layer4_configs` (`list[obj]`): Pairs of IP protocols and ports that the rule should match. When `null`, the `layer4_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_firewall_policy_rule.match.layer4_configs.new](#fn-matchlayer4_configsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `match` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_compute_firewall_policy_rule.match.new` constructs a new object with attributes and blocks configured for the `match`\nTerraform sub block.\n\n\n\n**Args**:\n - `dest_address_groups` (`list`): Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules. When `null`, the `dest_address_groups` field will be omitted from the resulting object.\n - `dest_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_fqdns` field will be omitted from the resulting object.\n - `dest_ip_ranges` (`list`): CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256. When `null`, the `dest_ip_ranges` field will be omitted from the resulting object.\n - `dest_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_region_codes` field will be omitted from the resulting object.\n - `dest_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `dest_threat_intelligences` field will be omitted from the resulting object.\n - `src_address_groups` (`list`): Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules. When `null`, the `src_address_groups` field will be omitted from the resulting object.\n - `src_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_fqdns` field will be omitted from the resulting object.\n - `src_ip_ranges` (`list`): CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256. When `null`, the `src_ip_ranges` field will be omitted from the resulting object.\n - `src_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_region_codes` field will be omitted from the resulting object.\n - `src_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `src_threat_intelligences` field will be omitted from the resulting object.\n - `layer4_configs` (`list[obj]`): Pairs of IP protocols and ports that the rule should match. When `null`, the `layer4_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_firewall_policy_rule.match.layer4_configs.new](#fn-matchlayer4_configsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `match` sub block.\n', args=[]), new( + dest_address_groups=null, + dest_fqdns=null, dest_ip_ranges=null, + dest_region_codes=null, + dest_threat_intelligences=null, layer4_configs=null, - src_ip_ranges=null + src_address_groups=null, + src_fqdns=null, + src_ip_ranges=null, + src_region_codes=null, + src_threat_intelligences=null ):: std.prune(a={ + dest_address_groups: dest_address_groups, + dest_fqdns: dest_fqdns, dest_ip_ranges: dest_ip_ranges, + dest_region_codes: dest_region_codes, + dest_threat_intelligences: dest_threat_intelligences, layer4_configs: layer4_configs, + src_address_groups: src_address_groups, + src_fqdns: src_fqdns, src_ip_ranges: src_ip_ranges, + src_region_codes: src_region_codes, + src_threat_intelligences: src_threat_intelligences, }), }, - '#new':: d.fn(help="\n`google-beta.google_compute_firewall_policy_rule.new` injects a new `google-beta_google_compute_firewall_policy_rule` 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-beta.google_compute_firewall_policy_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_firewall_policy_rule` using the reference:\n\n $._ref.google-beta_google_compute_firewall_policy_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_firewall_policy_rule.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 - `action` (`string`): The Action to perform when the client connection triggers the rule. Can currently be either \u0026#34;allow\u0026#34; or \u0026#34;deny()\u0026#34; where valid values for status are 403, 404, and 502.\n - `description` (`string`): An optional description for this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `direction` (`string`): The direction in which this rule applies. Possible values: INGRESS, EGRESS\n - `disabled` (`bool`): Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. When `null`, the `disabled` field will be omitted from the resulting object.\n - `enable_logging` (`bool`): Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \u0026#34;goto_next\u0026#34; rules. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `firewall_policy` (`string`): The firewall policy of the resource.\n - `priority` (`number`): An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.\n - `target_resources` (`list`): A list of network resource URLs to which this rule applies. This field allows you to control which network\u0026#39;s VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. When `null`, the `target_resources` field will be omitted from the resulting object.\n - `target_service_accounts` (`list`): A list of service accounts indicating the sets of instances that are applied with this rule. When `null`, the `target_service_accounts` field will be omitted from the resulting object.\n - `match` (`list[obj]`): A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding \u0026#39;action\u0026#39; is enforced. When `null`, the `match` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_firewall_policy_rule.match.new](#fn-matchnew) 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-beta.google_compute_firewall_policy_rule.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-beta.google_compute_firewall_policy_rule.new` injects a new `google-beta_google_compute_firewall_policy_rule` 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-beta.google_compute_firewall_policy_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_firewall_policy_rule` using the reference:\n\n $._ref.google-beta_google_compute_firewall_policy_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_firewall_policy_rule.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 - `action` (`string`): The Action to perform when the client connection triggers the rule. Valid actions are \u0026#34;allow\u0026#34;, \u0026#34;deny\u0026#34; and \u0026#34;goto_next\u0026#34;.\n - `description` (`string`): An optional description for this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `direction` (`string`): The direction in which this rule applies. Possible values: INGRESS, EGRESS\n - `disabled` (`bool`): Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. When `null`, the `disabled` field will be omitted from the resulting object.\n - `enable_logging` (`bool`): Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \u0026#34;goto_next\u0026#34; rules. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `firewall_policy` (`string`): The firewall policy of the resource.\n - `priority` (`number`): An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.\n - `target_resources` (`list`): A list of network resource URLs to which this rule applies. This field allows you to control which network\u0026#39;s VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. When `null`, the `target_resources` field will be omitted from the resulting object.\n - `target_service_accounts` (`list`): A list of service accounts indicating the sets of instances that are applied with this rule. When `null`, the `target_service_accounts` field will be omitted from the resulting object.\n - `match` (`list[obj]`): A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding \u0026#39;action\u0026#39; is enforced. When `null`, the `match` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_firewall_policy_rule.match.new](#fn-matchnew) 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-beta.google_compute_firewall_policy_rule.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, action, @@ -57,7 +73,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_firewall_policy_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_firewall_policy_rule`\nTerraform resource.\n\nUnlike [google-beta.google_compute_firewall_policy_rule.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 - `action` (`string`): The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.\n - `description` (`string`): An optional description for this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `direction` (`string`): The direction in which this rule applies. Possible values: INGRESS, EGRESS\n - `disabled` (`bool`): Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. When `null`, the `disabled` field will be omitted from the resulting object.\n - `enable_logging` (`bool`): Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `firewall_policy` (`string`): The firewall policy of the resource.\n - `priority` (`number`): An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.\n - `target_resources` (`list`): A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. When `null`, the `target_resources` field will be omitted from the resulting object.\n - `target_service_accounts` (`list`): A list of service accounts indicating the sets of instances that are applied with this rule. When `null`, the `target_service_accounts` field will be omitted from the resulting object.\n - `match` (`list[obj]`): A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. When `null`, the `match` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_firewall_policy_rule.match.new](#fn-matchnew) 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-beta.google_compute_firewall_policy_rule.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 `google_compute_firewall_policy_rule` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_firewall_policy_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_firewall_policy_rule`\nTerraform resource.\n\nUnlike [google-beta.google_compute_firewall_policy_rule.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 - `action` (`string`): The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".\n - `description` (`string`): An optional description for this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `direction` (`string`): The direction in which this rule applies. Possible values: INGRESS, EGRESS\n - `disabled` (`bool`): Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. When `null`, the `disabled` field will be omitted from the resulting object.\n - `enable_logging` (`bool`): Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `firewall_policy` (`string`): The firewall policy of the resource.\n - `priority` (`number`): An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.\n - `target_resources` (`list`): A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. When `null`, the `target_resources` field will be omitted from the resulting object.\n - `target_service_accounts` (`list`): A list of service accounts indicating the sets of instances that are applied with this rule. When `null`, the `target_service_accounts` field will be omitted from the resulting object.\n - `match` (`list[obj]`): A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. When `null`, the `match` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_firewall_policy_rule.match.new](#fn-matchnew) 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-beta.google_compute_firewall_policy_rule.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 `google_compute_firewall_policy_rule` resource into the root Terraform configuration.\n', args=[]), newAttrs( action, direction, diff --git a/4.x/_gen/resources/compute_forwarding_rule.libsonnet b/4.x/_gen/resources/compute_forwarding_rule.libsonnet index a470e034..b636a876 100644 --- a/4.x/_gen/resources/compute_forwarding_rule.libsonnet +++ b/4.x/_gen/resources/compute_forwarding_rule.libsonnet @@ -2,12 +2,13 @@ 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='google_compute_forwarding_rule', url='', help='`google_compute_forwarding_rule` represents the `google-beta_google_compute_forwarding_rule` 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-beta.google_compute_forwarding_rule.new` injects a new `google-beta_google_compute_forwarding_rule` 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-beta.google_compute_forwarding_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_forwarding_rule` using the reference:\n\n $._ref.google-beta_google_compute_forwarding_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_forwarding_rule.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 - `all_ports` (`bool`): This field is used along with the `backend_service` field for internal load balancing or with the `target` field for internal TargetInstance. This field cannot be used with `port` or `portRange` fields. When the load balancing scheme is `INTERNAL` and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. When `null`, the `all_ports` field will be omitted from the resulting object.\n - `allow_global_access` (`bool`): This field is used along with the `backend_service` field for internal load balancing or with the `target` field for internal TargetInstance. If the field is set to `TRUE`, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. When `null`, the `allow_global_access` field will be omitted from the resulting object.\n - `backend_service` (`string`): This field is only used for `INTERNAL` load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. When `null`, the `backend_service` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `ip_address` (`string`): IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don\u0026#39;t specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in `https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name` * Partial URL or by name, as in: * `projects/project_id/regions/region/addresses/address-name` * `regions/region/addresses/address-name` * `global/addresses/address-name` * `address-name` The loadBalancingScheme and the forwarding rule\u0026#39;s target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ip_protocol` (`string`): The IP protocol to which this rule applies. For protocol forwarding, valid options are `TCP`, `UDP`, `ESP`, `AH`, `SCTP` or `ICMP`. For Internal TCP/UDP Load Balancing, the load balancing scheme is `INTERNAL`, and one of `TCP` or `UDP` are valid. For Traffic Director, the load balancing scheme is `INTERNAL_SELF_MANAGED`, and only `TCP`is valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is `INTERNAL_MANAGED`, and only `TCP` is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is `EXTERNAL` and only `TCP` is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is `EXTERNAL`, and one of `TCP` or `UDP` is valid. When `null`, the `ip_protocol` field will be omitted from the resulting object.\n - `is_mirroring_collector` (`bool`): Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a `PacketMirroring` rule applies to them. This can only be set to true for load balancers that have their `loadBalancingScheme` set to `INTERNAL`. When `null`, the `is_mirroring_collector` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this rule. When `null`, the `labels` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Specifies the forwarding rule type.\n\n* `EXTERNAL` is used for:\n * Classic Cloud VPN gateways\n * Protocol forwarding to VMs from an external IP address\n * The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP\n* `INTERNAL` is used for:\n * Protocol forwarding to VMs from an internal IP address\n * Internal TCP/UDP load balancers\n* `INTERNAL_MANAGED` is used for:\n * Internal HTTP(S) load balancers\n* `INTERNAL_SELF_MANAGED` is used for:\n * Traffic Director\n* `EXTERNAL_MANAGED` is used for:\n * Global external HTTP(S) load balancers \n\nFor more information about forwarding rules, refer to [Forwarding rule concepts](/load-balancing/docs/forwarding-rule-concepts). Possible values: INVALID, INTERNAL, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED, EXTERNAL, EXTERNAL_MANAGED When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.\n - `network` (`string`): This field is not used for external load balancing. For `INTERNAL` and `INTERNAL_SELF_MANAGED` load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. When `null`, the `network` field will be omitted from the resulting object.\n - `network_tier` (`string`): This signifies the networking tier used for configuring this load balancer and can only take the following values: `PREMIUM`, `STANDARD`. For regional ForwardingRule, the valid values are `PREMIUM` and `STANDARD`. For GlobalForwardingRule, the valid value is `PREMIUM`. If this field is not specified, it is assumed to be `PREMIUM`. If `IPAddress` is specified, this value must be equal to the networkTier of the Address. When `null`, the `network_tier` field will be omitted from the resulting object.\n - `port_range` (`string`): When the load balancing scheme is `EXTERNAL`, `INTERNAL_SELF_MANAGED` and `INTERNAL_MANAGED`, you can specify a `port_range`. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the `target` field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when `IPProtocol` is `TCP`, `UDP`, or `SCTP`, only packets addressed to ports in the specified range will be forwarded to `target`. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports:\n\n* TargetHttpProxy: 80, 8080\n* TargetHttpsProxy: 443\n* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222\n* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222\n* TargetVpnGateway: 500, 4500\n\n@pattern: d\u0026#43;(?:-d\u0026#43;)? When `null`, the `port_range` field will be omitted from the resulting object.\n - `ports` (`list`): This field is used along with the `backend_service` field for internal load balancing. When the load balancing scheme is `INTERNAL`, a list of ports can be configured, for example, [\u0026#39;80\u0026#39;], [\u0026#39;8000\u0026#39;,\u0026#39;9000\u0026#39;]. Only packets addressed to these ports are forwarded to the backends configured with the forwarding rule. If the forwarding rule\u0026#39;s loadBalancingScheme is INTERNAL, you can specify ports in one of the following ways: * A list of up to five ports, which can be non-contiguous * Keyword `ALL`, which causes the forwarding rule to forward traffic on any port of the forwarding rule\u0026#39;s protocol. @pattern: d\u0026#43;(?:-d\u0026#43;)? For more information, refer to [Port specifications](/load-balancing/docs/forwarding-rule-concepts#port_specifications). When `null`, the `ports` field will be omitted from the resulting object.\n - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The location of this resource. When `null`, the `region` field will be omitted from the resulting object.\n - `service_label` (`string`): An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. When `null`, the `service_label` field will be omitted from the resulting object.\n - `subnetwork` (`string`): This field is only used for `INTERNAL` load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `target` (`string`): The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For `INTERNAL_SELF_MANAGED` load balancing, only `targetHttpProxy` is valid, not `targetHttpsProxy`. When `null`, the `target` field will be omitted from the resulting object.\n - `service_directory_registrations` (`list[obj]`): Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. When `null`, the `service_directory_registrations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_forwarding_rule.service_directory_registrations.new](#fn-service_directory_registrationsnew) 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-beta.google_compute_forwarding_rule.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-beta.google_compute_forwarding_rule.new` injects a new `google-beta_google_compute_forwarding_rule` 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-beta.google_compute_forwarding_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_forwarding_rule` using the reference:\n\n $._ref.google-beta_google_compute_forwarding_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_forwarding_rule.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 - `all_ports` (`bool`): This field can only be used:\n* If \u0026#39;IPProtocol\u0026#39; is one of TCP, UDP, or SCTP.\n* By internal TCP/UDP load balancers, backend service-based network load\nbalancers, and internal and external protocol forwarding.\n\n\nSet this field to true to allow packets addressed to any port or packets\nlacking destination port information (for example, UDP fragments after the\nfirst fragment) to be forwarded to the backends configured with this\nforwarding rule.\n\nThe \u0026#39;ports\u0026#39;, \u0026#39;port_range\u0026#39;, and\n\u0026#39;allPorts\u0026#39; fields are mutually exclusive. When `null`, the `all_ports` field will be omitted from the resulting object.\n - `allow_global_access` (`bool`): This field is used along with the \u0026#39;backend_service\u0026#39; field for\ninternal load balancing or with the \u0026#39;target\u0026#39; field for internal\nTargetInstance.\n\nIf the field is set to \u0026#39;TRUE\u0026#39;, clients can access ILB from all\nregions.\n\nOtherwise only allows access from clients in the same region as the\ninternal load balancer. When `null`, the `allow_global_access` field will be omitted from the resulting object.\n - `allow_psc_global_access` (`bool`): This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. When `null`, the `allow_psc_global_access` field will be omitted from the resulting object.\n - `backend_service` (`string`): Identifies the backend service to which the forwarding rule sends traffic.\n\nRequired for Internal TCP/UDP Load Balancing and Network Load Balancing;\nmust be omitted for all other load balancer types. When `null`, the `backend_service` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `ip_address` (`string`): IP address for which this forwarding rule accepts traffic. When a client\nsends traffic to this IP address, the forwarding rule directs the traffic\nto the referenced \u0026#39;target\u0026#39; or \u0026#39;backendService\u0026#39;.\n\nWhile creating a forwarding rule, specifying an \u0026#39;IPAddress\u0026#39; is\nrequired under the following circumstances:\n\n* When the \u0026#39;target\u0026#39; is set to \u0026#39;targetGrpcProxy\u0026#39; and\n\u0026#39;validateForProxyless\u0026#39; is set to \u0026#39;true\u0026#39;, the\n\u0026#39;IPAddress\u0026#39; should be set to \u0026#39;0.0.0.0\u0026#39;.\n* When the \u0026#39;target\u0026#39; is a Private Service Connect Google APIs\nbundle, you must specify an \u0026#39;IPAddress\u0026#39;.\n\n\nOtherwise, you can optionally specify an IP address that references an\nexisting static (reserved) IP address resource. When omitted, Google Cloud\nassigns an ephemeral IP address.\n\nUse one of the following formats to specify an IP address while creating a\nforwarding rule:\n\n* IP address number, as in \u0026#39;100.1.2.3\u0026#39;\n* IPv6 address range, as in \u0026#39;2600:1234::/96\u0026#39;\n* Full resource URL, as in\n\u0026#39;https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name\u0026#39;\n* Partial URL or by name, as in:\n * \u0026#39;projects/project_id/regions/region/addresses/address-name\u0026#39;\n * \u0026#39;regions/region/addresses/address-name\u0026#39;\n * \u0026#39;global/addresses/address-name\u0026#39;\n * \u0026#39;address-name\u0026#39;\n\n\nThe forwarding rule\u0026#39;s \u0026#39;target\u0026#39; or \u0026#39;backendService\u0026#39;,\nand in most cases, also the \u0026#39;loadBalancingScheme\u0026#39;, determine the\ntype of IP address that you can use. For detailed information, see\n[IP address\nspecifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n\nWhen reading an \u0026#39;IPAddress\u0026#39;, the API always returns the IP\naddress number. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ip_protocol` (`string`): The IP protocol to which this rule applies.\n\nFor protocol forwarding, valid\noptions are \u0026#39;TCP\u0026#39;, \u0026#39;UDP\u0026#39;, \u0026#39;ESP\u0026#39;,\n\u0026#39;AH\u0026#39;, \u0026#39;SCTP\u0026#39;, \u0026#39;ICMP\u0026#39; and\n\u0026#39;L3_DEFAULT\u0026#39;.\n\nThe valid IP protocols are different for different load balancing products\nas described in [Load balancing\nfeatures](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). Possible values: [\u0026#34;TCP\u0026#34;, \u0026#34;UDP\u0026#34;, \u0026#34;ESP\u0026#34;, \u0026#34;AH\u0026#34;, \u0026#34;SCTP\u0026#34;, \u0026#34;ICMP\u0026#34;, \u0026#34;L3_DEFAULT\u0026#34;] When `null`, the `ip_protocol` field will be omitted from the resulting object.\n - `is_mirroring_collector` (`bool`): Indicates whether or not this load balancer can be used as a collector for\npacket mirroring. To prevent mirroring loops, instances behind this\nload balancer will not have their traffic mirrored even if a\n\u0026#39;PacketMirroring\u0026#39; rule applies to them.\n\nThis can only be set to true for load balancers that have their\n\u0026#39;loadBalancingScheme\u0026#39; set to \u0026#39;INTERNAL\u0026#39;. When `null`, the `is_mirroring_collector` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this forwarding rule. A list of key-\u0026gt;value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Specifies the forwarding rule type.\n\nFor more information about forwarding rules, refer to\n[Forwarding rule concepts](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts). Default value: \u0026#34;EXTERNAL\u0026#34; Possible values: [\u0026#34;EXTERNAL\u0026#34;, \u0026#34;EXTERNAL_MANAGED\u0026#34;, \u0026#34;INTERNAL\u0026#34;, \u0026#34;INTERNAL_MANAGED\u0026#34;] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply with\n[RFC1035](https://www.ietf.org/rfc/rfc1035.txt).\n\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, the forwarding rule name must be a 1-20 characters string with\nlowercase letters and numbers and must start with a letter.\n - `network` (`string`): This field is not used for external load balancing.\n\nFor Internal TCP/UDP Load Balancing, this field identifies the network that\nthe load balanced IP should belong to for this Forwarding Rule.\nIf the subnetwork is specified, the network of the subnetwork will be used.\nIf neither subnetwork nor this field is specified, the default network will\nbe used.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, a network must be provided. When `null`, the `network` field will be omitted from the resulting object.\n - `network_tier` (`string`): This signifies the networking tier used for configuring\nthis load balancer and can only take the following values:\n\u0026#39;PREMIUM\u0026#39;, \u0026#39;STANDARD\u0026#39;.\n\nFor regional ForwardingRule, the valid values are \u0026#39;PREMIUM\u0026#39; and\n\u0026#39;STANDARD\u0026#39;. For GlobalForwardingRule, the valid value is\n\u0026#39;PREMIUM\u0026#39;.\n\nIf this field is not specified, it is assumed to be \u0026#39;PREMIUM\u0026#39;.\nIf \u0026#39;IPAddress\u0026#39; is specified, this value must be equal to the\nnetworkTier of the Address. Possible values: [\u0026#34;PREMIUM\u0026#34;, \u0026#34;STANDARD\u0026#34;] When `null`, the `network_tier` field will be omitted from the resulting object.\n - `port_range` (`string`): This field can only be used:\n\n* If \u0026#39;IPProtocol\u0026#39; is one of TCP, UDP, or SCTP.\n* By backend service-based network load balancers, target pool-based\nnetwork load balancers, internal proxy load balancers, external proxy load\nbalancers, Traffic Director, external protocol forwarding, and Classic VPN.\nSome products have restrictions on what ports can be used. See\n[port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications)\nfor details.\n\n\nOnly packets addressed to ports in the specified range will be forwarded to\nthe backends configured with this forwarding rule.\n\nThe \u0026#39;ports\u0026#39; and \u0026#39;port_range\u0026#39; fields are mutually exclusive.\n\nFor external forwarding rules, two or more forwarding rules cannot use the\nsame \u0026#39;[IPAddress, IPProtocol]\u0026#39; pair, and cannot have\noverlapping \u0026#39;portRange\u0026#39;s.\n\nFor internal forwarding rules within the same VPC network, two or more\nforwarding rules cannot use the same \u0026#39;[IPAddress, IPProtocol]\u0026#39;\npair, and cannot have overlapping \u0026#39;portRange\u0026#39;s. When `null`, the `port_range` field will be omitted from the resulting object.\n - `ports` (`list`): This field can only be used:\n\n* If \u0026#39;IPProtocol\u0026#39; is one of TCP, UDP, or SCTP.\n* By internal TCP/UDP load balancers, backend service-based network load\nbalancers, and internal protocol forwarding.\n\n\nYou can specify a list of up to five ports by number, separated by commas.\nThe ports can be contiguous or discontiguous. Only packets addressed to\nthese ports will be forwarded to the backends configured with this\nforwarding rule.\n\nFor external forwarding rules, two or more forwarding rules cannot use the\nsame \u0026#39;[IPAddress, IPProtocol]\u0026#39; pair, and cannot share any values\ndefined in \u0026#39;ports\u0026#39;.\n\nFor internal forwarding rules within the same VPC network, two or more\nforwarding rules cannot use the same \u0026#39;[IPAddress, IPProtocol]\u0026#39;\npair, and cannot share any values defined in \u0026#39;ports\u0026#39;.\n\nThe \u0026#39;ports\u0026#39; and \u0026#39;port_range\u0026#39; fields are mutually exclusive. When `null`, the `ports` 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 - `region` (`string`): A reference to the region where the regional forwarding rule resides.\n\nThis field is not applicable to global forwarding rules. When `null`, the `region` field will be omitted from the resulting object.\n - `service_label` (`string`): An optional prefix to the service name for this Forwarding Rule.\nIf specified, will be the first label of the fully qualified service\nname.\n\nThe label must be 1-63 characters long, and comply with RFC1035.\nSpecifically, the label must be 1-63 characters long and match the\nregular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the first\ncharacter must be a lowercase letter, and all following characters\nmust be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n\nThis field is only used for INTERNAL load balancing. When `null`, the `service_label` field will be omitted from the resulting object.\n - `source_ip_ranges` (`list`): If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). When `null`, the `source_ip_ranges` field will be omitted from the resulting object.\n - `subnetwork` (`string`): This field identifies the subnetwork that the load balanced IP should\nbelong to for this Forwarding Rule, used in internal load balancing and\nnetwork load balancing with IPv6.\n\nIf the network specified is in auto subnet mode, this field is optional.\nHowever, a subnetwork must be specified if the network is in custom subnet\nmode or when creating external forwarding rule with IPv6. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `target` (`string`): The URL of the target resource to receive the matched traffic. For\nregional forwarding rules, this target must be in the same region as the\nforwarding rule. For global forwarding rules, this target must be a global\nload balancing resource.\n\nThe forwarded traffic must be of a type appropriate to the target object.\n* For load balancers, see the \u0026#34;Target\u0026#34; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n* For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:\n * \u0026#39;vpc-sc\u0026#39; - [ APIs that support VPC Service Controls](https://cloud.google.com/vpc-service-controls/docs/supported-products).\n * \u0026#39;all-apis\u0026#39; - [All supported Google APIs](https://cloud.google.com/vpc/docs/private-service-connect#supported-apis).\n\n\nFor Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. When `null`, the `target` field will be omitted from the resulting object.\n - `service_directory_registrations` (`list[obj]`): Service Directory resources to register this forwarding rule with.\n\nCurrently, only supports a single Service Directory resource. When `null`, the `service_directory_registrations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_forwarding_rule.service_directory_registrations.new](#fn-service_directory_registrationsnew) 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-beta.google_compute_forwarding_rule.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, all_ports=null, allow_global_access=null, + allow_psc_global_access=null, backend_service=null, description=null, ip_address=null, @@ -23,6 +24,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); region=null, service_directory_registrations=null, service_label=null, + source_ip_ranges=null, subnetwork=null, target=null, timeouts=null, @@ -33,6 +35,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs( all_ports=all_ports, allow_global_access=allow_global_access, + allow_psc_global_access=allow_psc_global_access, backend_service=backend_service, description=description, ip_address=ip_address, @@ -49,17 +52,19 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); region=region, service_directory_registrations=service_directory_registrations, service_label=service_label, + source_ip_ranges=source_ip_ranges, subnetwork=subnetwork, target=target, timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_forwarding_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_forwarding_rule`\nTerraform resource.\n\nUnlike [google-beta.google_compute_forwarding_rule.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 - `all_ports` (`bool`): This field is used along with the `backend_service` field for internal load balancing or with the `target` field for internal TargetInstance. This field cannot be used with `port` or `portRange` fields. When the load balancing scheme is `INTERNAL` and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. When `null`, the `all_ports` field will be omitted from the resulting object.\n - `allow_global_access` (`bool`): This field is used along with the `backend_service` field for internal load balancing or with the `target` field for internal TargetInstance. If the field is set to `TRUE`, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. When `null`, the `allow_global_access` field will be omitted from the resulting object.\n - `backend_service` (`string`): This field is only used for `INTERNAL` load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. When `null`, the `backend_service` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `ip_address` (`string`): IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in `https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name` * Partial URL or by name, as in: * `projects/project_id/regions/region/addresses/address-name` * `regions/region/addresses/address-name` * `global/addresses/address-name` * `address-name` The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ip_protocol` (`string`): The IP protocol to which this rule applies. For protocol forwarding, valid options are `TCP`, `UDP`, `ESP`, `AH`, `SCTP` or `ICMP`. For Internal TCP/UDP Load Balancing, the load balancing scheme is `INTERNAL`, and one of `TCP` or `UDP` are valid. For Traffic Director, the load balancing scheme is `INTERNAL_SELF_MANAGED`, and only `TCP`is valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is `INTERNAL_MANAGED`, and only `TCP` is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is `EXTERNAL` and only `TCP` is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is `EXTERNAL`, and one of `TCP` or `UDP` is valid. When `null`, the `ip_protocol` field will be omitted from the resulting object.\n - `is_mirroring_collector` (`bool`): Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a `PacketMirroring` rule applies to them. This can only be set to true for load balancers that have their `loadBalancingScheme` set to `INTERNAL`. When `null`, the `is_mirroring_collector` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this rule. When `null`, the `labels` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Specifies the forwarding rule type.\n\n* `EXTERNAL` is used for:\n * Classic Cloud VPN gateways\n * Protocol forwarding to VMs from an external IP address\n * The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP\n* `INTERNAL` is used for:\n * Protocol forwarding to VMs from an internal IP address\n * Internal TCP/UDP load balancers\n* `INTERNAL_MANAGED` is used for:\n * Internal HTTP(S) load balancers\n* `INTERNAL_SELF_MANAGED` is used for:\n * Traffic Director\n* `EXTERNAL_MANAGED` is used for:\n * Global external HTTP(S) load balancers \n\nFor more information about forwarding rules, refer to [Forwarding rule concepts](/load-balancing/docs/forwarding-rule-concepts). Possible values: INVALID, INTERNAL, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED, EXTERNAL, EXTERNAL_MANAGED When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.\n - `network` (`string`): This field is not used for external load balancing. For `INTERNAL` and `INTERNAL_SELF_MANAGED` load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. When `null`, the `network` field will be omitted from the resulting object.\n - `network_tier` (`string`): This signifies the networking tier used for configuring this load balancer and can only take the following values: `PREMIUM`, `STANDARD`. For regional ForwardingRule, the valid values are `PREMIUM` and `STANDARD`. For GlobalForwardingRule, the valid value is `PREMIUM`. If this field is not specified, it is assumed to be `PREMIUM`. If `IPAddress` is specified, this value must be equal to the networkTier of the Address. When `null`, the `network_tier` field will be omitted from the resulting object.\n - `port_range` (`string`): When the load balancing scheme is `EXTERNAL`, `INTERNAL_SELF_MANAGED` and `INTERNAL_MANAGED`, you can specify a `port_range`. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the `target` field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when `IPProtocol` is `TCP`, `UDP`, or `SCTP`, only packets addressed to ports in the specified range will be forwarded to `target`. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports:\n\n* TargetHttpProxy: 80, 8080\n* TargetHttpsProxy: 443\n* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222\n* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222\n* TargetVpnGateway: 500, 4500\n\n@pattern: d+(?:-d+)? When `null`, the `port_range` field will be omitted from the resulting object.\n - `ports` (`list`): This field is used along with the `backend_service` field for internal load balancing. When the load balancing scheme is `INTERNAL`, a list of ports can be configured, for example, ['80'], ['8000','9000']. Only packets addressed to these ports are forwarded to the backends configured with the forwarding rule. If the forwarding rule's loadBalancingScheme is INTERNAL, you can specify ports in one of the following ways: * A list of up to five ports, which can be non-contiguous * Keyword `ALL`, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol. @pattern: d+(?:-d+)? For more information, refer to [Port specifications](/load-balancing/docs/forwarding-rule-concepts#port_specifications). When `null`, the `ports` field will be omitted from the resulting object.\n - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The location of this resource. When `null`, the `region` field will be omitted from the resulting object.\n - `service_label` (`string`): An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. When `null`, the `service_label` field will be omitted from the resulting object.\n - `subnetwork` (`string`): This field is only used for `INTERNAL` load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `target` (`string`): The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For `INTERNAL_SELF_MANAGED` load balancing, only `targetHttpProxy` is valid, not `targetHttpsProxy`. When `null`, the `target` field will be omitted from the resulting object.\n - `service_directory_registrations` (`list[obj]`): Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. When `null`, the `service_directory_registrations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_forwarding_rule.service_directory_registrations.new](#fn-service_directory_registrationsnew) 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-beta.google_compute_forwarding_rule.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 `google_compute_forwarding_rule` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_forwarding_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_forwarding_rule`\nTerraform resource.\n\nUnlike [google-beta.google_compute_forwarding_rule.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 - `all_ports` (`bool`): This field can only be used:\n* If 'IPProtocol' is one of TCP, UDP, or SCTP.\n* By internal TCP/UDP load balancers, backend service-based network load\nbalancers, and internal and external protocol forwarding.\n\n\nSet this field to true to allow packets addressed to any port or packets\nlacking destination port information (for example, UDP fragments after the\nfirst fragment) to be forwarded to the backends configured with this\nforwarding rule.\n\nThe 'ports', 'port_range', and\n'allPorts' fields are mutually exclusive. When `null`, the `all_ports` field will be omitted from the resulting object.\n - `allow_global_access` (`bool`): This field is used along with the 'backend_service' field for\ninternal load balancing or with the 'target' field for internal\nTargetInstance.\n\nIf the field is set to 'TRUE', clients can access ILB from all\nregions.\n\nOtherwise only allows access from clients in the same region as the\ninternal load balancer. When `null`, the `allow_global_access` field will be omitted from the resulting object.\n - `allow_psc_global_access` (`bool`): This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. When `null`, the `allow_psc_global_access` field will be omitted from the resulting object.\n - `backend_service` (`string`): Identifies the backend service to which the forwarding rule sends traffic.\n\nRequired for Internal TCP/UDP Load Balancing and Network Load Balancing;\nmust be omitted for all other load balancer types. When `null`, the `backend_service` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `ip_address` (`string`): IP address for which this forwarding rule accepts traffic. When a client\nsends traffic to this IP address, the forwarding rule directs the traffic\nto the referenced 'target' or 'backendService'.\n\nWhile creating a forwarding rule, specifying an 'IPAddress' is\nrequired under the following circumstances:\n\n* When the 'target' is set to 'targetGrpcProxy' and\n'validateForProxyless' is set to 'true', the\n'IPAddress' should be set to '0.0.0.0'.\n* When the 'target' is a Private Service Connect Google APIs\nbundle, you must specify an 'IPAddress'.\n\n\nOtherwise, you can optionally specify an IP address that references an\nexisting static (reserved) IP address resource. When omitted, Google Cloud\nassigns an ephemeral IP address.\n\nUse one of the following formats to specify an IP address while creating a\nforwarding rule:\n\n* IP address number, as in '100.1.2.3'\n* IPv6 address range, as in '2600:1234::/96'\n* Full resource URL, as in\n'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name'\n* Partial URL or by name, as in:\n * 'projects/project_id/regions/region/addresses/address-name'\n * 'regions/region/addresses/address-name'\n * 'global/addresses/address-name'\n * 'address-name'\n\n\nThe forwarding rule's 'target' or 'backendService',\nand in most cases, also the 'loadBalancingScheme', determine the\ntype of IP address that you can use. For detailed information, see\n[IP address\nspecifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n\nWhen reading an 'IPAddress', the API always returns the IP\naddress number. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ip_protocol` (`string`): The IP protocol to which this rule applies.\n\nFor protocol forwarding, valid\noptions are 'TCP', 'UDP', 'ESP',\n'AH', 'SCTP', 'ICMP' and\n'L3_DEFAULT'.\n\nThe valid IP protocols are different for different load balancing products\nas described in [Load balancing\nfeatures](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). Possible values: ["TCP", "UDP", "ESP", "AH", "SCTP", "ICMP", "L3_DEFAULT"] When `null`, the `ip_protocol` field will be omitted from the resulting object.\n - `is_mirroring_collector` (`bool`): Indicates whether or not this load balancer can be used as a collector for\npacket mirroring. To prevent mirroring loops, instances behind this\nload balancer will not have their traffic mirrored even if a\n'PacketMirroring' rule applies to them.\n\nThis can only be set to true for load balancers that have their\n'loadBalancingScheme' set to 'INTERNAL'. When `null`, the `is_mirroring_collector` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this forwarding rule. A list of key->value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Specifies the forwarding rule type.\n\nFor more information about forwarding rules, refer to\n[Forwarding rule concepts](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts). Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply with\n[RFC1035](https://www.ietf.org/rfc/rfc1035.txt).\n\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, the forwarding rule name must be a 1-20 characters string with\nlowercase letters and numbers and must start with a letter.\n - `network` (`string`): This field is not used for external load balancing.\n\nFor Internal TCP/UDP Load Balancing, this field identifies the network that\nthe load balanced IP should belong to for this Forwarding Rule.\nIf the subnetwork is specified, the network of the subnetwork will be used.\nIf neither subnetwork nor this field is specified, the default network will\nbe used.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, a network must be provided. When `null`, the `network` field will be omitted from the resulting object.\n - `network_tier` (`string`): This signifies the networking tier used for configuring\nthis load balancer and can only take the following values:\n'PREMIUM', 'STANDARD'.\n\nFor regional ForwardingRule, the valid values are 'PREMIUM' and\n'STANDARD'. For GlobalForwardingRule, the valid value is\n'PREMIUM'.\n\nIf this field is not specified, it is assumed to be 'PREMIUM'.\nIf 'IPAddress' is specified, this value must be equal to the\nnetworkTier of the Address. Possible values: ["PREMIUM", "STANDARD"] When `null`, the `network_tier` field will be omitted from the resulting object.\n - `port_range` (`string`): This field can only be used:\n\n* If 'IPProtocol' is one of TCP, UDP, or SCTP.\n* By backend service-based network load balancers, target pool-based\nnetwork load balancers, internal proxy load balancers, external proxy load\nbalancers, Traffic Director, external protocol forwarding, and Classic VPN.\nSome products have restrictions on what ports can be used. See\n[port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications)\nfor details.\n\n\nOnly packets addressed to ports in the specified range will be forwarded to\nthe backends configured with this forwarding rule.\n\nThe 'ports' and 'port_range' fields are mutually exclusive.\n\nFor external forwarding rules, two or more forwarding rules cannot use the\nsame '[IPAddress, IPProtocol]' pair, and cannot have\noverlapping 'portRange's.\n\nFor internal forwarding rules within the same VPC network, two or more\nforwarding rules cannot use the same '[IPAddress, IPProtocol]'\npair, and cannot have overlapping 'portRange's. When `null`, the `port_range` field will be omitted from the resulting object.\n - `ports` (`list`): This field can only be used:\n\n* If 'IPProtocol' is one of TCP, UDP, or SCTP.\n* By internal TCP/UDP load balancers, backend service-based network load\nbalancers, and internal protocol forwarding.\n\n\nYou can specify a list of up to five ports by number, separated by commas.\nThe ports can be contiguous or discontiguous. Only packets addressed to\nthese ports will be forwarded to the backends configured with this\nforwarding rule.\n\nFor external forwarding rules, two or more forwarding rules cannot use the\nsame '[IPAddress, IPProtocol]' pair, and cannot share any values\ndefined in 'ports'.\n\nFor internal forwarding rules within the same VPC network, two or more\nforwarding rules cannot use the same '[IPAddress, IPProtocol]'\npair, and cannot share any values defined in 'ports'.\n\nThe 'ports' and 'port_range' fields are mutually exclusive. When `null`, the `ports` 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 - `region` (`string`): A reference to the region where the regional forwarding rule resides.\n\nThis field is not applicable to global forwarding rules. When `null`, the `region` field will be omitted from the resulting object.\n - `service_label` (`string`): An optional prefix to the service name for this Forwarding Rule.\nIf specified, will be the first label of the fully qualified service\nname.\n\nThe label must be 1-63 characters long, and comply with RFC1035.\nSpecifically, the label must be 1-63 characters long and match the\nregular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first\ncharacter must be a lowercase letter, and all following characters\nmust be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n\nThis field is only used for INTERNAL load balancing. When `null`, the `service_label` field will be omitted from the resulting object.\n - `source_ip_ranges` (`list`): If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). When `null`, the `source_ip_ranges` field will be omitted from the resulting object.\n - `subnetwork` (`string`): This field identifies the subnetwork that the load balanced IP should\nbelong to for this Forwarding Rule, used in internal load balancing and\nnetwork load balancing with IPv6.\n\nIf the network specified is in auto subnet mode, this field is optional.\nHowever, a subnetwork must be specified if the network is in custom subnet\nmode or when creating external forwarding rule with IPv6. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `target` (`string`): The URL of the target resource to receive the matched traffic. For\nregional forwarding rules, this target must be in the same region as the\nforwarding rule. For global forwarding rules, this target must be a global\nload balancing resource.\n\nThe forwarded traffic must be of a type appropriate to the target object.\n* For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n* For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:\n * 'vpc-sc' - [ APIs that support VPC Service Controls](https://cloud.google.com/vpc-service-controls/docs/supported-products).\n * 'all-apis' - [All supported Google APIs](https://cloud.google.com/vpc/docs/private-service-connect#supported-apis).\n\n\nFor Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. When `null`, the `target` field will be omitted from the resulting object.\n - `service_directory_registrations` (`list[obj]`): Service Directory resources to register this forwarding rule with.\n\nCurrently, only supports a single Service Directory resource. When `null`, the `service_directory_registrations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_forwarding_rule.service_directory_registrations.new](#fn-service_directory_registrationsnew) 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-beta.google_compute_forwarding_rule.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 `google_compute_forwarding_rule` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, all_ports=null, allow_global_access=null, + allow_psc_global_access=null, backend_service=null, description=null, ip_address=null, @@ -75,12 +80,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); region=null, service_directory_registrations=null, service_label=null, + source_ip_ranges=null, subnetwork=null, target=null, timeouts=null ):: std.prune(a={ all_ports: all_ports, allow_global_access: allow_global_access, + allow_psc_global_access: allow_psc_global_access, backend_service: backend_service, description: description, ip_address: ip_address, @@ -97,6 +104,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); region: region, service_directory_registrations: service_directory_registrations, service_label: service_label, + source_ip_ranges: source_ip_ranges, subnetwork: subnetwork, target: target, timeouts: timeouts, @@ -143,6 +151,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withAllowPscGlobalAccess':: d.fn(help='`google-beta.bool.withAllowPscGlobalAccess` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the allow_psc_global_access 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 `allow_psc_global_access` field.\n', args=[]), + withAllowPscGlobalAccess(resourceLabel, value): { + resource+: { + google_compute_forwarding_rule+: { + [resourceLabel]+: { + allow_psc_global_access: value, + }, + }, + }, + }, '#withBackendService':: d.fn(help='`google-beta.string.withBackendService` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the backend_service 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 `backend_service` field.\n', args=[]), withBackendService(resourceLabel, value): { resource+: { @@ -313,6 +331,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSourceIpRanges':: d.fn(help='`google-beta.list.withSourceIpRanges` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the source_ip_ranges 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 `source_ip_ranges` field.\n', args=[]), + withSourceIpRanges(resourceLabel, value): { + resource+: { + google_compute_forwarding_rule+: { + [resourceLabel]+: { + source_ip_ranges: value, + }, + }, + }, + }, '#withSubnetwork':: d.fn(help='`google-beta.string.withSubnetwork` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the subnetwork 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 `subnetwork` field.\n', args=[]), withSubnetwork(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/compute_global_forwarding_rule.libsonnet b/4.x/_gen/resources/compute_global_forwarding_rule.libsonnet index 3f152235..8cda5ba4 100644 --- a/4.x/_gen/resources/compute_global_forwarding_rule.libsonnet +++ b/4.x/_gen/resources/compute_global_forwarding_rule.libsonnet @@ -4,7 +4,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); '#':: d.pkg(name='google_compute_global_forwarding_rule', url='', help='`google_compute_global_forwarding_rule` represents the `google-beta_google_compute_global_forwarding_rule` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), metadata_filters:: { filter_labels:: { - '#new':: d.fn(help='\n`google-beta.google_compute_global_forwarding_rule.metadata_filters.filter_labels.new` constructs a new object with attributes and blocks configured for the `filter_labels`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of metadata label.\n\nThe name can have a maximum length of 1024 characters and must be at least 1 character long.\n - `value` (`string`): The value of the label must match the specified value.\n\nvalue can have a maximum length of 1024 characters.\n\n**Returns**:\n - An attribute object that represents the `filter_labels` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_compute_global_forwarding_rule.metadata_filters.filter_labels.new` constructs a new object with attributes and blocks configured for the `filter_labels`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the metadata label. The length must be between\n1 and 1024 characters, inclusive.\n - `value` (`string`): The value that the label must match. The value has a maximum\nlength of 1024 characters.\n\n**Returns**:\n - An attribute object that represents the `filter_labels` sub block.\n', args=[]), new( name, value @@ -13,7 +13,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); value: value, }), }, - '#new':: d.fn(help='\n`google-beta.google_compute_global_forwarding_rule.metadata_filters.new` constructs a new object with attributes and blocks configured for the `metadata_filters`\nTerraform sub block.\n\n\n\n**Args**:\n - `filter_match_criteria` (`string`): Specifies how individual `filterLabel` matches within the list of `filterLabel`s contribute towards the overall `metadataFilter` match.\n\nSupported values are:\n\n* MATCH_ANY: At least one of the `filterLabels` must have a matching label in the provided metadata.\n* MATCH_ALL: All `filterLabels` must have matching labels in the provided metadata. Possible values: NOT_SET, MATCH_ALL, MATCH_ANY\n - `filter_labels` (`list[obj]`): The list of label value pairs that must match labels in the provided metadata based on `filterMatchCriteria`\n\nThis list must not be empty and can have at the most 64 entries. When `null`, the `filter_labels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_global_forwarding_rule.metadata_filters.filter_labels.new](#fn-metadata_filtersfilter_labelsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `metadata_filters` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_compute_global_forwarding_rule.metadata_filters.new` constructs a new object with attributes and blocks configured for the `metadata_filters`\nTerraform sub block.\n\n\n\n**Args**:\n - `filter_match_criteria` (`string`): Specifies how individual filterLabel matches within the list of\nfilterLabels contribute towards the overall metadataFilter match.\n\nMATCH_ANY - At least one of the filterLabels must have a matching\nlabel in the provided metadata.\nMATCH_ALL - All filterLabels must have matching labels in the\nprovided metadata. Possible values: ["MATCH_ANY", "MATCH_ALL"]\n - `filter_labels` (`list[obj]`): The list of label value pairs that must match labels in the\nprovided metadata based on filterMatchCriteria\n\nThis list must not be empty and can have at the most 64 entries. When `null`, the `filter_labels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_global_forwarding_rule.metadata_filters.filter_labels.new](#fn-metadata_filtersfilter_labelsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `metadata_filters` sub block.\n', args=[]), new( filter_match_criteria, filter_labels=null @@ -22,11 +22,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); filter_match_criteria: filter_match_criteria, }), }, - '#new':: d.fn(help="\n`google-beta.google_compute_global_forwarding_rule.new` injects a new `google-beta_google_compute_global_forwarding_rule` 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-beta.google_compute_global_forwarding_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_global_forwarding_rule` using the reference:\n\n $._ref.google-beta_google_compute_global_forwarding_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_global_forwarding_rule.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `ip_address` (`string`): IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don\u0026#39;t specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in `https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name` * Partial URL or by name, as in: * `projects/project_id/regions/region/addresses/address-name` * `regions/region/addresses/address-name` * `global/addresses/address-name` * `address-name` The loadBalancingScheme and the forwarding rule\u0026#39;s target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ip_protocol` (`string`): The IP protocol to which this rule applies. For protocol forwarding, valid options are `TCP`, `UDP`, `ESP`, `AH`, `SCTP` or `ICMP`. For Internal TCP/UDP Load Balancing, the load balancing scheme is `INTERNAL`, and one of `TCP` or `UDP` are valid. For Traffic Director, the load balancing scheme is `INTERNAL_SELF_MANAGED`, and only `TCP`is valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is `INTERNAL_MANAGED`, and only `TCP` is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is `EXTERNAL` and only `TCP` is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is `EXTERNAL`, and one of `TCP` or `UDP` is valid. When `null`, the `ip_protocol` field will be omitted from the resulting object.\n - `ip_version` (`string`): The IP Version that will be used by this forwarding rule. Valid options are `IPV4` or `IPV6`. This can only be specified for an external global forwarding rule. Possible values: UNSPECIFIED_VERSION, IPV4, IPV6 When `null`, the `ip_version` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this rule. When `null`, the `labels` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Specifies the forwarding rule type.\n\n* `EXTERNAL` is used for:\n * Classic Cloud VPN gateways\n * Protocol forwarding to VMs from an external IP address\n * The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP\n* `INTERNAL` is used for:\n * Protocol forwarding to VMs from an internal IP address\n * Internal TCP/UDP load balancers\n* `INTERNAL_MANAGED` is used for:\n * Internal HTTP(S) load balancers\n* `INTERNAL_SELF_MANAGED` is used for:\n * Traffic Director\n* `EXTERNAL_MANAGED` is used for:\n * Global external HTTP(S) load balancers \n\nFor more information about forwarding rules, refer to [Forwarding rule concepts](/load-balancing/docs/forwarding-rule-concepts). Possible values: INVALID, INTERNAL, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED, EXTERNAL, EXTERNAL_MANAGED When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.\n - `network` (`string`): This field is not used for external load balancing. For `INTERNAL` and `INTERNAL_SELF_MANAGED` load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. When `null`, the `network` field will be omitted from the resulting object.\n - `port_range` (`string`): When the load balancing scheme is `EXTERNAL`, `INTERNAL_SELF_MANAGED` and `INTERNAL_MANAGED`, you can specify a `port_range`. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the `target` field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when `IPProtocol` is `TCP`, `UDP`, or `SCTP`, only packets addressed to ports in the specified range will be forwarded to `target`. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports:\n\n* TargetHttpProxy: 80, 8080\n* TargetHttpsProxy: 443\n* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222\n* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222\n* TargetVpnGateway: 500, 4500\n\n@pattern: d\u0026#43;(?:-d\u0026#43;)? When `null`, the `port_range` field will be omitted from the resulting object.\n - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object.\n - `target` (`string`): The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For `INTERNAL_SELF_MANAGED` load balancing, only `targetHttpProxy` is valid, not `targetHttpsProxy`.\n - `metadata_filters` (`list[obj]`): Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of [xDS](https://github.com/envoyproxy/data-plane-api/blob/master/XDS_PROTOCOL.md) compliant clients. In their xDS requests to Loadbalancer, xDS clients present [node metadata](https://github.com/envoyproxy/data-plane-api/search?q=%22message\u0026#43;Node%22\u0026#43;in%3A%2Fenvoy%2Fapi%2Fv2%2Fcore%2Fbase.proto\u0026amp;). If a match takes place, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. `TargetHttpProxy`, `UrlMap`) referenced by the `ForwardingRule` will not be visible to those proxies.\n\nFor each `metadataFilter` in this list, if its `filterMatchCriteria` is set to MATCH_ANY, at least one of the `filterLabel`s must match the corresponding label provided in the metadata. If its `filterMatchCriteria` is set to MATCH_ALL, then all of its `filterLabel`s must match with corresponding labels provided in the metadata.\n\n`metadataFilters` specified here will be applifed before those specified in the `UrlMap` that this `ForwardingRule` references.\n\n`metadataFilters` only applies to Loadbalancers that have their loadBalancingScheme set to `INTERNAL_SELF_MANAGED`. When `null`, the `metadata_filters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_global_forwarding_rule.metadata_filters.new](#fn-metadata_filtersnew) 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-beta.google_compute_global_forwarding_rule.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-beta.google_compute_global_forwarding_rule.new` injects a new `google-beta_google_compute_global_forwarding_rule` 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-beta.google_compute_global_forwarding_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_global_forwarding_rule` using the reference:\n\n $._ref.google-beta_google_compute_global_forwarding_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_global_forwarding_rule.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_psc_global_access` (`bool`): This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. When `null`, the `allow_psc_global_access` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `ip_address` (`string`): IP address for which this forwarding rule accepts traffic. When a client\nsends traffic to this IP address, the forwarding rule directs the traffic\nto the referenced \u0026#39;target\u0026#39;.\n\nWhile creating a forwarding rule, specifying an \u0026#39;IPAddress\u0026#39; is\nrequired under the following circumstances:\n\n* When the \u0026#39;target\u0026#39; is set to \u0026#39;targetGrpcProxy\u0026#39; and\n\u0026#39;validateForProxyless\u0026#39; is set to \u0026#39;true\u0026#39;, the\n\u0026#39;IPAddress\u0026#39; should be set to \u0026#39;0.0.0.0\u0026#39;.\n* When the \u0026#39;target\u0026#39; is a Private Service Connect Google APIs\nbundle, you must specify an \u0026#39;IPAddress\u0026#39;.\n\n\nOtherwise, you can optionally specify an IP address that references an\nexisting static (reserved) IP address resource. When omitted, Google Cloud\nassigns an ephemeral IP address.\n\nUse one of the following formats to specify an IP address while creating a\nforwarding rule:\n\n* IP address number, as in \u0026#39;100.1.2.3\u0026#39;\n* IPv6 address range, as in \u0026#39;2600:1234::/96\u0026#39;\n* Full resource URL, as in\n\u0026#39;https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name\u0026#39;\n* Partial URL or by name, as in:\n * \u0026#39;projects/project_id/regions/region/addresses/address-name\u0026#39;\n * \u0026#39;regions/region/addresses/address-name\u0026#39;\n * \u0026#39;global/addresses/address-name\u0026#39;\n * \u0026#39;address-name\u0026#39;\n\n\nThe forwarding rule\u0026#39;s \u0026#39;target\u0026#39;,\nand in most cases, also the \u0026#39;loadBalancingScheme\u0026#39;, determine the\ntype of IP address that you can use. For detailed information, see\n[IP address\nspecifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n\nWhen reading an \u0026#39;IPAddress\u0026#39;, the API always returns the IP\naddress number. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ip_protocol` (`string`): The IP protocol to which this rule applies.\n\nFor protocol forwarding, valid\noptions are \u0026#39;TCP\u0026#39;, \u0026#39;UDP\u0026#39;, \u0026#39;ESP\u0026#39;,\n\u0026#39;AH\u0026#39;, \u0026#39;SCTP\u0026#39;, \u0026#39;ICMP\u0026#39; and\n\u0026#39;L3_DEFAULT\u0026#39;.\n\nThe valid IP protocols are different for different load balancing products\nas described in [Load balancing\nfeatures](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). Possible values: [\u0026#34;TCP\u0026#34;, \u0026#34;UDP\u0026#34;, \u0026#34;ESP\u0026#34;, \u0026#34;AH\u0026#34;, \u0026#34;SCTP\u0026#34;, \u0026#34;ICMP\u0026#34;] When `null`, the `ip_protocol` field will be omitted from the resulting object.\n - `ip_version` (`string`): The IP Version that will be used by this global forwarding rule. Possible values: [\u0026#34;IPV4\u0026#34;, \u0026#34;IPV6\u0026#34;] When `null`, the `ip_version` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this forwarding rule. A list of key-\u0026gt;value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Specifies the forwarding rule type.\n\nFor more information about forwarding rules, refer to\n[Forwarding rule concepts](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts). Default value: \u0026#34;EXTERNAL\u0026#34; Possible values: [\u0026#34;EXTERNAL\u0026#34;, \u0026#34;EXTERNAL_MANAGED\u0026#34;, \u0026#34;INTERNAL_SELF_MANAGED\u0026#34;] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply with\n[RFC1035](https://www.ietf.org/rfc/rfc1035.txt).\n\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, the forwarding rule name must be a 1-20 characters string with\nlowercase letters and numbers and must start with a letter.\n - `network` (`string`): This field is not used for external load balancing.\n\nFor Internal TCP/UDP Load Balancing, this field identifies the network that\nthe load balanced IP should belong to for this Forwarding Rule.\nIf the subnetwork is specified, the network of the subnetwork will be used.\nIf neither subnetwork nor this field is specified, the default network will\nbe used.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, a network must be provided. When `null`, the `network` field will be omitted from the resulting object.\n - `port_range` (`string`): This field can only be used:\n\n* If \u0026#39;IPProtocol\u0026#39; is one of TCP, UDP, or SCTP.\n* By backend service-based network load balancers, target pool-based\nnetwork load balancers, internal proxy load balancers, external proxy load\nbalancers, Traffic Director, external protocol forwarding, and Classic VPN.\nSome products have restrictions on what ports can be used. See\n[port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications)\nfor details.\n\n\n* TargetHttpProxy: 80, 8080\n* TargetHttpsProxy: 443\n* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995,\n 1883, 5222\n* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995,\n 1883, 5222\n* TargetVpnGateway: 500, 4500 When `null`, the `port_range` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `source_ip_ranges` (`list`): If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). When `null`, the `source_ip_ranges` field will be omitted from the resulting object.\n - `target` (`string`): The URL of the target resource to receive the matched traffic. For\nregional forwarding rules, this target must be in the same region as the\nforwarding rule. For global forwarding rules, this target must be a global\nload balancing resource.\n\nThe forwarded traffic must be of a type appropriate to the target object.\n* For load balancers, see the \u0026#34;Target\u0026#34; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n* For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:\n * \u0026#39;vpc-sc\u0026#39; - [ APIs that support VPC Service Controls](https://cloud.google.com/vpc-service-controls/docs/supported-products).\n * \u0026#39;all-apis\u0026#39; - [All supported Google APIs](https://cloud.google.com/vpc/docs/private-service-connect#supported-apis).\n\n\nFor Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.\n - `metadata_filters` (`list[obj]`): Opaque filter criteria used by Loadbalancer to restrict routing\nconfiguration to a limited set xDS compliant clients. In their xDS\nrequests to Loadbalancer, xDS clients present node metadata. If a\nmatch takes place, the relevant routing configuration is made available\nto those proxies.\n\nFor each metadataFilter in this list, if its filterMatchCriteria is set\nto MATCH_ANY, at least one of the filterLabels must match the\ncorresponding label provided in the metadata. If its filterMatchCriteria\nis set to MATCH_ALL, then all of its filterLabels must match with\ncorresponding labels in the provided metadata.\n\nmetadataFilters specified here can be overridden by those specified in\nthe UrlMap that this ForwardingRule references.\n\nmetadataFilters only applies to Loadbalancers that have their\nloadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `metadata_filters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_global_forwarding_rule.metadata_filters.new](#fn-metadata_filtersnew) 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-beta.google_compute_global_forwarding_rule.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, target, + allow_psc_global_access=null, description=null, ip_address=null, ip_protocol=null, @@ -37,12 +38,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); network=null, port_range=null, project=null, + source_ip_ranges=null, timeouts=null, _meta={} ):: tf.withResource( type='google_compute_global_forwarding_rule', label=resourceLabel, attrs=self.newAttrs( + allow_psc_global_access=allow_psc_global_access, description=description, ip_address=ip_address, ip_protocol=ip_protocol, @@ -54,15 +57,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); network=network, port_range=port_range, project=project, + source_ip_ranges=source_ip_ranges, target=target, timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_global_forwarding_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_global_forwarding_rule`\nTerraform resource.\n\nUnlike [google-beta.google_compute_global_forwarding_rule.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `ip_address` (`string`): IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in `https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name` * Partial URL or by name, as in: * `projects/project_id/regions/region/addresses/address-name` * `regions/region/addresses/address-name` * `global/addresses/address-name` * `address-name` The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ip_protocol` (`string`): The IP protocol to which this rule applies. For protocol forwarding, valid options are `TCP`, `UDP`, `ESP`, `AH`, `SCTP` or `ICMP`. For Internal TCP/UDP Load Balancing, the load balancing scheme is `INTERNAL`, and one of `TCP` or `UDP` are valid. For Traffic Director, the load balancing scheme is `INTERNAL_SELF_MANAGED`, and only `TCP`is valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is `INTERNAL_MANAGED`, and only `TCP` is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is `EXTERNAL` and only `TCP` is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is `EXTERNAL`, and one of `TCP` or `UDP` is valid. When `null`, the `ip_protocol` field will be omitted from the resulting object.\n - `ip_version` (`string`): The IP Version that will be used by this forwarding rule. Valid options are `IPV4` or `IPV6`. This can only be specified for an external global forwarding rule. Possible values: UNSPECIFIED_VERSION, IPV4, IPV6 When `null`, the `ip_version` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this rule. When `null`, the `labels` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Specifies the forwarding rule type.\n\n* `EXTERNAL` is used for:\n * Classic Cloud VPN gateways\n * Protocol forwarding to VMs from an external IP address\n * The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP\n* `INTERNAL` is used for:\n * Protocol forwarding to VMs from an internal IP address\n * Internal TCP/UDP load balancers\n* `INTERNAL_MANAGED` is used for:\n * Internal HTTP(S) load balancers\n* `INTERNAL_SELF_MANAGED` is used for:\n * Traffic Director\n* `EXTERNAL_MANAGED` is used for:\n * Global external HTTP(S) load balancers \n\nFor more information about forwarding rules, refer to [Forwarding rule concepts](/load-balancing/docs/forwarding-rule-concepts). Possible values: INVALID, INTERNAL, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED, EXTERNAL, EXTERNAL_MANAGED When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.\n - `network` (`string`): This field is not used for external load balancing. For `INTERNAL` and `INTERNAL_SELF_MANAGED` load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. When `null`, the `network` field will be omitted from the resulting object.\n - `port_range` (`string`): When the load balancing scheme is `EXTERNAL`, `INTERNAL_SELF_MANAGED` and `INTERNAL_MANAGED`, you can specify a `port_range`. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the `target` field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when `IPProtocol` is `TCP`, `UDP`, or `SCTP`, only packets addressed to ports in the specified range will be forwarded to `target`. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports:\n\n* TargetHttpProxy: 80, 8080\n* TargetHttpsProxy: 443\n* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222\n* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222\n* TargetVpnGateway: 500, 4500\n\n@pattern: d+(?:-d+)? When `null`, the `port_range` field will be omitted from the resulting object.\n - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object.\n - `target` (`string`): The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For `INTERNAL_SELF_MANAGED` load balancing, only `targetHttpProxy` is valid, not `targetHttpsProxy`.\n - `metadata_filters` (`list[obj]`): Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of [xDS](https://github.com/envoyproxy/data-plane-api/blob/master/XDS_PROTOCOL.md) compliant clients. In their xDS requests to Loadbalancer, xDS clients present [node metadata](https://github.com/envoyproxy/data-plane-api/search?q=%22message+Node%22+in%3A%2Fenvoy%2Fapi%2Fv2%2Fcore%2Fbase.proto&). If a match takes place, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. `TargetHttpProxy`, `UrlMap`) referenced by the `ForwardingRule` will not be visible to those proxies.\n\nFor each `metadataFilter` in this list, if its `filterMatchCriteria` is set to MATCH_ANY, at least one of the `filterLabel`s must match the corresponding label provided in the metadata. If its `filterMatchCriteria` is set to MATCH_ALL, then all of its `filterLabel`s must match with corresponding labels provided in the metadata.\n\n`metadataFilters` specified here will be applifed before those specified in the `UrlMap` that this `ForwardingRule` references.\n\n`metadataFilters` only applies to Loadbalancers that have their loadBalancingScheme set to `INTERNAL_SELF_MANAGED`. When `null`, the `metadata_filters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_global_forwarding_rule.metadata_filters.new](#fn-metadata_filtersnew) 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-beta.google_compute_global_forwarding_rule.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 `google_compute_global_forwarding_rule` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_global_forwarding_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_global_forwarding_rule`\nTerraform resource.\n\nUnlike [google-beta.google_compute_global_forwarding_rule.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_psc_global_access` (`bool`): This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. When `null`, the `allow_psc_global_access` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `ip_address` (`string`): IP address for which this forwarding rule accepts traffic. When a client\nsends traffic to this IP address, the forwarding rule directs the traffic\nto the referenced 'target'.\n\nWhile creating a forwarding rule, specifying an 'IPAddress' is\nrequired under the following circumstances:\n\n* When the 'target' is set to 'targetGrpcProxy' and\n'validateForProxyless' is set to 'true', the\n'IPAddress' should be set to '0.0.0.0'.\n* When the 'target' is a Private Service Connect Google APIs\nbundle, you must specify an 'IPAddress'.\n\n\nOtherwise, you can optionally specify an IP address that references an\nexisting static (reserved) IP address resource. When omitted, Google Cloud\nassigns an ephemeral IP address.\n\nUse one of the following formats to specify an IP address while creating a\nforwarding rule:\n\n* IP address number, as in '100.1.2.3'\n* IPv6 address range, as in '2600:1234::/96'\n* Full resource URL, as in\n'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name'\n* Partial URL or by name, as in:\n * 'projects/project_id/regions/region/addresses/address-name'\n * 'regions/region/addresses/address-name'\n * 'global/addresses/address-name'\n * 'address-name'\n\n\nThe forwarding rule's 'target',\nand in most cases, also the 'loadBalancingScheme', determine the\ntype of IP address that you can use. For detailed information, see\n[IP address\nspecifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n\nWhen reading an 'IPAddress', the API always returns the IP\naddress number. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ip_protocol` (`string`): The IP protocol to which this rule applies.\n\nFor protocol forwarding, valid\noptions are 'TCP', 'UDP', 'ESP',\n'AH', 'SCTP', 'ICMP' and\n'L3_DEFAULT'.\n\nThe valid IP protocols are different for different load balancing products\nas described in [Load balancing\nfeatures](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). Possible values: ["TCP", "UDP", "ESP", "AH", "SCTP", "ICMP"] When `null`, the `ip_protocol` field will be omitted from the resulting object.\n - `ip_version` (`string`): The IP Version that will be used by this global forwarding rule. Possible values: ["IPV4", "IPV6"] When `null`, the `ip_version` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this forwarding rule. A list of key->value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Specifies the forwarding rule type.\n\nFor more information about forwarding rules, refer to\n[Forwarding rule concepts](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts). Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL_SELF_MANAGED"] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply with\n[RFC1035](https://www.ietf.org/rfc/rfc1035.txt).\n\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, the forwarding rule name must be a 1-20 characters string with\nlowercase letters and numbers and must start with a letter.\n - `network` (`string`): This field is not used for external load balancing.\n\nFor Internal TCP/UDP Load Balancing, this field identifies the network that\nthe load balanced IP should belong to for this Forwarding Rule.\nIf the subnetwork is specified, the network of the subnetwork will be used.\nIf neither subnetwork nor this field is specified, the default network will\nbe used.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, a network must be provided. When `null`, the `network` field will be omitted from the resulting object.\n - `port_range` (`string`): This field can only be used:\n\n* If 'IPProtocol' is one of TCP, UDP, or SCTP.\n* By backend service-based network load balancers, target pool-based\nnetwork load balancers, internal proxy load balancers, external proxy load\nbalancers, Traffic Director, external protocol forwarding, and Classic VPN.\nSome products have restrictions on what ports can be used. See\n[port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications)\nfor details.\n\n\n* TargetHttpProxy: 80, 8080\n* TargetHttpsProxy: 443\n* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995,\n 1883, 5222\n* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995,\n 1883, 5222\n* TargetVpnGateway: 500, 4500 When `null`, the `port_range` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `source_ip_ranges` (`list`): If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). When `null`, the `source_ip_ranges` field will be omitted from the resulting object.\n - `target` (`string`): The URL of the target resource to receive the matched traffic. For\nregional forwarding rules, this target must be in the same region as the\nforwarding rule. For global forwarding rules, this target must be a global\nload balancing resource.\n\nThe forwarded traffic must be of a type appropriate to the target object.\n* For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n* For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:\n * 'vpc-sc' - [ APIs that support VPC Service Controls](https://cloud.google.com/vpc-service-controls/docs/supported-products).\n * 'all-apis' - [All supported Google APIs](https://cloud.google.com/vpc/docs/private-service-connect#supported-apis).\n\n\nFor Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.\n - `metadata_filters` (`list[obj]`): Opaque filter criteria used by Loadbalancer to restrict routing\nconfiguration to a limited set xDS compliant clients. In their xDS\nrequests to Loadbalancer, xDS clients present node metadata. If a\nmatch takes place, the relevant routing configuration is made available\nto those proxies.\n\nFor each metadataFilter in this list, if its filterMatchCriteria is set\nto MATCH_ANY, at least one of the filterLabels must match the\ncorresponding label provided in the metadata. If its filterMatchCriteria\nis set to MATCH_ALL, then all of its filterLabels must match with\ncorresponding labels in the provided metadata.\n\nmetadataFilters specified here can be overridden by those specified in\nthe UrlMap that this ForwardingRule references.\n\nmetadataFilters only applies to Loadbalancers that have their\nloadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `metadata_filters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_global_forwarding_rule.metadata_filters.new](#fn-metadata_filtersnew) 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-beta.google_compute_global_forwarding_rule.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 `google_compute_global_forwarding_rule` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, target, + allow_psc_global_access=null, description=null, ip_address=null, ip_protocol=null, @@ -73,8 +78,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); network=null, port_range=null, project=null, + source_ip_ranges=null, timeouts=null ):: std.prune(a={ + allow_psc_global_access: allow_psc_global_access, description: description, ip_address: ip_address, ip_protocol: ip_protocol, @@ -86,6 +93,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); network: network, port_range: port_range, project: project, + source_ip_ranges: source_ip_ranges, target: target, timeouts: timeouts, }), @@ -101,6 +109,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withAllowPscGlobalAccess':: d.fn(help='`google-beta.bool.withAllowPscGlobalAccess` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the allow_psc_global_access 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 `allow_psc_global_access` field.\n', args=[]), + withAllowPscGlobalAccess(resourceLabel, value): { + resource+: { + google_compute_global_forwarding_rule+: { + [resourceLabel]+: { + allow_psc_global_access: value, + }, + }, + }, + }, '#withDescription':: d.fn(help='`google-beta.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+: { @@ -221,6 +239,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSourceIpRanges':: d.fn(help='`google-beta.list.withSourceIpRanges` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the source_ip_ranges 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 `source_ip_ranges` field.\n', args=[]), + withSourceIpRanges(resourceLabel, value): { + resource+: { + google_compute_global_forwarding_rule+: { + [resourceLabel]+: { + source_ip_ranges: value, + }, + }, + }, + }, '#withTarget':: d.fn(help='`google-beta.string.withTarget` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the target 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 `target` field.\n', args=[]), withTarget(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/compute_network.libsonnet b/4.x/_gen/resources/compute_network.libsonnet index 18e58383..00d90770 100644 --- a/4.x/_gen/resources/compute_network.libsonnet +++ b/4.x/_gen/resources/compute_network.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='google_compute_network', url='', help='`google_compute_network` represents the `google-beta_google_compute_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-beta.google_compute_network.new` injects a new `google-beta_google_compute_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-beta.google_compute_network.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_network` using the reference:\n\n $._ref.google-beta_google_compute_network.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_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 - `auto_create_subnetworks` (`bool`): When set to \u0026#39;true\u0026#39;, the network is created in \u0026#34;auto subnet mode\u0026#34; and\nit will create a subnet for each region automatically across the\n\u0026#39;10.128.0.0/9\u0026#39; address range.\n\nWhen set to \u0026#39;false\u0026#39;, the network is created in \u0026#34;custom subnet mode\u0026#34; so\nthe user can explicitly connect subnetwork resources. When `null`, the `auto_create_subnetworks` field will be omitted from the resulting object.\n - `delete_default_routes_on_create` (`bool`): If set to \u0026#39;true\u0026#39;, default routes (\u0026#39;0.0.0.0/0\u0026#39;) will be deleted\nimmediately after network creation. Defaults to \u0026#39;false\u0026#39;. When `null`, the `delete_default_routes_on_create` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. The resource must be\nrecreated to modify this field. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_ula_internal_ipv6` (`bool`): Enable ULA internal ipv6 on this network. Enabling this feature will assign \na /48 from google defined ULA prefix fd20::/20. When `null`, the `enable_ula_internal_ipv6` field will be omitted from the resulting object.\n - `internal_ipv6_range` (`string`): When enabling ula internal ipv6, caller optionally can specify the /48 range \nthey want from the google defined ULA prefix fd20::/20. The input must be a \nvalid /48 ULA IPv6 address and must be within the fd20::/20. Operation will \nfail if the speficied /48 is already in used by another resource. \nIf the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. When `null`, the `internal_ipv6_range` field will be omitted from the resulting object.\n - `mtu` (`number`): Maximum Transmission Unit in bytes. The default value is 1460 bytes. \nThe minimum value for this field is 1300 and the maximum value is 8896 bytes (jumbo frames).\nNote that packets larger than 1500 bytes (standard Ethernet) can be subject to TCP-MSS clamping or dropped\nwith an ICMP \u0026#39;Fragmentation-Needed\u0026#39; message if the packets are routed to the Internet or other VPCs \nwith varying MTUs. When `null`, the `mtu` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `network_firewall_policy_enforcement_order` (`string`): Set the order that Firewall Rules and Firewall Policies are evaluated. Needs to be either \u0026#39;AFTER_CLASSIC_FIREWALL\u0026#39; or \u0026#39;BEFORE_CLASSIC_FIREWALL\u0026#39; Default \u0026#39;AFTER_CLASSIC_FIREWALL\u0026#39; Default value: \u0026#34;AFTER_CLASSIC_FIREWALL\u0026#34; Possible values: [\u0026#34;BEFORE_CLASSIC_FIREWALL\u0026#34;, \u0026#34;AFTER_CLASSIC_FIREWALL\u0026#34;] When `null`, the `network_firewall_policy_enforcement_order` 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 - `routing_mode` (`string`): The network-wide routing mode to use. If set to \u0026#39;REGIONAL\u0026#39;, this\nnetwork\u0026#39;s cloud routers will only advertise routes with subnetworks\nof this network in the same region as the router. If set to \u0026#39;GLOBAL\u0026#39;,\nthis network\u0026#39;s cloud routers will advertise routes with all\nsubnetworks of this network, across regions. Possible values: [\u0026#34;REGIONAL\u0026#34;, \u0026#34;GLOBAL\u0026#34;] When `null`, the `routing_mode` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_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':: d.fn(help="\n`google-beta.google_compute_network.new` injects a new `google-beta_google_compute_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-beta.google_compute_network.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_network` using the reference:\n\n $._ref.google-beta_google_compute_network.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_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 - `auto_create_subnetworks` (`bool`): When set to \u0026#39;true\u0026#39;, the network is created in \u0026#34;auto subnet mode\u0026#34; and\nit will create a subnet for each region automatically across the\n\u0026#39;10.128.0.0/9\u0026#39; address range.\n\nWhen set to \u0026#39;false\u0026#39;, the network is created in \u0026#34;custom subnet mode\u0026#34; so\nthe user can explicitly connect subnetwork resources. When `null`, the `auto_create_subnetworks` field will be omitted from the resulting object.\n - `delete_default_routes_on_create` (`bool`): If set to \u0026#39;true\u0026#39;, default routes (\u0026#39;0.0.0.0/0\u0026#39;) will be deleted\nimmediately after network creation. Defaults to \u0026#39;false\u0026#39;. When `null`, the `delete_default_routes_on_create` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. The resource must be\nrecreated to modify this field. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_ula_internal_ipv6` (`bool`): Enable ULA internal ipv6 on this network. Enabling this feature will assign\na /48 from google defined ULA prefix fd20::/20. When `null`, the `enable_ula_internal_ipv6` field will be omitted from the resulting object.\n - `internal_ipv6_range` (`string`): When enabling ula internal ipv6, caller optionally can specify the /48 range\nthey want from the google defined ULA prefix fd20::/20. The input must be a\nvalid /48 ULA IPv6 address and must be within the fd20::/20. Operation will\nfail if the speficied /48 is already in used by another resource.\nIf the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. When `null`, the `internal_ipv6_range` field will be omitted from the resulting object.\n - `mtu` (`number`): Maximum Transmission Unit in bytes. The default value is 1460 bytes.\nThe minimum value for this field is 1300 and the maximum value is 8896 bytes (jumbo frames).\nNote that packets larger than 1500 bytes (standard Ethernet) can be subject to TCP-MSS clamping or dropped\nwith an ICMP \u0026#39;Fragmentation-Needed\u0026#39; message if the packets are routed to the Internet or other VPCs\nwith varying MTUs. When `null`, the `mtu` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `network_firewall_policy_enforcement_order` (`string`): Set the order that Firewall Rules and Firewall Policies are evaluated. Default value: \u0026#34;AFTER_CLASSIC_FIREWALL\u0026#34; Possible values: [\u0026#34;BEFORE_CLASSIC_FIREWALL\u0026#34;, \u0026#34;AFTER_CLASSIC_FIREWALL\u0026#34;] When `null`, the `network_firewall_policy_enforcement_order` 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 - `routing_mode` (`string`): The network-wide routing mode to use. If set to \u0026#39;REGIONAL\u0026#39;, this\nnetwork\u0026#39;s cloud routers will only advertise routes with subnetworks\nof this network in the same region as the router. If set to \u0026#39;GLOBAL\u0026#39;,\nthis network\u0026#39;s cloud routers will advertise routes with all\nsubnetworks of this network, across regions. Possible values: [\u0026#34;REGIONAL\u0026#34;, \u0026#34;GLOBAL\u0026#34;] When `null`, the `routing_mode` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_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, name, @@ -35,7 +35,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_network.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_network`\nTerraform resource.\n\nUnlike [google-beta.google_compute_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 - `auto_create_subnetworks` (`bool`): When set to 'true', the network is created in "auto subnet mode" and\nit will create a subnet for each region automatically across the\n'10.128.0.0/9' address range.\n\nWhen set to 'false', the network is created in "custom subnet mode" so\nthe user can explicitly connect subnetwork resources. When `null`, the `auto_create_subnetworks` field will be omitted from the resulting object.\n - `delete_default_routes_on_create` (`bool`): If set to 'true', default routes ('0.0.0.0/0') will be deleted\nimmediately after network creation. Defaults to 'false'. When `null`, the `delete_default_routes_on_create` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. The resource must be\nrecreated to modify this field. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_ula_internal_ipv6` (`bool`): Enable ULA internal ipv6 on this network. Enabling this feature will assign \na /48 from google defined ULA prefix fd20::/20. When `null`, the `enable_ula_internal_ipv6` field will be omitted from the resulting object.\n - `internal_ipv6_range` (`string`): When enabling ula internal ipv6, caller optionally can specify the /48 range \nthey want from the google defined ULA prefix fd20::/20. The input must be a \nvalid /48 ULA IPv6 address and must be within the fd20::/20. Operation will \nfail if the speficied /48 is already in used by another resource. \nIf the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. When `null`, the `internal_ipv6_range` field will be omitted from the resulting object.\n - `mtu` (`number`): Maximum Transmission Unit in bytes. The default value is 1460 bytes. \nThe minimum value for this field is 1300 and the maximum value is 8896 bytes (jumbo frames).\nNote that packets larger than 1500 bytes (standard Ethernet) can be subject to TCP-MSS clamping or dropped\nwith an ICMP 'Fragmentation-Needed' message if the packets are routed to the Internet or other VPCs \nwith varying MTUs. When `null`, the `mtu` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `network_firewall_policy_enforcement_order` (`string`): Set the order that Firewall Rules and Firewall Policies are evaluated. Needs to be either 'AFTER_CLASSIC_FIREWALL' or 'BEFORE_CLASSIC_FIREWALL' Default 'AFTER_CLASSIC_FIREWALL' Default value: "AFTER_CLASSIC_FIREWALL" Possible values: ["BEFORE_CLASSIC_FIREWALL", "AFTER_CLASSIC_FIREWALL"] When `null`, the `network_firewall_policy_enforcement_order` 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 - `routing_mode` (`string`): The network-wide routing mode to use. If set to 'REGIONAL', this\nnetwork's cloud routers will only advertise routes with subnetworks\nof this network in the same region as the router. If set to 'GLOBAL',\nthis network's cloud routers will advertise routes with all\nsubnetworks of this network, across regions. Possible values: ["REGIONAL", "GLOBAL"] When `null`, the `routing_mode` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_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 `google_compute_network` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_network.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_network`\nTerraform resource.\n\nUnlike [google-beta.google_compute_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 - `auto_create_subnetworks` (`bool`): When set to 'true', the network is created in "auto subnet mode" and\nit will create a subnet for each region automatically across the\n'10.128.0.0/9' address range.\n\nWhen set to 'false', the network is created in "custom subnet mode" so\nthe user can explicitly connect subnetwork resources. When `null`, the `auto_create_subnetworks` field will be omitted from the resulting object.\n - `delete_default_routes_on_create` (`bool`): If set to 'true', default routes ('0.0.0.0/0') will be deleted\nimmediately after network creation. Defaults to 'false'. When `null`, the `delete_default_routes_on_create` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. The resource must be\nrecreated to modify this field. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_ula_internal_ipv6` (`bool`): Enable ULA internal ipv6 on this network. Enabling this feature will assign\na /48 from google defined ULA prefix fd20::/20. When `null`, the `enable_ula_internal_ipv6` field will be omitted from the resulting object.\n - `internal_ipv6_range` (`string`): When enabling ula internal ipv6, caller optionally can specify the /48 range\nthey want from the google defined ULA prefix fd20::/20. The input must be a\nvalid /48 ULA IPv6 address and must be within the fd20::/20. Operation will\nfail if the speficied /48 is already in used by another resource.\nIf the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. When `null`, the `internal_ipv6_range` field will be omitted from the resulting object.\n - `mtu` (`number`): Maximum Transmission Unit in bytes. The default value is 1460 bytes.\nThe minimum value for this field is 1300 and the maximum value is 8896 bytes (jumbo frames).\nNote that packets larger than 1500 bytes (standard Ethernet) can be subject to TCP-MSS clamping or dropped\nwith an ICMP 'Fragmentation-Needed' message if the packets are routed to the Internet or other VPCs\nwith varying MTUs. When `null`, the `mtu` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `network_firewall_policy_enforcement_order` (`string`): Set the order that Firewall Rules and Firewall Policies are evaluated. Default value: "AFTER_CLASSIC_FIREWALL" Possible values: ["BEFORE_CLASSIC_FIREWALL", "AFTER_CLASSIC_FIREWALL"] When `null`, the `network_firewall_policy_enforcement_order` 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 - `routing_mode` (`string`): The network-wide routing mode to use. If set to 'REGIONAL', this\nnetwork's cloud routers will only advertise routes with subnetworks\nof this network in the same region as the router. If set to 'GLOBAL',\nthis network's cloud routers will advertise routes with all\nsubnetworks of this network, across regions. Possible values: ["REGIONAL", "GLOBAL"] When `null`, the `routing_mode` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_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 `google_compute_network` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, auto_create_subnetworks=null, diff --git a/4.x/_gen/resources/compute_network_firewall_policy_rule.libsonnet b/4.x/_gen/resources/compute_network_firewall_policy_rule.libsonnet index ba3ef720..d2c528a8 100644 --- a/4.x/_gen/resources/compute_network_firewall_policy_rule.libsonnet +++ b/4.x/_gen/resources/compute_network_firewall_policy_rule.libsonnet @@ -13,17 +13,33 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ports: ports, }), }, - '#new':: d.fn(help='\n`google-beta.google_compute_network_firewall_policy_rule.match.new` constructs a new object with attributes and blocks configured for the `match`\nTerraform sub block.\n\n\n\n**Args**:\n - `dest_ip_ranges` (`list`): CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. When `null`, the `dest_ip_ranges` field will be omitted from the resulting object.\n - `src_ip_ranges` (`list`): CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. When `null`, the `src_ip_ranges` field will be omitted from the resulting object.\n - `layer4_configs` (`list[obj]`): Pairs of IP protocols and ports that the rule should match. When `null`, the `layer4_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_network_firewall_policy_rule.match.layer4_configs.new](#fn-matchlayer4_configsnew) constructor.\n - `src_secure_tags` (`list[obj]`): List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the <code>srcSecureTag</code> are INEFFECTIVE, and there is no <code>srcIpRange</code>, this rule will be ignored. Maximum number of source tag values allowed is 256. When `null`, the `src_secure_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-beta.google_compute_network_firewall_policy_rule.match.src_secure_tags.new](#fn-matchsrc_secure_tagsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `match` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_compute_network_firewall_policy_rule.match.new` constructs a new object with attributes and blocks configured for the `match`\nTerraform sub block.\n\n\n\n**Args**:\n - `dest_address_groups` (`list`): Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules. When `null`, the `dest_address_groups` field will be omitted from the resulting object.\n - `dest_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_fqdns` field will be omitted from the resulting object.\n - `dest_ip_ranges` (`list`): CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. When `null`, the `dest_ip_ranges` field will be omitted from the resulting object.\n - `dest_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_region_codes` field will be omitted from the resulting object.\n - `dest_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `dest_threat_intelligences` field will be omitted from the resulting object.\n - `src_address_groups` (`list`): Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules. When `null`, the `src_address_groups` field will be omitted from the resulting object.\n - `src_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_fqdns` field will be omitted from the resulting object.\n - `src_ip_ranges` (`list`): CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. When `null`, the `src_ip_ranges` field will be omitted from the resulting object.\n - `src_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_region_codes` field will be omitted from the resulting object.\n - `src_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `src_threat_intelligences` field will be omitted from the resulting object.\n - `layer4_configs` (`list[obj]`): Pairs of IP protocols and ports that the rule should match. When `null`, the `layer4_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_network_firewall_policy_rule.match.layer4_configs.new](#fn-matchlayer4_configsnew) constructor.\n - `src_secure_tags` (`list[obj]`): List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the <code>srcSecureTag</code> are INEFFECTIVE, and there is no <code>srcIpRange</code>, this rule will be ignored. Maximum number of source tag values allowed is 256. When `null`, the `src_secure_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-beta.google_compute_network_firewall_policy_rule.match.src_secure_tags.new](#fn-matchsrc_secure_tagsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `match` sub block.\n', args=[]), new( + dest_address_groups=null, + dest_fqdns=null, dest_ip_ranges=null, + dest_region_codes=null, + dest_threat_intelligences=null, layer4_configs=null, + src_address_groups=null, + src_fqdns=null, src_ip_ranges=null, - src_secure_tags=null + src_region_codes=null, + src_secure_tags=null, + src_threat_intelligences=null ):: std.prune(a={ + dest_address_groups: dest_address_groups, + dest_fqdns: dest_fqdns, dest_ip_ranges: dest_ip_ranges, + dest_region_codes: dest_region_codes, + dest_threat_intelligences: dest_threat_intelligences, layer4_configs: layer4_configs, + src_address_groups: src_address_groups, + src_fqdns: src_fqdns, src_ip_ranges: src_ip_ranges, + src_region_codes: src_region_codes, src_secure_tags: src_secure_tags, + src_threat_intelligences: src_threat_intelligences, }), src_secure_tags:: { '#new':: d.fn(help='\n`google-beta.google_compute_network_firewall_policy_rule.match.src_secure_tags.new` constructs a new object with attributes and blocks configured for the `src_secure_tags`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the secure tag, created with TagManager's TagValue API. @pattern tagValues/[0-9]+\n\n**Returns**:\n - An attribute object that represents the `src_secure_tags` sub block.\n', args=[]), diff --git a/4.x/_gen/resources/compute_region_commitment.libsonnet b/4.x/_gen/resources/compute_region_commitment.libsonnet index f8528503..f30dfa2a 100644 --- a/4.x/_gen/resources/compute_region_commitment.libsonnet +++ b/4.x/_gen/resources/compute_region_commitment.libsonnet @@ -14,7 +14,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); license: license, }), }, - '#new':: d.fn(help="\n`google-beta.google_compute_region_commitment.new` injects a new `google-beta_google_compute_region_commitment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_compute_region_commitment.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_region_commitment` using the reference:\n\n $._ref.google-beta_google_compute_region_commitment.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_region_commitment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment. \nThe default value is false if not specified. \nIf the field is set to true, the commitment will be automatically renewed for either \none or three years according to the terms of the existing commitment. When `null`, the `auto_renew` field will be omitted from the resulting object.\n - `category` (`string`): The category of the commitment. Category MACHINE specifies commitments composed of\nmachine resources such as VCPU or MEMORY, listed in resources. Category LICENSE\nspecifies commitments composed of software licenses, listed in licenseResources.\nNote that only MACHINE commitments should have a Type specified. Possible values: [\u0026#34;LICENSE\u0026#34;, \u0026#34;MACHINE\u0026#34;] When `null`, the `category` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. The name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `plan` (`string`): The plan for this commitment, which determines duration and discount rate.\nThe currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Possible values: [\u0026#34;TWELVE_MONTH\u0026#34;, \u0026#34;THIRTY_SIX_MONTH\u0026#34;]\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): URL of the region where this commitment may be used. When `null`, the `region` field will be omitted from the resulting object.\n - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources. \nType MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized\nmachines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to\naccelerator optimized machines. Possible values: [\u0026#34;MEMORY_OPTIMIZED\u0026#34;, \u0026#34;ACCELERATOR_OPTIMIZED\u0026#34;] When `null`, the `type` field will be omitted from the resulting object.\n - `license_resource` (`list[obj]`): The license specification required as part of a license commitment. When `null`, the `license_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.license_resource.new](#fn-license_resourcenew) constructor.\n - `resources` (`list[obj]`): A list of commitment amounts for particular resources. \nNote that VCPU and MEMORY resource commitments must occur together. When `null`, the `resources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.resources.new](#fn-resourcesnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_compute_region_commitment.new` injects a new `google-beta_google_compute_region_commitment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_compute_region_commitment.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_region_commitment` using the reference:\n\n $._ref.google-beta_google_compute_region_commitment.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_region_commitment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment.\nThe default value is false if not specified.\nIf the field is set to true, the commitment will be automatically renewed for either\none or three years according to the terms of the existing commitment. When `null`, the `auto_renew` field will be omitted from the resulting object.\n - `category` (`string`): The category of the commitment. Category MACHINE specifies commitments composed of\nmachine resources such as VCPU or MEMORY, listed in resources. Category LICENSE\nspecifies commitments composed of software licenses, listed in licenseResources.\nNote that only MACHINE commitments should have a Type specified. Possible values: [\u0026#34;LICENSE\u0026#34;, \u0026#34;MACHINE\u0026#34;] When `null`, the `category` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. The name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `plan` (`string`): The plan for this commitment, which determines duration and discount rate.\nThe currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Possible values: [\u0026#34;TWELVE_MONTH\u0026#34;, \u0026#34;THIRTY_SIX_MONTH\u0026#34;]\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): URL of the region where this commitment may be used. When `null`, the `region` field will be omitted from the resulting object.\n - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources.\nType MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized\nmachines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to\naccelerator optimized machines. Possible values: [\u0026#34;MEMORY_OPTIMIZED\u0026#34;, \u0026#34;ACCELERATOR_OPTIMIZED\u0026#34;] When `null`, the `type` field will be omitted from the resulting object.\n - `license_resource` (`list[obj]`): The license specification required as part of a license commitment. When `null`, the `license_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.license_resource.new](#fn-license_resourcenew) constructor.\n - `resources` (`list[obj]`): A list of commitment amounts for particular resources.\nNote that VCPU and MEMORY resource commitments must occur together. When `null`, the `resources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.resources.new](#fn-resourcesnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -47,7 +47,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_region_commitment.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_region_commitment`\nTerraform resource.\n\nUnlike [google-beta.google_compute_region_commitment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment. \nThe default value is false if not specified. \nIf the field is set to true, the commitment will be automatically renewed for either \none or three years according to the terms of the existing commitment. When `null`, the `auto_renew` field will be omitted from the resulting object.\n - `category` (`string`): The category of the commitment. Category MACHINE specifies commitments composed of\nmachine resources such as VCPU or MEMORY, listed in resources. Category LICENSE\nspecifies commitments composed of software licenses, listed in licenseResources.\nNote that only MACHINE commitments should have a Type specified. Possible values: ["LICENSE", "MACHINE"] When `null`, the `category` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. The name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `plan` (`string`): The plan for this commitment, which determines duration and discount rate.\nThe currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Possible values: ["TWELVE_MONTH", "THIRTY_SIX_MONTH"]\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): URL of the region where this commitment may be used. When `null`, the `region` field will be omitted from the resulting object.\n - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources. \nType MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized\nmachines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to\naccelerator optimized machines. Possible values: ["MEMORY_OPTIMIZED", "ACCELERATOR_OPTIMIZED"] When `null`, the `type` field will be omitted from the resulting object.\n - `license_resource` (`list[obj]`): The license specification required as part of a license commitment. When `null`, the `license_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.license_resource.new](#fn-license_resourcenew) constructor.\n - `resources` (`list[obj]`): A list of commitment amounts for particular resources. \nNote that VCPU and MEMORY resource commitments must occur together. When `null`, the `resources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.resources.new](#fn-resourcesnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_compute_region_commitment` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_region_commitment.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_region_commitment`\nTerraform resource.\n\nUnlike [google-beta.google_compute_region_commitment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment.\nThe default value is false if not specified.\nIf the field is set to true, the commitment will be automatically renewed for either\none or three years according to the terms of the existing commitment. When `null`, the `auto_renew` field will be omitted from the resulting object.\n - `category` (`string`): The category of the commitment. Category MACHINE specifies commitments composed of\nmachine resources such as VCPU or MEMORY, listed in resources. Category LICENSE\nspecifies commitments composed of software licenses, listed in licenseResources.\nNote that only MACHINE commitments should have a Type specified. Possible values: ["LICENSE", "MACHINE"] When `null`, the `category` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. The name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `plan` (`string`): The plan for this commitment, which determines duration and discount rate.\nThe currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Possible values: ["TWELVE_MONTH", "THIRTY_SIX_MONTH"]\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): URL of the region where this commitment may be used. When `null`, the `region` field will be omitted from the resulting object.\n - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources.\nType MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized\nmachines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to\naccelerator optimized machines. Possible values: ["MEMORY_OPTIMIZED", "ACCELERATOR_OPTIMIZED"] When `null`, the `type` field will be omitted from the resulting object.\n - `license_resource` (`list[obj]`): The license specification required as part of a license commitment. When `null`, the `license_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.license_resource.new](#fn-license_resourcenew) constructor.\n - `resources` (`list[obj]`): A list of commitment amounts for particular resources.\nNote that VCPU and MEMORY resource commitments must occur together. When `null`, the `resources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.resources.new](#fn-resourcesnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_compute_region_commitment` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, plan, diff --git a/4.x/_gen/resources/compute_region_disk.libsonnet b/4.x/_gen/resources/compute_region_disk.libsonnet index 7589f736..60e04272 100644 --- a/4.x/_gen/resources/compute_region_disk.libsonnet +++ b/4.x/_gen/resources/compute_region_disk.libsonnet @@ -2,6 +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='google_compute_region_disk', url='', help='`google_compute_region_disk` represents the `google-beta_google_compute_region_disk` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + async_primary_disk:: { + '#new':: d.fn(help='\n`google-beta.google_compute_region_disk.async_primary_disk.new` constructs a new object with attributes and blocks configured for the `async_primary_disk`\nTerraform sub block.\n\n\n\n**Args**:\n - `disk` (`string`): Primary disk for asynchronous disk replication.\n\n**Returns**:\n - An attribute object that represents the `async_primary_disk` sub block.\n', args=[]), + new( + disk + ):: std.prune(a={ + disk: disk, + }), + }, disk_encryption_key:: { '#new':: d.fn(help='\n`google-beta.google_compute_region_disk.disk_encryption_key.new` constructs a new object with attributes and blocks configured for the `disk_encryption_key`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_name` (`string`): The name of the encryption key that is stored in Google Cloud KMS. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `raw_key` (`string`): Specifies a 256-bit customer-supplied encryption key, encoded in\nRFC 4648 base64 to either encrypt or decrypt this resource. When `null`, the `raw_key` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `disk_encryption_key` sub block.\n', args=[]), new( @@ -12,11 +20,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); raw_key: raw_key, }), }, - '#new':: d.fn(help="\n`google-beta.google_compute_region_disk.new` injects a new `google-beta_google_compute_region_disk` 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-beta.google_compute_region_disk.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_region_disk` using the reference:\n\n $._ref.google-beta_google_compute_region_disk.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_region_disk.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `interface` (`string`): Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. When `null`, the `interface` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key-\u0026gt;value pairs. When `null`, the `labels` 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 - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller\u0026#39;s project. When `null`, the `physical_block_size_bytes` 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 - `region` (`string`): A reference to the region where the disk resides. When `null`, the `region` field will be omitted from the resulting object.\n - `replica_zones` (`list`): URLs of the zones where the disk should be replicated to.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the sourceImage or\nsourceSnapshot parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with sourceImage or sourceSnapshot,\nthe value of sizeGb must not be less than the size of the sourceImage\nor the size of the snapshot. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. For example, the following are\nvalid values:\n\n* \u0026#39;https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;global/snapshots/snapshot\u0026#39;\n* \u0026#39;snapshot\u0026#39; When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) 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-beta.google_compute_region_disk.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-beta.google_compute_region_disk.new` injects a new `google-beta_google_compute_region_disk` 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-beta.google_compute_region_disk.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_region_disk` using the reference:\n\n $._ref.google-beta_google_compute_region_disk.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_region_disk.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `interface` (`string`): Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. When `null`, the `interface` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key-\u0026gt;value pairs. When `null`, the `labels` 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 - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller\u0026#39;s project. When `null`, the `physical_block_size_bytes` 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 - `region` (`string`): A reference to the region where the disk resides. When `null`, the `region` field will be omitted from the resulting object.\n - `replica_zones` (`list`): URLs of the zones where the disk should be replicated to.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the sourceImage or\nsourceSnapshot parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with sourceImage or sourceSnapshot,\nthe value of sizeGb must not be less than the size of the sourceImage\nor the size of the snapshot. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. For example, the following are\nvalid values:\n\n* \u0026#39;https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;projects/project/global/snapshots/snapshot\u0026#39;\n* \u0026#39;global/snapshots/snapshot\u0026#39;\n* \u0026#39;snapshot\u0026#39; When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `async_primary_disk` (`list[obj]`): A nested object resource When `null`, the `async_primary_disk` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.async_primary_disk.new](#fn-async_primary_disknew) constructor.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) 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-beta.google_compute_region_disk.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, replica_zones, + async_primary_disk=null, description=null, disk_encryption_key=null, interface=null, @@ -35,6 +44,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='google_compute_region_disk', label=resourceLabel, attrs=self.newAttrs( + async_primary_disk=async_primary_disk, description=description, disk_encryption_key=disk_encryption_key, interface=interface, @@ -53,10 +63,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_region_disk.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_region_disk`\nTerraform resource.\n\nUnlike [google-beta.google_compute_region_disk.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `interface` (`string`): Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. When `null`, the `interface` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key->value pairs. When `null`, the `labels` 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 - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller's project. When `null`, the `physical_block_size_bytes` 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 - `region` (`string`): A reference to the region where the disk resides. When `null`, the `region` field will be omitted from the resulting object.\n - `replica_zones` (`list`): URLs of the zones where the disk should be replicated to.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the sourceImage or\nsourceSnapshot parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with sourceImage or sourceSnapshot,\nthe value of sizeGb must not be less than the size of the sourceImage\nor the size of the snapshot. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. For example, the following are\nvalid values:\n\n* 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot'\n* 'projects/project/global/snapshots/snapshot'\n* 'global/snapshots/snapshot'\n* 'snapshot' When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) 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-beta.google_compute_region_disk.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 `google_compute_region_disk` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_region_disk.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_region_disk`\nTerraform resource.\n\nUnlike [google-beta.google_compute_region_disk.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): An optional description of this resource. Provide this property when\nyou create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `interface` (`string`): Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. When `null`, the `interface` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels to apply to this disk. A list of key->value pairs. When `null`, the `labels` 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 - `physical_block_size_bytes` (`number`): Physical block size of the persistent disk, in bytes. If not present\nin a request, a default value is used. Currently supported sizes\nare 4096 and 16384, other sizes may be added in the future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller's project. When `null`, the `physical_block_size_bytes` 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 - `region` (`string`): A reference to the region where the disk resides. When `null`, the `region` field will be omitted from the resulting object.\n - `replica_zones` (`list`): URLs of the zones where the disk should be replicated to.\n - `size` (`number`): Size of the persistent disk, specified in GB. You can specify this\nfield when creating a persistent disk using the sourceImage or\nsourceSnapshot parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with sourceImage or sourceSnapshot,\nthe value of sizeGb must not be less than the size of the sourceImage\nor the size of the snapshot. When `null`, the `size` field will be omitted from the resulting object.\n - `snapshot` (`string`): The source snapshot used to create this disk. You can provide this as\na partial or full URL to the resource. For example, the following are\nvalid values:\n\n* 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot'\n* 'projects/project/global/snapshots/snapshot'\n* 'global/snapshots/snapshot'\n* 'snapshot' When `null`, the `snapshot` field will be omitted from the resulting object.\n - `source_disk` (`string`): The source disk used to create this disk. You can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n\n* https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}\n* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}\n* projects/{project}/zones/{zone}/disks/{disk}\n* projects/{project}/regions/{region}/disks/{disk}\n* zones/{zone}/disks/{disk}\n* regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object.\n - `type` (`string`): URL of the disk type resource describing which disk type to use to\ncreate the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object.\n - `async_primary_disk` (`list[obj]`): A nested object resource When `null`, the `async_primary_disk` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.async_primary_disk.new](#fn-async_primary_disknew) constructor.\n - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must\nprovide the same key if you use the disk later (e.g. to create a disk\nsnapshot or an image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe disk.\n\nIf you do not provide an encryption key when creating the disk, then\nthe disk will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the disk later. When `null`, the `disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.disk_encryption_key.new](#fn-disk_encryption_keynew) constructor.\n - `source_snapshot_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.source_snapshot_encryption_key.new](#fn-source_snapshot_encryption_keynew) 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-beta.google_compute_region_disk.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 `google_compute_region_disk` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, replica_zones, + async_primary_disk=null, description=null, disk_encryption_key=null, interface=null, @@ -71,6 +82,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts=null, type=null ):: std.prune(a={ + async_primary_disk: async_primary_disk, description: description, disk_encryption_key: disk_encryption_key, interface: interface, @@ -109,6 +121,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withAsyncPrimaryDisk':: d.fn(help='`google-beta.list[obj].withAsyncPrimaryDisk` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the async_primary_disk 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-beta.list[obj].withAsyncPrimaryDiskMixin](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 `async_primary_disk` field.\n', args=[]), + withAsyncPrimaryDisk(resourceLabel, value): { + resource+: { + google_compute_region_disk+: { + [resourceLabel]+: { + async_primary_disk: value, + }, + }, + }, + }, + '#withAsyncPrimaryDiskMixin':: d.fn(help='`google-beta.list[obj].withAsyncPrimaryDiskMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the async_primary_disk 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-beta.list[obj].withAsyncPrimaryDisk](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 `async_primary_disk` field.\n', args=[]), + withAsyncPrimaryDiskMixin(resourceLabel, value): { + resource+: { + google_compute_region_disk+: { + [resourceLabel]+: { + async_primary_disk+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withDescription':: d.fn(help='`google-beta.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+: { diff --git a/4.x/_gen/resources/compute_region_network_firewall_policy_rule.libsonnet b/4.x/_gen/resources/compute_region_network_firewall_policy_rule.libsonnet index b73e8561..5bc177b9 100644 --- a/4.x/_gen/resources/compute_region_network_firewall_policy_rule.libsonnet +++ b/4.x/_gen/resources/compute_region_network_firewall_policy_rule.libsonnet @@ -13,17 +13,33 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ports: ports, }), }, - '#new':: d.fn(help='\n`google-beta.google_compute_region_network_firewall_policy_rule.match.new` constructs a new object with attributes and blocks configured for the `match`\nTerraform sub block.\n\n\n\n**Args**:\n - `dest_ip_ranges` (`list`): CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. When `null`, the `dest_ip_ranges` field will be omitted from the resulting object.\n - `src_ip_ranges` (`list`): CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. When `null`, the `src_ip_ranges` field will be omitted from the resulting object.\n - `layer4_configs` (`list[obj]`): Pairs of IP protocols and ports that the rule should match. When `null`, the `layer4_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_network_firewall_policy_rule.match.layer4_configs.new](#fn-matchlayer4_configsnew) constructor.\n - `src_secure_tags` (`list[obj]`): List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the <code>srcSecureTag</code> are INEFFECTIVE, and there is no <code>srcIpRange</code>, this rule will be ignored. Maximum number of source tag values allowed is 256. When `null`, the `src_secure_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-beta.google_compute_region_network_firewall_policy_rule.match.src_secure_tags.new](#fn-matchsrc_secure_tagsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `match` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_compute_region_network_firewall_policy_rule.match.new` constructs a new object with attributes and blocks configured for the `match`\nTerraform sub block.\n\n\n\n**Args**:\n - `dest_address_groups` (`list`): Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules. When `null`, the `dest_address_groups` field will be omitted from the resulting object.\n - `dest_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_fqdns` field will be omitted from the resulting object.\n - `dest_ip_ranges` (`list`): CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. When `null`, the `dest_ip_ranges` field will be omitted from the resulting object.\n - `dest_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_region_codes` field will be omitted from the resulting object.\n - `dest_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `dest_threat_intelligences` field will be omitted from the resulting object.\n - `src_address_groups` (`list`): Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules. When `null`, the `src_address_groups` field will be omitted from the resulting object.\n - `src_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_fqdns` field will be omitted from the resulting object.\n - `src_ip_ranges` (`list`): CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. When `null`, the `src_ip_ranges` field will be omitted from the resulting object.\n - `src_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_region_codes` field will be omitted from the resulting object.\n - `src_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `src_threat_intelligences` field will be omitted from the resulting object.\n - `layer4_configs` (`list[obj]`): Pairs of IP protocols and ports that the rule should match. When `null`, the `layer4_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_network_firewall_policy_rule.match.layer4_configs.new](#fn-matchlayer4_configsnew) constructor.\n - `src_secure_tags` (`list[obj]`): List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the <code>srcSecureTag</code> are INEFFECTIVE, and there is no <code>srcIpRange</code>, this rule will be ignored. Maximum number of source tag values allowed is 256. When `null`, the `src_secure_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-beta.google_compute_region_network_firewall_policy_rule.match.src_secure_tags.new](#fn-matchsrc_secure_tagsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `match` sub block.\n', args=[]), new( + dest_address_groups=null, + dest_fqdns=null, dest_ip_ranges=null, + dest_region_codes=null, + dest_threat_intelligences=null, layer4_configs=null, + src_address_groups=null, + src_fqdns=null, src_ip_ranges=null, - src_secure_tags=null + src_region_codes=null, + src_secure_tags=null, + src_threat_intelligences=null ):: std.prune(a={ + dest_address_groups: dest_address_groups, + dest_fqdns: dest_fqdns, dest_ip_ranges: dest_ip_ranges, + dest_region_codes: dest_region_codes, + dest_threat_intelligences: dest_threat_intelligences, layer4_configs: layer4_configs, + src_address_groups: src_address_groups, + src_fqdns: src_fqdns, src_ip_ranges: src_ip_ranges, + src_region_codes: src_region_codes, src_secure_tags: src_secure_tags, + src_threat_intelligences: src_threat_intelligences, }), src_secure_tags:: { '#new':: d.fn(help='\n`google-beta.google_compute_region_network_firewall_policy_rule.match.src_secure_tags.new` constructs a new object with attributes and blocks configured for the `src_secure_tags`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the secure tag, created with TagManager's TagValue API. @pattern tagValues/[0-9]+\n\n**Returns**:\n - An attribute object that represents the `src_secure_tags` sub block.\n', args=[]), diff --git a/4.x/_gen/resources/compute_resource_policy.libsonnet b/4.x/_gen/resources/compute_resource_policy.libsonnet index 5889edfb..51e170bb 100644 --- a/4.x/_gen/resources/compute_resource_policy.libsonnet +++ b/4.x/_gen/resources/compute_resource_policy.libsonnet @@ -2,6 +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='google_compute_resource_policy', url='', help='`google_compute_resource_policy` represents the `google-beta_google_compute_resource_policy` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + disk_consistency_group_policy:: { + '#new':: d.fn(help='\n`google-beta.google_compute_resource_policy.disk_consistency_group_policy.new` constructs a new object with attributes and blocks configured for the `disk_consistency_group_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Enable disk consistency on the resource policy.\n\n**Returns**:\n - An attribute object that represents the `disk_consistency_group_policy` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, group_placement_policy:: { '#new':: d.fn(help='\n`google-beta.google_compute_resource_policy.group_placement_policy.new` constructs a new object with attributes and blocks configured for the `group_placement_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `availability_domain_count` (`number`): The number of availability domains instances will be spread across. If two instances are in different\navailability domain, they will not be put in the same low latency network When `null`, the `availability_domain_count` field will be omitted from the resulting object.\n - `collocation` (`string`): Collocation specifies whether to place VMs inside the same availability domain on the same low-latency network.\nSpecify 'COLLOCATED' to enable collocation. Can only be specified with 'vm_count'. If compute instances are created\nwith a COLLOCATED policy, then exactly 'vm_count' instances must be created at the same time with the resource policy\nattached. Possible values: ["COLLOCATED"] When `null`, the `collocation` field will be omitted from the resulting object.\n - `max_distance` (`number`): Specifies the number of max logical switches. When `null`, the `max_distance` field will be omitted from the resulting object.\n - `vm_count` (`number`): Number of VMs in this placement group. Google does not recommend that you use this field\nunless you use a compact policy and you want your policy to work only if it contains this\nexact number of VMs. When `null`, the `vm_count` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `group_placement_policy` sub block.\n', args=[]), new( @@ -48,11 +56,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help="\n`google-beta.google_compute_resource_policy.new` injects a new `google-beta_google_compute_resource_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-beta.google_compute_resource_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_resource_policy` using the reference:\n\n $._ref.google-beta_google_compute_resource_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_resource_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 - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): The name of the resource, provided by the client when initially creating\nthe resource. The resource name must be 1-63 characters long, and comply\nwith RFC1035. Specifically, the name must be 1-63 characters long and\nmatch the 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 characters\nmust be a dash, lowercase letter, or digit, except the last character,\nwhich 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 - `region` (`string`): Region where resource policy resides. When `null`, the `region` field will be omitted from the resulting object.\n - `group_placement_policy` (`list[obj]`): Resource policy for instances used for placement configuration. When `null`, the `group_placement_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-beta.google_compute_resource_policy.group_placement_policy.new](#fn-group_placement_policynew) constructor.\n - `instance_schedule_policy` (`list[obj]`): Resource policy for scheduling instance operations. When `null`, the `instance_schedule_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-beta.google_compute_resource_policy.instance_schedule_policy.new](#fn-instance_schedule_policynew) constructor.\n - `snapshot_schedule_policy` (`list[obj]`): Policy for creating snapshots of persistent disks. When `null`, the `snapshot_schedule_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-beta.google_compute_resource_policy.snapshot_schedule_policy.new](#fn-snapshot_schedule_policynew) 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-beta.google_compute_resource_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_compute_resource_policy.new` injects a new `google-beta_google_compute_resource_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-beta.google_compute_resource_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_resource_policy` using the reference:\n\n $._ref.google-beta_google_compute_resource_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_resource_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 - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): The name of the resource, provided by the client when initially creating\nthe resource. The resource name must be 1-63 characters long, and comply\nwith RFC1035. Specifically, the name must be 1-63 characters long and\nmatch the 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 characters\nmust be a dash, lowercase letter, or digit, except the last character,\nwhich 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 - `region` (`string`): Region where resource policy resides. When `null`, the `region` field will be omitted from the resulting object.\n - `disk_consistency_group_policy` (`list[obj]`): Replication consistency group for asynchronous disk replication. When `null`, the `disk_consistency_group_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-beta.google_compute_resource_policy.disk_consistency_group_policy.new](#fn-disk_consistency_group_policynew) constructor.\n - `group_placement_policy` (`list[obj]`): Resource policy for instances used for placement configuration. When `null`, the `group_placement_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-beta.google_compute_resource_policy.group_placement_policy.new](#fn-group_placement_policynew) constructor.\n - `instance_schedule_policy` (`list[obj]`): Resource policy for scheduling instance operations. When `null`, the `instance_schedule_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-beta.google_compute_resource_policy.instance_schedule_policy.new](#fn-instance_schedule_policynew) constructor.\n - `snapshot_schedule_policy` (`list[obj]`): Policy for creating snapshots of persistent disks. When `null`, the `snapshot_schedule_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-beta.google_compute_resource_policy.snapshot_schedule_policy.new](#fn-snapshot_schedule_policynew) 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-beta.google_compute_resource_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, description=null, + disk_consistency_group_policy=null, group_placement_policy=null, instance_schedule_policy=null, project=null, @@ -65,6 +74,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); label=resourceLabel, attrs=self.newAttrs( description=description, + disk_consistency_group_policy=disk_consistency_group_policy, group_placement_policy=group_placement_policy, instance_schedule_policy=instance_schedule_policy, name=name, @@ -75,10 +85,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_resource_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_resource_policy`\nTerraform resource.\n\nUnlike [google-beta.google_compute_resource_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 - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): The name of the resource, provided by the client when initially creating\nthe resource. The resource name must be 1-63 characters long, and comply\nwith RFC1035. Specifically, the name must be 1-63 characters long and\nmatch the regular expression '[a-z]([-a-z0-9]*[a-z0-9])'? which means the\nfirst character must be a lowercase letter, and all following characters\nmust be a dash, lowercase letter, or digit, except the last character,\nwhich 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 - `region` (`string`): Region where resource policy resides. When `null`, the `region` field will be omitted from the resulting object.\n - `group_placement_policy` (`list[obj]`): Resource policy for instances used for placement configuration. When `null`, the `group_placement_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-beta.google_compute_resource_policy.group_placement_policy.new](#fn-group_placement_policynew) constructor.\n - `instance_schedule_policy` (`list[obj]`): Resource policy for scheduling instance operations. When `null`, the `instance_schedule_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-beta.google_compute_resource_policy.instance_schedule_policy.new](#fn-instance_schedule_policynew) constructor.\n - `snapshot_schedule_policy` (`list[obj]`): Policy for creating snapshots of persistent disks. When `null`, the `snapshot_schedule_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-beta.google_compute_resource_policy.snapshot_schedule_policy.new](#fn-snapshot_schedule_policynew) 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-beta.google_compute_resource_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_compute_resource_policy` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_resource_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_resource_policy`\nTerraform resource.\n\nUnlike [google-beta.google_compute_resource_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 - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): The name of the resource, provided by the client when initially creating\nthe resource. The resource name must be 1-63 characters long, and comply\nwith RFC1035. Specifically, the name must be 1-63 characters long and\nmatch the regular expression '[a-z]([-a-z0-9]*[a-z0-9])'? which means the\nfirst character must be a lowercase letter, and all following characters\nmust be a dash, lowercase letter, or digit, except the last character,\nwhich 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 - `region` (`string`): Region where resource policy resides. When `null`, the `region` field will be omitted from the resulting object.\n - `disk_consistency_group_policy` (`list[obj]`): Replication consistency group for asynchronous disk replication. When `null`, the `disk_consistency_group_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-beta.google_compute_resource_policy.disk_consistency_group_policy.new](#fn-disk_consistency_group_policynew) constructor.\n - `group_placement_policy` (`list[obj]`): Resource policy for instances used for placement configuration. When `null`, the `group_placement_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-beta.google_compute_resource_policy.group_placement_policy.new](#fn-group_placement_policynew) constructor.\n - `instance_schedule_policy` (`list[obj]`): Resource policy for scheduling instance operations. When `null`, the `instance_schedule_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-beta.google_compute_resource_policy.instance_schedule_policy.new](#fn-instance_schedule_policynew) constructor.\n - `snapshot_schedule_policy` (`list[obj]`): Policy for creating snapshots of persistent disks. When `null`, the `snapshot_schedule_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-beta.google_compute_resource_policy.snapshot_schedule_policy.new](#fn-snapshot_schedule_policynew) 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-beta.google_compute_resource_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_compute_resource_policy` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, description=null, + disk_consistency_group_policy=null, group_placement_policy=null, instance_schedule_policy=null, project=null, @@ -87,6 +98,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts=null ):: std.prune(a={ description: description, + disk_consistency_group_policy: disk_consistency_group_policy, group_placement_policy: group_placement_policy, instance_schedule_policy: instance_schedule_policy, name: name, @@ -167,7 +179,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, snapshot_properties:: { - '#new':: d.fn(help='\n`google-beta.google_compute_resource_policy.snapshot_schedule_policy.snapshot_properties.new` constructs a new object with attributes and blocks configured for the `snapshot_properties`\nTerraform sub block.\n\n\n\n**Args**:\n - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the \nspecified name. The chain name must be 1-63 characters long and comply \nwith RFC1035. When `null`, the `chain_name` field will be omitted from the resulting object.\n - `guest_flush` (`bool`): Whether to perform a 'guest aware' snapshot. When `null`, the `guest_flush` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key-value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `storage_locations` (`list`): Cloud Storage bucket location to store the auto snapshot\n(regional or multi-regional) When `null`, the `storage_locations` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `snapshot_properties` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_compute_resource_policy.snapshot_schedule_policy.snapshot_properties.new` constructs a new object with attributes and blocks configured for the `snapshot_properties`\nTerraform sub block.\n\n\n\n**Args**:\n - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the\nspecified name. The chain name must be 1-63 characters long and comply\nwith RFC1035. When `null`, the `chain_name` field will be omitted from the resulting object.\n - `guest_flush` (`bool`): Whether to perform a 'guest aware' snapshot. When `null`, the `guest_flush` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key-value pairs. When `null`, the `labels` field will be omitted from the resulting object.\n - `storage_locations` (`list`): Cloud Storage bucket location to store the auto snapshot\n(regional or multi-regional) When `null`, the `storage_locations` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `snapshot_properties` sub block.\n', args=[]), new( chain_name=null, guest_flush=null, @@ -201,6 +213,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withDiskConsistencyGroupPolicy':: d.fn(help='`google-beta.list[obj].withDiskConsistencyGroupPolicy` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the disk_consistency_group_policy 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-beta.list[obj].withDiskConsistencyGroupPolicyMixin](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 `disk_consistency_group_policy` field.\n', args=[]), + withDiskConsistencyGroupPolicy(resourceLabel, value): { + resource+: { + google_compute_resource_policy+: { + [resourceLabel]+: { + disk_consistency_group_policy: value, + }, + }, + }, + }, + '#withDiskConsistencyGroupPolicyMixin':: d.fn(help='`google-beta.list[obj].withDiskConsistencyGroupPolicyMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the disk_consistency_group_policy 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-beta.list[obj].withDiskConsistencyGroupPolicy](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 `disk_consistency_group_policy` field.\n', args=[]), + withDiskConsistencyGroupPolicyMixin(resourceLabel, value): { + resource+: { + google_compute_resource_policy+: { + [resourceLabel]+: { + disk_consistency_group_policy+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withGroupPlacementPolicy':: d.fn(help='`google-beta.list[obj].withGroupPlacementPolicy` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the group_placement_policy 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-beta.list[obj].withGroupPlacementPolicyMixin](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 `group_placement_policy` field.\n', args=[]), withGroupPlacementPolicy(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/compute_router_peer.libsonnet b/4.x/_gen/resources/compute_router_peer.libsonnet index 73e6d231..d300f32c 100644 --- a/4.x/_gen/resources/compute_router_peer.libsonnet +++ b/4.x/_gen/resources/compute_router_peer.libsonnet @@ -26,7 +26,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); session_initialization_mode: session_initialization_mode, }), }, - '#new':: d.fn(help="\n`google-beta.google_compute_router_peer.new` injects a new `google-beta_google_compute_router_peer` 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-beta.google_compute_router_peer.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_router_peer` using the reference:\n\n $._ref.google-beta_google_compute_router_peer.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_router_peer.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 - `advertise_mode` (`string`): User-specified flag to indicate which mode to use for advertisement.\nValid values of this enum field are: \u0026#39;DEFAULT\u0026#39;, \u0026#39;CUSTOM\u0026#39; Default value: \u0026#34;DEFAULT\u0026#34; Possible values: [\u0026#34;DEFAULT\u0026#34;, \u0026#34;CUSTOM\u0026#34;] When `null`, the `advertise_mode` field will be omitted from the resulting object.\n - `advertised_groups` (`list`): User-specified list of prefix groups to advertise in custom\nmode, which can take one of the following options:\n\n* \u0026#39;ALL_SUBNETS\u0026#39;: Advertises all available subnets, including peer VPC subnets.\n* \u0026#39;ALL_VPC_SUBNETS\u0026#39;: Advertises the router\u0026#39;s own VPC subnets.\n* \u0026#39;ALL_PEER_VPC_SUBNETS\u0026#39;: Advertises peer subnets of the router\u0026#39;s VPC network.\n\n\nNote that this field can only be populated if advertiseMode is \u0026#39;CUSTOM\u0026#39;\nand overrides the list defined for the router (in the \u0026#34;bgp\u0026#34; message).\nThese groups are advertised in addition to any specified prefixes.\nLeave this field blank to advertise no custom groups. When `null`, the `advertised_groups` field will be omitted from the resulting object.\n - `advertised_route_priority` (`number`): The priority of routes advertised to this BGP peer.\nWhere there is more than one matching route of maximum\nlength, the routes with the lowest priority value win. When `null`, the `advertised_route_priority` field will be omitted from the resulting object.\n - `enable` (`bool`): The status of the BGP peer connection. If set to false, any active session\nwith the peer is terminated and all associated routing information is removed.\nIf set to true, the peer connection can be established with routing information.\nThe default is true. When `null`, the `enable` field will be omitted from the resulting object.\n - `interface` (`string`): Name of the interface the BGP peer is associated with.\n - `ip_address` (`string`): IP address of the interface inside Google Cloud Platform.\nOnly IPv4 is supported. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `name` (`string`): Name of this BGP peer. The name must be 1-63 characters long,\nand comply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which\nmeans the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `peer_asn` (`number`): Peer BGP Autonomous System Number (ASN).\nEach BGP interface may use a different value.\n - `peer_ip_address` (`string`): IP address of the BGP interface outside Google Cloud Platform.\nOnly IPv4 is supported.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): Region where the router and BgpPeer reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `router` (`string`): The name of the Cloud Router in which this BgpPeer will be configured.\n - `router_appliance_instance` (`string`): The URI of the VM instance that is used as third-party router appliances\nsuch as Next Gen Firewalls, Virtual Routers, or Router Appliances.\nThe VM instance must be located in zones contained in the same region as\nthis Cloud Router. The VM instance is the peer side of the BGP session. When `null`, the `router_appliance_instance` field will be omitted from the resulting object.\n - `advertised_ip_ranges` (`list[obj]`): User-specified list of individual IP ranges to advertise in\ncustom mode. This field can only be populated if advertiseMode\nis \u0026#39;CUSTOM\u0026#39; and is advertised to all peers of the router. These IP\nranges will be advertised in addition to any specified groups.\nLeave this field blank to advertise no custom IP ranges. When `null`, the `advertised_ip_ranges` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.advertised_ip_ranges.new](#fn-advertised_ip_rangesnew) constructor.\n - `bfd` (`list[obj]`): BFD configuration for the BGP peering. When `null`, the `bfd` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.bfd.new](#fn-bfdnew) 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-beta.google_compute_router_peer.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-beta.google_compute_router_peer.new` injects a new `google-beta_google_compute_router_peer` 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-beta.google_compute_router_peer.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_router_peer` using the reference:\n\n $._ref.google-beta_google_compute_router_peer.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_router_peer.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 - `advertise_mode` (`string`): User-specified flag to indicate which mode to use for advertisement.\nValid values of this enum field are: \u0026#39;DEFAULT\u0026#39;, \u0026#39;CUSTOM\u0026#39; Default value: \u0026#34;DEFAULT\u0026#34; Possible values: [\u0026#34;DEFAULT\u0026#34;, \u0026#34;CUSTOM\u0026#34;] When `null`, the `advertise_mode` field will be omitted from the resulting object.\n - `advertised_groups` (`list`): User-specified list of prefix groups to advertise in custom\nmode, which can take one of the following options:\n\n* \u0026#39;ALL_SUBNETS\u0026#39;: Advertises all available subnets, including peer VPC subnets.\n* \u0026#39;ALL_VPC_SUBNETS\u0026#39;: Advertises the router\u0026#39;s own VPC subnets.\n* \u0026#39;ALL_PEER_VPC_SUBNETS\u0026#39;: Advertises peer subnets of the router\u0026#39;s VPC network.\n\n\nNote that this field can only be populated if advertiseMode is \u0026#39;CUSTOM\u0026#39;\nand overrides the list defined for the router (in the \u0026#34;bgp\u0026#34; message).\nThese groups are advertised in addition to any specified prefixes.\nLeave this field blank to advertise no custom groups. When `null`, the `advertised_groups` field will be omitted from the resulting object.\n - `advertised_route_priority` (`number`): The priority of routes advertised to this BGP peer.\nWhere there is more than one matching route of maximum\nlength, the routes with the lowest priority value win. When `null`, the `advertised_route_priority` field will be omitted from the resulting object.\n - `enable` (`bool`): The status of the BGP peer connection. If set to false, any active session\nwith the peer is terminated and all associated routing information is removed.\nIf set to true, the peer connection can be established with routing information.\nThe default is true. When `null`, the `enable` field will be omitted from the resulting object.\n - `enable_ipv6` (`bool`): Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. When `null`, the `enable_ipv6` field will be omitted from the resulting object.\n - `interface` (`string`): Name of the interface the BGP peer is associated with.\n - `ip_address` (`string`): IP address of the interface inside Google Cloud Platform.\nOnly IPv4 is supported. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ipv6_nexthop_address` (`string`): IPv6 address of the interface inside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `ipv6_nexthop_address` field will be omitted from the resulting object.\n - `name` (`string`): Name of this BGP peer. The name must be 1-63 characters long,\nand comply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which\nmeans the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `peer_asn` (`number`): Peer BGP Autonomous System Number (ASN).\nEach BGP interface may use a different value.\n - `peer_ip_address` (`string`): IP address of the BGP interface outside Google Cloud Platform.\nOnly IPv4 is supported.\n - `peer_ipv6_nexthop_address` (`string`): IPv6 address of the BGP interface outside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `peer_ipv6_nexthop_address` 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 - `region` (`string`): Region where the router and BgpPeer reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `router` (`string`): The name of the Cloud Router in which this BgpPeer will be configured.\n - `router_appliance_instance` (`string`): The URI of the VM instance that is used as third-party router appliances\nsuch as Next Gen Firewalls, Virtual Routers, or Router Appliances.\nThe VM instance must be located in zones contained in the same region as\nthis Cloud Router. The VM instance is the peer side of the BGP session. When `null`, the `router_appliance_instance` field will be omitted from the resulting object.\n - `advertised_ip_ranges` (`list[obj]`): User-specified list of individual IP ranges to advertise in\ncustom mode. This field can only be populated if advertiseMode\nis \u0026#39;CUSTOM\u0026#39; and is advertised to all peers of the router. These IP\nranges will be advertised in addition to any specified groups.\nLeave this field blank to advertise no custom IP ranges. When `null`, the `advertised_ip_ranges` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.advertised_ip_ranges.new](#fn-advertised_ip_rangesnew) constructor.\n - `bfd` (`list[obj]`): BFD configuration for the BGP peering. When `null`, the `bfd` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.bfd.new](#fn-bfdnew) 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-beta.google_compute_router_peer.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, interface, @@ -40,7 +40,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); advertised_route_priority=null, bfd=null, enable=null, + enable_ipv6=null, ip_address=null, + ipv6_nexthop_address=null, + peer_ipv6_nexthop_address=null, project=null, region=null, router_appliance_instance=null, @@ -56,11 +59,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); advertised_route_priority=advertised_route_priority, bfd=bfd, enable=enable, + enable_ipv6=enable_ipv6, interface=interface, ip_address=ip_address, + ipv6_nexthop_address=ipv6_nexthop_address, name=name, peer_asn=peer_asn, peer_ip_address=peer_ip_address, + peer_ipv6_nexthop_address=peer_ipv6_nexthop_address, project=project, region=region, router=router, @@ -69,7 +75,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_router_peer.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_router_peer`\nTerraform resource.\n\nUnlike [google-beta.google_compute_router_peer.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 - `advertise_mode` (`string`): User-specified flag to indicate which mode to use for advertisement.\nValid values of this enum field are: 'DEFAULT', 'CUSTOM' Default value: "DEFAULT" Possible values: ["DEFAULT", "CUSTOM"] When `null`, the `advertise_mode` field will be omitted from the resulting object.\n - `advertised_groups` (`list`): User-specified list of prefix groups to advertise in custom\nmode, which can take one of the following options:\n\n* 'ALL_SUBNETS': Advertises all available subnets, including peer VPC subnets.\n* 'ALL_VPC_SUBNETS': Advertises the router's own VPC subnets.\n* 'ALL_PEER_VPC_SUBNETS': Advertises peer subnets of the router's VPC network.\n\n\nNote that this field can only be populated if advertiseMode is 'CUSTOM'\nand overrides the list defined for the router (in the "bgp" message).\nThese groups are advertised in addition to any specified prefixes.\nLeave this field blank to advertise no custom groups. When `null`, the `advertised_groups` field will be omitted from the resulting object.\n - `advertised_route_priority` (`number`): The priority of routes advertised to this BGP peer.\nWhere there is more than one matching route of maximum\nlength, the routes with the lowest priority value win. When `null`, the `advertised_route_priority` field will be omitted from the resulting object.\n - `enable` (`bool`): The status of the BGP peer connection. If set to false, any active session\nwith the peer is terminated and all associated routing information is removed.\nIf set to true, the peer connection can be established with routing information.\nThe default is true. When `null`, the `enable` field will be omitted from the resulting object.\n - `interface` (`string`): Name of the interface the BGP peer is associated with.\n - `ip_address` (`string`): IP address of the interface inside Google Cloud Platform.\nOnly IPv4 is supported. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `name` (`string`): Name of this BGP peer. The name must be 1-63 characters long,\nand comply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which\nmeans the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `peer_asn` (`number`): Peer BGP Autonomous System Number (ASN).\nEach BGP interface may use a different value.\n - `peer_ip_address` (`string`): IP address of the BGP interface outside Google Cloud Platform.\nOnly IPv4 is supported.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): Region where the router and BgpPeer reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `router` (`string`): The name of the Cloud Router in which this BgpPeer will be configured.\n - `router_appliance_instance` (`string`): The URI of the VM instance that is used as third-party router appliances\nsuch as Next Gen Firewalls, Virtual Routers, or Router Appliances.\nThe VM instance must be located in zones contained in the same region as\nthis Cloud Router. The VM instance is the peer side of the BGP session. When `null`, the `router_appliance_instance` field will be omitted from the resulting object.\n - `advertised_ip_ranges` (`list[obj]`): User-specified list of individual IP ranges to advertise in\ncustom mode. This field can only be populated if advertiseMode\nis 'CUSTOM' and is advertised to all peers of the router. These IP\nranges will be advertised in addition to any specified groups.\nLeave this field blank to advertise no custom IP ranges. When `null`, the `advertised_ip_ranges` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.advertised_ip_ranges.new](#fn-advertised_ip_rangesnew) constructor.\n - `bfd` (`list[obj]`): BFD configuration for the BGP peering. When `null`, the `bfd` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.bfd.new](#fn-bfdnew) 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-beta.google_compute_router_peer.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 `google_compute_router_peer` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_router_peer.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_router_peer`\nTerraform resource.\n\nUnlike [google-beta.google_compute_router_peer.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 - `advertise_mode` (`string`): User-specified flag to indicate which mode to use for advertisement.\nValid values of this enum field are: 'DEFAULT', 'CUSTOM' Default value: "DEFAULT" Possible values: ["DEFAULT", "CUSTOM"] When `null`, the `advertise_mode` field will be omitted from the resulting object.\n - `advertised_groups` (`list`): User-specified list of prefix groups to advertise in custom\nmode, which can take one of the following options:\n\n* 'ALL_SUBNETS': Advertises all available subnets, including peer VPC subnets.\n* 'ALL_VPC_SUBNETS': Advertises the router's own VPC subnets.\n* 'ALL_PEER_VPC_SUBNETS': Advertises peer subnets of the router's VPC network.\n\n\nNote that this field can only be populated if advertiseMode is 'CUSTOM'\nand overrides the list defined for the router (in the "bgp" message).\nThese groups are advertised in addition to any specified prefixes.\nLeave this field blank to advertise no custom groups. When `null`, the `advertised_groups` field will be omitted from the resulting object.\n - `advertised_route_priority` (`number`): The priority of routes advertised to this BGP peer.\nWhere there is more than one matching route of maximum\nlength, the routes with the lowest priority value win. When `null`, the `advertised_route_priority` field will be omitted from the resulting object.\n - `enable` (`bool`): The status of the BGP peer connection. If set to false, any active session\nwith the peer is terminated and all associated routing information is removed.\nIf set to true, the peer connection can be established with routing information.\nThe default is true. When `null`, the `enable` field will be omitted from the resulting object.\n - `enable_ipv6` (`bool`): Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. When `null`, the `enable_ipv6` field will be omitted from the resulting object.\n - `interface` (`string`): Name of the interface the BGP peer is associated with.\n - `ip_address` (`string`): IP address of the interface inside Google Cloud Platform.\nOnly IPv4 is supported. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ipv6_nexthop_address` (`string`): IPv6 address of the interface inside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `ipv6_nexthop_address` field will be omitted from the resulting object.\n - `name` (`string`): Name of this BGP peer. The name must be 1-63 characters long,\nand comply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which\nmeans the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `peer_asn` (`number`): Peer BGP Autonomous System Number (ASN).\nEach BGP interface may use a different value.\n - `peer_ip_address` (`string`): IP address of the BGP interface outside Google Cloud Platform.\nOnly IPv4 is supported.\n - `peer_ipv6_nexthop_address` (`string`): IPv6 address of the BGP interface outside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `peer_ipv6_nexthop_address` 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 - `region` (`string`): Region where the router and BgpPeer reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `router` (`string`): The name of the Cloud Router in which this BgpPeer will be configured.\n - `router_appliance_instance` (`string`): The URI of the VM instance that is used as third-party router appliances\nsuch as Next Gen Firewalls, Virtual Routers, or Router Appliances.\nThe VM instance must be located in zones contained in the same region as\nthis Cloud Router. The VM instance is the peer side of the BGP session. When `null`, the `router_appliance_instance` field will be omitted from the resulting object.\n - `advertised_ip_ranges` (`list[obj]`): User-specified list of individual IP ranges to advertise in\ncustom mode. This field can only be populated if advertiseMode\nis 'CUSTOM' and is advertised to all peers of the router. These IP\nranges will be advertised in addition to any specified groups.\nLeave this field blank to advertise no custom IP ranges. When `null`, the `advertised_ip_ranges` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.advertised_ip_ranges.new](#fn-advertised_ip_rangesnew) constructor.\n - `bfd` (`list[obj]`): BFD configuration for the BGP peering. When `null`, the `bfd` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.bfd.new](#fn-bfdnew) 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-beta.google_compute_router_peer.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 `google_compute_router_peer` resource into the root Terraform configuration.\n', args=[]), newAttrs( interface, name, @@ -82,7 +88,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); advertised_route_priority=null, bfd=null, enable=null, + enable_ipv6=null, ip_address=null, + ipv6_nexthop_address=null, + peer_ipv6_nexthop_address=null, project=null, region=null, router_appliance_instance=null, @@ -94,11 +103,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); advertised_route_priority: advertised_route_priority, bfd: bfd, enable: enable, + enable_ipv6: enable_ipv6, interface: interface, ip_address: ip_address, + ipv6_nexthop_address: ipv6_nexthop_address, name: name, peer_asn: peer_asn, peer_ip_address: peer_ip_address, + peer_ipv6_nexthop_address: peer_ipv6_nexthop_address, project: project, region: region, router: router, @@ -197,6 +209,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withEnableIpv6':: d.fn(help='`google-beta.bool.withEnableIpv6` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the enable_ipv6 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 `enable_ipv6` field.\n', args=[]), + withEnableIpv6(resourceLabel, value): { + resource+: { + google_compute_router_peer+: { + [resourceLabel]+: { + enable_ipv6: value, + }, + }, + }, + }, '#withInterface':: d.fn(help='`google-beta.string.withInterface` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the interface 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 `interface` field.\n', args=[]), withInterface(resourceLabel, value): { resource+: { @@ -217,6 +239,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withIpv6NexthopAddress':: d.fn(help='`google-beta.string.withIpv6NexthopAddress` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the ipv6_nexthop_address 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 `ipv6_nexthop_address` field.\n', args=[]), + withIpv6NexthopAddress(resourceLabel, value): { + resource+: { + google_compute_router_peer+: { + [resourceLabel]+: { + ipv6_nexthop_address: value, + }, + }, + }, + }, '#withName':: d.fn(help='`google-beta.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+: { @@ -247,6 +279,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withPeerIpv6NexthopAddress':: d.fn(help='`google-beta.string.withPeerIpv6NexthopAddress` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the peer_ipv6_nexthop_address 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 `peer_ipv6_nexthop_address` field.\n', args=[]), + withPeerIpv6NexthopAddress(resourceLabel, value): { + resource+: { + google_compute_router_peer+: { + [resourceLabel]+: { + peer_ipv6_nexthop_address: value, + }, + }, + }, + }, '#withProject':: d.fn(help='`google-beta.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/compute_snapshot.libsonnet b/4.x/_gen/resources/compute_snapshot.libsonnet index 146500e7..9849f764 100644 --- a/4.x/_gen/resources/compute_snapshot.libsonnet +++ b/4.x/_gen/resources/compute_snapshot.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='google_compute_snapshot', url='', help='`google_compute_snapshot` represents the `google-beta_google_compute_snapshot` 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-beta.google_compute_snapshot.new` injects a new `google-beta_google_compute_snapshot` 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-beta.google_compute_snapshot.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_snapshot` using the reference:\n\n $._ref.google-beta_google_compute_snapshot.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_snapshot.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 - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the \nspecified name. The chain name must be 1-63 characters long and \ncomply with RFC1035. This is an uncommon option only for advanced \nservice owners who needs to create separate snapshot chains, for \nexample, for chargeback tracking. When you describe your snapshot \nresource, this field is visible only if it has a non-empty value. When `null`, the `chain_name` 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 - `labels` (`obj`): Labels to apply to this Snapshot. When `null`, the `labels` 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 - `source_disk` (`string`): A reference to the disk used to create this snapshot.\n - `storage_locations` (`list`): Cloud Storage bucket storage location of the snapshot (regional or multi-regional). When `null`, the `storage_locations` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk is hosted. When `null`, the `zone` field will be omitted from the resulting object.\n - `snapshot_encryption_key` (`list[obj]`): Encrypts the snapshot using a customer-supplied encryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must\nprovide the same key if you use the snapshot later. For example, you\nmust provide the encryption key when you create a disk from the\nencrypted snapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe snapshot.\n\nIf you do not provide an encryption key when creating the snapshot,\nthen the snapshot will be encrypted using an automatically generated\nkey and you do not need to provide a key to use the snapshot later. When `null`, the `snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_snapshot.snapshot_encryption_key.new](#fn-snapshot_encryption_keynew) constructor.\n - `source_disk_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_snapshot.source_disk_encryption_key.new](#fn-source_disk_encryption_keynew) 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-beta.google_compute_snapshot.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-beta.google_compute_snapshot.new` injects a new `google-beta_google_compute_snapshot` 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-beta.google_compute_snapshot.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_snapshot` using the reference:\n\n $._ref.google-beta_google_compute_snapshot.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_snapshot.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 - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the\nspecified name. The chain name must be 1-63 characters long and\ncomply with RFC1035. This is an uncommon option only for advanced\nservice owners who needs to create separate snapshot chains, for\nexample, for chargeback tracking. When you describe your snapshot\nresource, this field is visible only if it has a non-empty value. When `null`, the `chain_name` 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 - `labels` (`obj`): Labels to apply to this Snapshot. When `null`, the `labels` 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 - `source_disk` (`string`): A reference to the disk used to create this snapshot.\n - `storage_locations` (`list`): Cloud Storage bucket storage location of the snapshot (regional or multi-regional). When `null`, the `storage_locations` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk is hosted. When `null`, the `zone` field will be omitted from the resulting object.\n - `snapshot_encryption_key` (`list[obj]`): Encrypts the snapshot using a customer-supplied encryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must\nprovide the same key if you use the snapshot later. For example, you\nmust provide the encryption key when you create a disk from the\nencrypted snapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe snapshot.\n\nIf you do not provide an encryption key when creating the snapshot,\nthen the snapshot will be encrypted using an automatically generated\nkey and you do not need to provide a key to use the snapshot later. When `null`, the `snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_snapshot.snapshot_encryption_key.new](#fn-snapshot_encryption_keynew) constructor.\n - `source_disk_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_snapshot.source_disk_encryption_key.new](#fn-source_disk_encryption_keynew) 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-beta.google_compute_snapshot.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, @@ -35,7 +35,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_snapshot.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_snapshot`\nTerraform resource.\n\nUnlike [google-beta.google_compute_snapshot.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 - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the \nspecified name. The chain name must be 1-63 characters long and \ncomply with RFC1035. This is an uncommon option only for advanced \nservice owners who needs to create separate snapshot chains, for \nexample, for chargeback tracking. When you describe your snapshot \nresource, this field is visible only if it has a non-empty value. When `null`, the `chain_name` 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 - `labels` (`obj`): Labels to apply to this Snapshot. When `null`, the `labels` 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 - `source_disk` (`string`): A reference to the disk used to create this snapshot.\n - `storage_locations` (`list`): Cloud Storage bucket storage location of the snapshot (regional or multi-regional). When `null`, the `storage_locations` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk is hosted. When `null`, the `zone` field will be omitted from the resulting object.\n - `snapshot_encryption_key` (`list[obj]`): Encrypts the snapshot using a customer-supplied encryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must\nprovide the same key if you use the snapshot later. For example, you\nmust provide the encryption key when you create a disk from the\nencrypted snapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe snapshot.\n\nIf you do not provide an encryption key when creating the snapshot,\nthen the snapshot will be encrypted using an automatically generated\nkey and you do not need to provide a key to use the snapshot later. When `null`, the `snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_snapshot.snapshot_encryption_key.new](#fn-snapshot_encryption_keynew) constructor.\n - `source_disk_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_snapshot.source_disk_encryption_key.new](#fn-source_disk_encryption_keynew) 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-beta.google_compute_snapshot.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 `google_compute_snapshot` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_snapshot.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_snapshot`\nTerraform resource.\n\nUnlike [google-beta.google_compute_snapshot.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 - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the\nspecified name. The chain name must be 1-63 characters long and\ncomply with RFC1035. This is an uncommon option only for advanced\nservice owners who needs to create separate snapshot chains, for\nexample, for chargeback tracking. When you describe your snapshot\nresource, this field is visible only if it has a non-empty value. When `null`, the `chain_name` 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 - `labels` (`obj`): Labels to apply to this Snapshot. When `null`, the `labels` 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 - `source_disk` (`string`): A reference to the disk used to create this snapshot.\n - `storage_locations` (`list`): Cloud Storage bucket storage location of the snapshot (regional or multi-regional). When `null`, the `storage_locations` field will be omitted from the resulting object.\n - `zone` (`string`): A reference to the zone where the disk is hosted. When `null`, the `zone` field will be omitted from the resulting object.\n - `snapshot_encryption_key` (`list[obj]`): Encrypts the snapshot using a customer-supplied encryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must\nprovide the same key if you use the snapshot later. For example, you\nmust provide the encryption key when you create a disk from the\nencrypted snapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata of\nthe snapshot.\n\nIf you do not provide an encryption key when creating the snapshot,\nthen the snapshot will be encrypted using an automatically generated\nkey and you do not need to provide a key to use the snapshot later. When `null`, the `snapshot_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_snapshot.snapshot_encryption_key.new](#fn-snapshot_encryption_keynew) constructor.\n - `source_disk_encryption_key` (`list[obj]`): The customer-supplied encryption key of the source snapshot. Required\nif the source snapshot is protected by a customer-supplied encryption\nkey. When `null`, the `source_disk_encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_snapshot.source_disk_encryption_key.new](#fn-source_disk_encryption_keynew) 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-beta.google_compute_snapshot.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 `google_compute_snapshot` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, source_disk, diff --git a/4.x/_gen/resources/compute_target_https_proxy.libsonnet b/4.x/_gen/resources/compute_target_https_proxy.libsonnet index 57bba399..68a059f3 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='google_compute_target_https_proxy', url='', help='`google_compute_target_https_proxy` represents the `google-beta_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-beta.google_compute_target_https_proxy.new` injects a new `google-beta_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-beta.google_compute_target_https_proxy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_target_https_proxy` using the reference:\n\n $._ref.google-beta_google_compute_target_https_proxy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_target_https_proxy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map \nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is \u0026#39;//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}\u0026#39;. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, Google manages whether QUIC is used. Default value: \u0026#34;NONE\u0026#34; Possible values: [\u0026#34;NONE\u0026#34;, \u0026#34;ENABLE\u0026#34;, \u0026#34;DISABLE\u0026#34;] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resources that are used to authenticate\nconnections between users and the load balancer. At least one SSL\ncertificate must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.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-beta.google_compute_target_https_proxy.new` injects a new `google-beta_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-beta.google_compute_target_https_proxy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_target_https_proxy` using the reference:\n\n $._ref.google-beta_google_compute_target_https_proxy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_target_https_proxy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map\nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is \u0026#39;//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}\u0026#39;. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, Google manages whether QUIC is used. Default value: \u0026#34;NONE\u0026#34; Possible values: [\u0026#34;NONE\u0026#34;, \u0026#34;ENABLE\u0026#34;, \u0026#34;DISABLE\u0026#34;] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resources that are used to authenticate\nconnections between users and the load balancer. At least one SSL\ncertificate must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_https_proxy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -33,7 +33,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_target_https_proxy.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_target_https_proxy`\nTerraform resource.\n\nUnlike [google-beta.google_compute_target_https_proxy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map \nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is '//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}'. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, Google manages whether QUIC is used. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resources that are used to authenticate\nconnections between users and the load balancer. At least one SSL\ncertificate must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.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 `google_compute_target_https_proxy` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_target_https_proxy.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_target_https_proxy`\nTerraform resource.\n\nUnlike [google-beta.google_compute_target_https_proxy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map\nassociated with the given target proxy. This field can only be set for global target proxies.\nAccepted format is '//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}'. When `null`, the `certificate_map` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Name of the resource. Provided by the client when the resource is\ncreated. The name must be 1-63 characters long, and comply with\nRFC1035. Specifically, the name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `proxy_bind` (`bool`): This field only applies when the forwarding rule that references\nthis target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `proxy_bind` field will be omitted from the resulting object.\n - `quic_override` (`string`): Specifies the QUIC override policy for this resource. This determines\nwhether the load balancer will attempt to negotiate QUIC with clients\nor not. Can specify one of NONE, ENABLE, or DISABLE. If NONE is\nspecified, Google manages whether QUIC is used. Default value: "NONE" Possible values: ["NONE", "ENABLE", "DISABLE"] When `null`, the `quic_override` field will be omitted from the resulting object.\n - `ssl_certificates` (`list`): A list of SslCertificate resources that are used to authenticate\nconnections between users and the load balancer. At least one SSL\ncertificate must be specified. When `null`, the `ssl_certificates` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): A reference to the SslPolicy resource that will be associated with\nthe TargetHttpsProxy resource. If not set, the TargetHttpsProxy\nresource will not have any SSL policy configured. When `null`, the `ssl_policy` field will be omitted from the resulting object.\n - `url_map` (`string`): A reference to the UrlMap resource that defines the mapping from URL\nto the BackendService.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.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 `google_compute_target_https_proxy` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, url_map, diff --git a/4.x/_gen/resources/container_aws_node_pool.libsonnet b/4.x/_gen/resources/container_aws_node_pool.libsonnet index 18b80eb7..adb89876 100644 --- a/4.x/_gen/resources/container_aws_node_pool.libsonnet +++ b/4.x/_gen/resources/container_aws_node_pool.libsonnet @@ -39,7 +39,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); tenancy: tenancy, }), }, - '#new':: d.fn(help='\n`google-beta.google_container_aws_node_pool.config.new` constructs a new object with attributes and blocks configured for the `config`\nTerraform sub block.\n\n\n\n**Args**:\n - `iam_instance_profile` (`string`): The name of the AWS IAM role assigned to nodes in the pool.\n - `image_type` (`string`): The OS image type to use on node pool instances. When `null`, the `image_type` field will be omitted from the resulting object.\n - `instance_type` (`string`): Optional. The AWS instance type. When unspecified, it defaults to `m5.large`. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `labels` (`obj`): Optional. The initial labels assigned to nodes of this node pool. An object containing 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.\n - `security_group_ids` (`list`): Optional. The IDs of additional security groups to add to nodes in this pool. The manager will automatically create security groups with minimum rules needed for a functioning cluster. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `tags` (`obj`): Optional. Key/value metadata to assign to each underlying AWS resource. Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters. When `null`, the `tags` field will be omitted from the resulting object.\n - `autoscaling_metrics_collection` (`list[obj]`): Optional. Configuration related to CloudWatch metrics collection on the Auto Scaling group of the node pool. When unspecified, metrics collection is disabled. When `null`, the `autoscaling_metrics_collection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_aws_node_pool.config.autoscaling_metrics_collection.new](#fn-configautoscaling_metrics_collectionnew) constructor.\n - `config_encryption` (`list[obj]`): The ARN of the AWS KMS key used to encrypt node pool configuration. When `null`, the `config_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-beta.google_container_aws_node_pool.config.config_encryption.new](#fn-configconfig_encryptionnew) constructor.\n - `instance_placement` (`list[obj]`): Details of placement information for an instance. When `null`, the `instance_placement` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_aws_node_pool.config.instance_placement.new](#fn-configinstance_placementnew) constructor.\n - `proxy_config` (`list[obj]`): Proxy configuration for outbound HTTP(S) traffic. When `null`, the `proxy_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-beta.google_container_aws_node_pool.config.proxy_config.new](#fn-configproxy_confignew) constructor.\n - `root_volume` (`list[obj]`): Optional. Template for the root volume provisioned for node pool nodes. Volumes will be provisioned in the availability zone assigned to the node pool subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type. When `null`, the `root_volume` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_aws_node_pool.config.root_volume.new](#fn-configroot_volumenew) constructor.\n - `ssh_config` (`list[obj]`): Optional. The SSH configuration. When `null`, the `ssh_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-beta.google_container_aws_node_pool.config.ssh_config.new](#fn-configssh_confignew) constructor.\n - `taints` (`list[obj]`): Optional. The initial taints assigned to nodes of this node pool. When `null`, the `taints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_aws_node_pool.config.taints.new](#fn-configtaintsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_container_aws_node_pool.config.new` constructs a new object with attributes and blocks configured for the `config`\nTerraform sub block.\n\n\n\n**Args**:\n - `iam_instance_profile` (`string`): The name of the AWS IAM role assigned to nodes in the pool.\n - `image_type` (`string`): The OS image type to use on node pool instances. When `null`, the `image_type` field will be omitted from the resulting object.\n - `instance_type` (`string`): Optional. The AWS instance type. When unspecified, it defaults to `m5.large`. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `labels` (`obj`): Optional. The initial labels assigned to nodes of this node pool. An object containing 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.\n - `security_group_ids` (`list`): Optional. The IDs of additional security groups to add to nodes in this pool. The manager will automatically create security groups with minimum rules needed for a functioning cluster. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `tags` (`obj`): Optional. Key/value metadata to assign to each underlying AWS resource. Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters. When `null`, the `tags` field will be omitted from the resulting object.\n - `autoscaling_metrics_collection` (`list[obj]`): Optional. Configuration related to CloudWatch metrics collection on the Auto Scaling group of the node pool. When unspecified, metrics collection is disabled. When `null`, the `autoscaling_metrics_collection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_aws_node_pool.config.autoscaling_metrics_collection.new](#fn-configautoscaling_metrics_collectionnew) constructor.\n - `config_encryption` (`list[obj]`): The ARN of the AWS KMS key used to encrypt node pool configuration. When `null`, the `config_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-beta.google_container_aws_node_pool.config.config_encryption.new](#fn-configconfig_encryptionnew) constructor.\n - `instance_placement` (`list[obj]`): Details of placement information for an instance. When `null`, the `instance_placement` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_aws_node_pool.config.instance_placement.new](#fn-configinstance_placementnew) constructor.\n - `proxy_config` (`list[obj]`): Proxy configuration for outbound HTTP(S) traffic. When `null`, the `proxy_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-beta.google_container_aws_node_pool.config.proxy_config.new](#fn-configproxy_confignew) constructor.\n - `root_volume` (`list[obj]`): Optional. Template for the root volume provisioned for node pool nodes. Volumes will be provisioned in the availability zone assigned to the node pool subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type. When `null`, the `root_volume` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_aws_node_pool.config.root_volume.new](#fn-configroot_volumenew) constructor.\n - `spot_config` (`list[obj]`): Optional. When specified, the node pool will provision Spot instances from the set of spot_config.instance_types. This field is mutually exclusive with `instance_type` When `null`, the `spot_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-beta.google_container_aws_node_pool.config.spot_config.new](#fn-configspot_confignew) constructor.\n - `ssh_config` (`list[obj]`): Optional. The SSH configuration. When `null`, the `ssh_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-beta.google_container_aws_node_pool.config.ssh_config.new](#fn-configssh_confignew) constructor.\n - `taints` (`list[obj]`): Optional. The initial taints assigned to nodes of this node pool. When `null`, the `taints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_aws_node_pool.config.taints.new](#fn-configtaintsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `config` sub block.\n', args=[]), new( iam_instance_profile, autoscaling_metrics_collection=null, @@ -51,6 +51,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); proxy_config=null, root_volume=null, security_group_ids=null, + spot_config=null, ssh_config=null, tags=null, taints=null @@ -65,6 +66,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); proxy_config: proxy_config, root_volume: root_volume, security_group_ids: security_group_ids, + spot_config: spot_config, ssh_config: ssh_config, tags: tags, taints: taints, @@ -93,6 +95,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); volume_type: volume_type, }), }, + spot_config:: { + '#new':: d.fn(help='\n`google-beta.google_container_aws_node_pool.config.spot_config.new` constructs a new object with attributes and blocks configured for the `spot_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_types` (`list`): List of AWS EC2 instance types for creating a spot node pool's nodes. The specified instance types must have the same number of CPUs and memory. You can use the Amazon EC2 Instance Selector tool (https://github.com/aws/amazon-ec2-instance-selector) to choose instance types with matching CPU and memory\n\n**Returns**:\n - An attribute object that represents the `spot_config` sub block.\n', args=[]), + new( + instance_types + ):: std.prune(a={ + instance_types: instance_types, + }), + }, ssh_config:: { '#new':: d.fn(help='\n`google-beta.google_container_aws_node_pool.config.ssh_config.new` constructs a new object with attributes and blocks configured for the `ssh_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `ec2_key_pair` (`string`): The name of the EC2 key pair used to login into cluster machines.\n\n**Returns**:\n - An attribute object that represents the `ssh_config` sub block.\n', args=[]), new( diff --git a/4.x/_gen/resources/data_fusion_instance.libsonnet b/4.x/_gen/resources/data_fusion_instance.libsonnet index a07bc12a..63685076 100644 --- a/4.x/_gen/resources/data_fusion_instance.libsonnet +++ b/4.x/_gen/resources/data_fusion_instance.libsonnet @@ -40,7 +40,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); network: network, }), }, - '#new':: d.fn(help="\n`google-beta.google_data_fusion_instance.new` injects a new `google-beta_google_data_fusion_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-beta.google_data_fusion_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_data_fusion_instance` using the reference:\n\n $._ref.google-beta_google_data_fusion_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_data_fusion_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 - `dataproc_service_account` (`string`): User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. When `null`, the `dataproc_service_account` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of the instance. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): Display name for an instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `enable_rbac` (`bool`): Option to enable granular role-based access control. When `null`, the `enable_rbac` field will be omitted from the resulting object.\n - `enable_stackdriver_logging` (`bool`): Option to enable Stackdriver Logging. When `null`, the `enable_stackdriver_logging` field will be omitted from the resulting object.\n - `enable_stackdriver_monitoring` (`bool`): Option to enable Stackdriver Monitoring. When `null`, the `enable_stackdriver_monitoring` field will be omitted from the resulting object.\n - `labels` (`obj`): The resource labels for instance to use to annotate any related underlying resources,\nsuch as Compute Engine VMs. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The ID of the instance or a fully qualified identifier for the instance.\n - `options` (`obj`): Map of additional options used to configure the behavior of Data Fusion instance. When `null`, the `options` field will be omitted from the resulting object.\n - `private_instance` (`bool`): Specifies whether the Data Fusion instance should be private. If set to\ntrue, all Data Fusion nodes will have private IP addresses and will not be\nable to access the public internet. When `null`, the `private_instance` 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 - `region` (`string`): The region of the Data Fusion instance. When `null`, the `region` field will be omitted from the resulting object.\n - `type` (`string`): Represents the type of Data Fusion instance. Each type is configured with\nthe default settings for processing and memory.\n- BASIC: Basic Data Fusion instance. In Basic type, the user will be able to create data pipelines\nusing point and click UI. However, there are certain limitations, such as fewer number\nof concurrent pipelines, no support for streaming pipelines, etc.\n- ENTERPRISE: Enterprise Data Fusion instance. In Enterprise type, the user will have more features\navailable, such as support for streaming pipelines, higher number of concurrent pipelines, etc.\n- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but\nwith restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration \npipelines at low cost. Possible values: [\u0026#34;BASIC\u0026#34;, \u0026#34;ENTERPRISE\u0026#34;, \u0026#34;DEVELOPER\u0026#34;]\n - `version` (`string`): Current version of the Data Fusion. When `null`, the `version` field will be omitted from the resulting object.\n - `zone` (`string`): Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. When `null`, the `zone` field will be omitted from the resulting object.\n - `accelerators` (`list[obj]`): List of accelerators enabled for this CDF instance.\n\nIf accelerators are enabled it is possible a permadiff will be created with the Options field. \nUsers will need to either manually update their state file to include these diffed options, or include the field in a [lifecycle ignore changes block](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes). When `null`, the `accelerators` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_fusion_instance.accelerators.new](#fn-acceleratorsnew) constructor.\n - `crypto_key_config` (`list[obj]`): The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. When `null`, the `crypto_key_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-beta.google_data_fusion_instance.crypto_key_config.new](#fn-crypto_key_confignew) constructor.\n - `event_publish_config` (`list[obj]`): Option to enable and pass metadata for event publishing. When `null`, the `event_publish_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-beta.google_data_fusion_instance.event_publish_config.new](#fn-event_publish_confignew) constructor.\n - `network_config` (`list[obj]`): Network configuration options. These are required when a private Data Fusion instance is to be created. 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-beta.google_data_fusion_instance.network_config.new](#fn-network_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_fusion_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-beta.google_data_fusion_instance.new` injects a new `google-beta_google_data_fusion_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-beta.google_data_fusion_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_data_fusion_instance` using the reference:\n\n $._ref.google-beta_google_data_fusion_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_data_fusion_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 - `dataproc_service_account` (`string`): User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. When `null`, the `dataproc_service_account` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of the instance. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): Display name for an instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `enable_rbac` (`bool`): Option to enable granular role-based access control. When `null`, the `enable_rbac` field will be omitted from the resulting object.\n - `enable_stackdriver_logging` (`bool`): Option to enable Stackdriver Logging. When `null`, the `enable_stackdriver_logging` field will be omitted from the resulting object.\n - `enable_stackdriver_monitoring` (`bool`): Option to enable Stackdriver Monitoring. When `null`, the `enable_stackdriver_monitoring` field will be omitted from the resulting object.\n - `labels` (`obj`): The resource labels for instance to use to annotate any related underlying resources,\nsuch as Compute Engine VMs. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The ID of the instance or a fully qualified identifier for the instance.\n - `options` (`obj`): Map of additional options used to configure the behavior of Data Fusion instance. When `null`, the `options` field will be omitted from the resulting object.\n - `private_instance` (`bool`): Specifies whether the Data Fusion instance should be private. If set to\ntrue, all Data Fusion nodes will have private IP addresses and will not be\nable to access the public internet. When `null`, the `private_instance` 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 - `region` (`string`): The region of the Data Fusion instance. When `null`, the `region` field will be omitted from the resulting object.\n - `type` (`string`): Represents the type of Data Fusion instance. Each type is configured with\nthe default settings for processing and memory.\n- BASIC: Basic Data Fusion instance. In Basic type, the user will be able to create data pipelines\nusing point and click UI. However, there are certain limitations, such as fewer number\nof concurrent pipelines, no support for streaming pipelines, etc.\n- ENTERPRISE: Enterprise Data Fusion instance. In Enterprise type, the user will have more features\navailable, such as support for streaming pipelines, higher number of concurrent pipelines, etc.\n- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but\nwith restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration\npipelines at low cost. Possible values: [\u0026#34;BASIC\u0026#34;, \u0026#34;ENTERPRISE\u0026#34;, \u0026#34;DEVELOPER\u0026#34;]\n - `version` (`string`): Current version of the Data Fusion. When `null`, the `version` field will be omitted from the resulting object.\n - `zone` (`string`): Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. When `null`, the `zone` field will be omitted from the resulting object.\n - `accelerators` (`list[obj]`): List of accelerators enabled for this CDF instance.\n\nIf accelerators are enabled it is possible a permadiff will be created with the Options field.\nUsers will need to either manually update their state file to include these diffed options, or include the field in a [lifecycle ignore changes block](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes). When `null`, the `accelerators` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_fusion_instance.accelerators.new](#fn-acceleratorsnew) constructor.\n - `crypto_key_config` (`list[obj]`): The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. When `null`, the `crypto_key_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-beta.google_data_fusion_instance.crypto_key_config.new](#fn-crypto_key_confignew) constructor.\n - `event_publish_config` (`list[obj]`): Option to enable and pass metadata for event publishing. When `null`, the `event_publish_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-beta.google_data_fusion_instance.event_publish_config.new](#fn-event_publish_confignew) constructor.\n - `network_config` (`list[obj]`): Network configuration options. These are required when a private Data Fusion instance is to be created. 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-beta.google_data_fusion_instance.network_config.new](#fn-network_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_fusion_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, @@ -91,7 +91,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_data_fusion_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_data_fusion_instance`\nTerraform resource.\n\nUnlike [google-beta.google_data_fusion_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 - `dataproc_service_account` (`string`): User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. When `null`, the `dataproc_service_account` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of the instance. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): Display name for an instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `enable_rbac` (`bool`): Option to enable granular role-based access control. When `null`, the `enable_rbac` field will be omitted from the resulting object.\n - `enable_stackdriver_logging` (`bool`): Option to enable Stackdriver Logging. When `null`, the `enable_stackdriver_logging` field will be omitted from the resulting object.\n - `enable_stackdriver_monitoring` (`bool`): Option to enable Stackdriver Monitoring. When `null`, the `enable_stackdriver_monitoring` field will be omitted from the resulting object.\n - `labels` (`obj`): The resource labels for instance to use to annotate any related underlying resources,\nsuch as Compute Engine VMs. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The ID of the instance or a fully qualified identifier for the instance.\n - `options` (`obj`): Map of additional options used to configure the behavior of Data Fusion instance. When `null`, the `options` field will be omitted from the resulting object.\n - `private_instance` (`bool`): Specifies whether the Data Fusion instance should be private. If set to\ntrue, all Data Fusion nodes will have private IP addresses and will not be\nable to access the public internet. When `null`, the `private_instance` 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 - `region` (`string`): The region of the Data Fusion instance. When `null`, the `region` field will be omitted from the resulting object.\n - `type` (`string`): Represents the type of Data Fusion instance. Each type is configured with\nthe default settings for processing and memory.\n- BASIC: Basic Data Fusion instance. In Basic type, the user will be able to create data pipelines\nusing point and click UI. However, there are certain limitations, such as fewer number\nof concurrent pipelines, no support for streaming pipelines, etc.\n- ENTERPRISE: Enterprise Data Fusion instance. In Enterprise type, the user will have more features\navailable, such as support for streaming pipelines, higher number of concurrent pipelines, etc.\n- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but\nwith restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration \npipelines at low cost. Possible values: ["BASIC", "ENTERPRISE", "DEVELOPER"]\n - `version` (`string`): Current version of the Data Fusion. When `null`, the `version` field will be omitted from the resulting object.\n - `zone` (`string`): Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. When `null`, the `zone` field will be omitted from the resulting object.\n - `accelerators` (`list[obj]`): List of accelerators enabled for this CDF instance.\n\nIf accelerators are enabled it is possible a permadiff will be created with the Options field. \nUsers will need to either manually update their state file to include these diffed options, or include the field in a [lifecycle ignore changes block](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes). When `null`, the `accelerators` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_fusion_instance.accelerators.new](#fn-acceleratorsnew) constructor.\n - `crypto_key_config` (`list[obj]`): The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. When `null`, the `crypto_key_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-beta.google_data_fusion_instance.crypto_key_config.new](#fn-crypto_key_confignew) constructor.\n - `event_publish_config` (`list[obj]`): Option to enable and pass metadata for event publishing. When `null`, the `event_publish_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-beta.google_data_fusion_instance.event_publish_config.new](#fn-event_publish_confignew) constructor.\n - `network_config` (`list[obj]`): Network configuration options. These are required when a private Data Fusion instance is to be created. 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-beta.google_data_fusion_instance.network_config.new](#fn-network_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-beta.google_data_fusion_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 `google_data_fusion_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_data_fusion_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_data_fusion_instance`\nTerraform resource.\n\nUnlike [google-beta.google_data_fusion_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 - `dataproc_service_account` (`string`): User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. When `null`, the `dataproc_service_account` field will be omitted from the resulting object.\n - `description` (`string`): An optional description of the instance. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): Display name for an instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `enable_rbac` (`bool`): Option to enable granular role-based access control. When `null`, the `enable_rbac` field will be omitted from the resulting object.\n - `enable_stackdriver_logging` (`bool`): Option to enable Stackdriver Logging. When `null`, the `enable_stackdriver_logging` field will be omitted from the resulting object.\n - `enable_stackdriver_monitoring` (`bool`): Option to enable Stackdriver Monitoring. When `null`, the `enable_stackdriver_monitoring` field will be omitted from the resulting object.\n - `labels` (`obj`): The resource labels for instance to use to annotate any related underlying resources,\nsuch as Compute Engine VMs. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The ID of the instance or a fully qualified identifier for the instance.\n - `options` (`obj`): Map of additional options used to configure the behavior of Data Fusion instance. When `null`, the `options` field will be omitted from the resulting object.\n - `private_instance` (`bool`): Specifies whether the Data Fusion instance should be private. If set to\ntrue, all Data Fusion nodes will have private IP addresses and will not be\nable to access the public internet. When `null`, the `private_instance` 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 - `region` (`string`): The region of the Data Fusion instance. When `null`, the `region` field will be omitted from the resulting object.\n - `type` (`string`): Represents the type of Data Fusion instance. Each type is configured with\nthe default settings for processing and memory.\n- BASIC: Basic Data Fusion instance. In Basic type, the user will be able to create data pipelines\nusing point and click UI. However, there are certain limitations, such as fewer number\nof concurrent pipelines, no support for streaming pipelines, etc.\n- ENTERPRISE: Enterprise Data Fusion instance. In Enterprise type, the user will have more features\navailable, such as support for streaming pipelines, higher number of concurrent pipelines, etc.\n- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but\nwith restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration\npipelines at low cost. Possible values: ["BASIC", "ENTERPRISE", "DEVELOPER"]\n - `version` (`string`): Current version of the Data Fusion. When `null`, the `version` field will be omitted from the resulting object.\n - `zone` (`string`): Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. When `null`, the `zone` field will be omitted from the resulting object.\n - `accelerators` (`list[obj]`): List of accelerators enabled for this CDF instance.\n\nIf accelerators are enabled it is possible a permadiff will be created with the Options field.\nUsers will need to either manually update their state file to include these diffed options, or include the field in a [lifecycle ignore changes block](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes). When `null`, the `accelerators` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_fusion_instance.accelerators.new](#fn-acceleratorsnew) constructor.\n - `crypto_key_config` (`list[obj]`): The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. When `null`, the `crypto_key_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-beta.google_data_fusion_instance.crypto_key_config.new](#fn-crypto_key_confignew) constructor.\n - `event_publish_config` (`list[obj]`): Option to enable and pass metadata for event publishing. When `null`, the `event_publish_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-beta.google_data_fusion_instance.event_publish_config.new](#fn-event_publish_confignew) constructor.\n - `network_config` (`list[obj]`): Network configuration options. These are required when a private Data Fusion instance is to be created. 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-beta.google_data_fusion_instance.network_config.new](#fn-network_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-beta.google_data_fusion_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 `google_data_fusion_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, type, diff --git a/4.x/_gen/resources/data_loss_prevention_deidentify_template.libsonnet b/4.x/_gen/resources/data_loss_prevention_deidentify_template.libsonnet index 2ae6e39b..605e9881 100644 --- a/4.x/_gen/resources/data_loss_prevention_deidentify_template.libsonnet +++ b/4.x/_gen/resources/data_loss_prevention_deidentify_template.libsonnet @@ -3,6 +3,70 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_data_loss_prevention_deidentify_template', url='', help='`google_data_loss_prevention_deidentify_template` represents the `google-beta_google_data_loss_prevention_deidentify_template` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), deidentify_config:: { + image_transformations:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.new` constructs a new object with attributes and blocks configured for the `image_transformations`\nTerraform sub block.\n\n\n\n**Args**:\n - `transforms` (`list[obj]`): For determination of how redaction of images should occur. When `null`, the `transforms` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.new](#fn-deidentify_configdeidentify_configtransformsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `image_transformations` sub block.\n', args=[]), + new( + transforms=null + ):: std.prune(a={ + transforms: transforms, + }), + transforms:: { + all_info_types:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.all_info_types.new` constructs a new object with attributes and blocks configured for the `all_info_types`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `all_info_types` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + all_text:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.all_text.new` constructs a new object with attributes and blocks configured for the `all_text`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `all_text` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.new` constructs a new object with attributes and blocks configured for the `transforms`\nTerraform sub block.\n\n\n\n**Args**:\n - `all_info_types` (`list[obj]`): Apply transformation to all findings not specified in other ImageTransformation's selectedInfoTypes. When `null`, the `all_info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.all_info_types.new](#fn-deidentify_configdeidentify_configimage_transformationsall_info_typesnew) constructor.\n - `all_text` (`list[obj]`): Apply transformation to all text that doesn't match an infoType. When `null`, the `all_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.all_text.new](#fn-deidentify_configdeidentify_configimage_transformationsall_textnew) constructor.\n - `redaction_color` (`list[obj]`): The color to use when redacting content from an image. If not specified, the default is black. When `null`, the `redaction_color` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.redaction_color.new](#fn-deidentify_configdeidentify_configimage_transformationsredaction_colornew) constructor.\n - `selected_info_types` (`list[obj]`): Apply transformation to the selected infoTypes. When `null`, the `selected_info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.new](#fn-deidentify_configdeidentify_configimage_transformationsselected_info_typesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `transforms` sub block.\n', args=[]), + new( + all_info_types=null, + all_text=null, + redaction_color=null, + selected_info_types=null + ):: std.prune(a={ + all_info_types: all_info_types, + all_text: all_text, + redaction_color: redaction_color, + selected_info_types: selected_info_types, + }), + redaction_color:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.redaction_color.new` constructs a new object with attributes and blocks configured for the `redaction_color`\nTerraform sub block.\n\n\n\n**Args**:\n - `blue` (`number`): The amount of blue in the color as a value in the interval [0, 1]. When `null`, the `blue` field will be omitted from the resulting object.\n - `green` (`number`): The amount of green in the color as a value in the interval [0, 1]. When `null`, the `green` field will be omitted from the resulting object.\n - `red` (`number`): The amount of red in the color as a value in the interval [0, 1]. When `null`, the `red` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `redaction_color` sub block.\n', args=[]), + new( + blue=null, + green=null, + red=null + ):: std.prune(a={ + blue: blue, + green: green, + red: red, + }), + }, + selected_info_types:: { + info_types:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + new( + name, + version=null + ):: std.prune(a={ + name: name, + version: version, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.new` constructs a new object with attributes and blocks configured for the `selected_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): InfoTypes to apply the transformation to. Leaving this empty will apply the transformation to apply to\nall findings that correspond to infoTypes that were requested in InspectConfig. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.info_types.new](#fn-deidentify_configdeidentify_configimage_transformationstransformsinfo_typesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `selected_info_types` sub block.\n', args=[]), + new( + info_types=null + ):: std.prune(a={ + info_types: info_types, + }), + }, + }, + }, info_type_transformations:: { '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.new` constructs a new object with attributes and blocks configured for the `info_type_transformations`\nTerraform sub block.\n\n\n\n**Args**:\n - `transformations` (`list[obj]`): Transformation for each infoType. Cannot specify more than one for a given infoType. When `null`, the `transformations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.new](#fn-deidentify_configdeidentify_configtransformationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `info_type_transformations` sub block.\n', args=[]), new( @@ -12,11 +76,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), transformations:: { info_types:: { - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( - name + name, + version=null ):: std.prune(a={ name: name, + version: version, }), }, '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.new` constructs a new object with attributes and blocks configured for the `transformations`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): InfoTypes to apply the transformation to. Leaving this empty will apply the transformation to apply to\nall findings that correspond to infoTypes that were requested in InspectConfig. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.info_types.new](#fn-deidentify_configdeidentify_configinfo_type_transformationsinfo_typesnew) constructor.\n - `primitive_transformation` (`list[obj]`): Primitive transformation to apply to the infoType.\nThe 'primitive_transformation' block must only contain one argument, corresponding to the type of transformation. When `null`, the `primitive_transformation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.new](#fn-deidentify_configdeidentify_configinfo_type_transformationsprimitive_transformationnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `transformations` sub block.\n', args=[]), @@ -194,18 +260,20 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.new` constructs a new object with attributes and blocks configured for the `primitive_transformation`\nTerraform sub block.\n\n\n\n**Args**:\n - `replace_with_info_type_config` (`bool`): Replace each matching finding with the name of the info type. When `null`, the `replace_with_info_type_config` field will be omitted from the resulting object.\n - `character_mask_config` (`list[obj]`): Partially mask a string by replacing a given number of characters with a fixed character.\nMasking can start from the beginning or end of the string. When `null`, the `character_mask_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.character_mask_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscharacter_mask_confignew) constructor.\n - `crypto_deterministic_config` (`list[obj]`): Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC [https://tools.ietf.org/html/rfc5297](https://tools.ietf.org/html/rfc5297). When `null`, the `crypto_deterministic_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_deterministic_confignew) constructor.\n - `crypto_replace_ffx_fpe_config` (`list[obj]`): Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the 'content.reidentify' API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See [https://cloud.google.com/dlp/docs/pseudonymization](https://cloud.google.com/dlp/docs/pseudonymization) to learn more.\n\nNote: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. When `null`, the `crypto_replace_ffx_fpe_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_replace_ffx_fpe_confignew) constructor.\n - `replace_config` (`list[obj]`): Replace each input value with a given value. When `null`, the `replace_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsreplace_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `primitive_transformation` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.new` constructs a new object with attributes and blocks configured for the `primitive_transformation`\nTerraform sub block.\n\n\n\n**Args**:\n - `replace_with_info_type_config` (`bool`): Replace each matching finding with the name of the info type. When `null`, the `replace_with_info_type_config` field will be omitted from the resulting object.\n - `character_mask_config` (`list[obj]`): Partially mask a string by replacing a given number of characters with a fixed character.\nMasking can start from the beginning or end of the string. When `null`, the `character_mask_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.character_mask_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscharacter_mask_confignew) constructor.\n - `crypto_deterministic_config` (`list[obj]`): Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC [https://tools.ietf.org/html/rfc5297](https://tools.ietf.org/html/rfc5297). When `null`, the `crypto_deterministic_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_deterministic_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_deterministic_confignew) constructor.\n - `crypto_replace_ffx_fpe_config` (`list[obj]`): Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the 'content.reidentify' API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See [https://cloud.google.com/dlp/docs/pseudonymization](https://cloud.google.com/dlp/docs/pseudonymization) to learn more.\n\nNote: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. When `null`, the `crypto_replace_ffx_fpe_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_replace_ffx_fpe_confignew) constructor.\n - `replace_config` (`list[obj]`): Replace each input value with a given value. When `null`, the `replace_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsreplace_confignew) constructor.\n - `replace_dictionary_config` (`list[obj]`): Replace with a value randomly drawn (with replacement) from a dictionary. When `null`, the `replace_dictionary_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsreplace_dictionary_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `primitive_transformation` sub block.\n', args=[]), new( character_mask_config=null, crypto_deterministic_config=null, crypto_replace_ffx_fpe_config=null, replace_config=null, + replace_dictionary_config=null, replace_with_info_type_config=null ):: std.prune(a={ character_mask_config: character_mask_config, crypto_deterministic_config: crypto_deterministic_config, crypto_replace_ffx_fpe_config: crypto_replace_ffx_fpe_config, replace_config: replace_config, + replace_dictionary_config: replace_dictionary_config, replace_with_info_type_config: replace_with_info_type_config, }), replace_config:: { @@ -264,14 +332,32 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + replace_dictionary_config:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.new` constructs a new object with attributes and blocks configured for the `replace_dictionary_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `word_list` (`list[obj]`): A list of words to select from for random replacement. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. When `null`, the `word_list` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.word_list.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationword_listnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `replace_dictionary_config` sub block.\n', args=[]), + new( + word_list=null + ):: std.prune(a={ + word_list: word_list, + }), + word_list:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.word_list.new` constructs a new object with attributes and blocks configured for the `word_list`\nTerraform sub block.\n\n\n\n**Args**:\n - `words` (`list`): Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits.\n\n**Returns**:\n - An attribute object that represents the `word_list` sub block.\n', args=[]), + new( + words + ):: std.prune(a={ + words: words, + }), + }, + }, }, }, }, - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.new` constructs a new object with attributes and blocks configured for the `deidentify_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_type_transformations` (`list[obj]`): Treat the dataset as free-form text and apply the same free text transformation everywhere When `null`, the `info_type_transformations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.new](#fn-deidentify_configinfo_type_transformationsnew) constructor.\n - `record_transformations` (`list[obj]`): Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table. When `null`, the `record_transformations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.record_transformations.new](#fn-deidentify_configrecord_transformationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `deidentify_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.new` constructs a new object with attributes and blocks configured for the `deidentify_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `image_transformations` (`list[obj]`): Treat the dataset as an image and redact. When `null`, the `image_transformations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.new](#fn-deidentify_configimage_transformationsnew) constructor.\n - `info_type_transformations` (`list[obj]`): Treat the dataset as free-form text and apply the same free text transformation everywhere When `null`, the `info_type_transformations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.new](#fn-deidentify_configinfo_type_transformationsnew) constructor.\n - `record_transformations` (`list[obj]`): Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table. When `null`, the `record_transformations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.record_transformations.new](#fn-deidentify_configrecord_transformationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `deidentify_config` sub block.\n', args=[]), new( + image_transformations=null, info_type_transformations=null, record_transformations=null ):: std.prune(a={ + image_transformations: image_transformations, info_type_transformations: info_type_transformations, record_transformations: record_transformations, }), diff --git a/4.x/_gen/resources/data_loss_prevention_inspect_template.libsonnet b/4.x/_gen/resources/data_loss_prevention_inspect_template.libsonnet index dc31d860..f98666d7 100644 --- a/4.x/_gen/resources/data_loss_prevention_inspect_template.libsonnet +++ b/4.x/_gen/resources/data_loss_prevention_inspect_template.libsonnet @@ -31,21 +31,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, info_type:: { - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names\nlisted at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names\nlisted at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), new( - name + name, + version=null ):: std.prune(a={ name: name, + version: version, }), }, - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.new` constructs a new object with attributes and blocks configured for the `custom_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `exclusion_type` (`string`): If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Possible values: ["EXCLUSION_TYPE_EXCLUDE"] When `null`, the `exclusion_type` field will be omitted from the resulting object.\n - `likelihood` (`string`): Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria\nspecified by the rule. Default value: "VERY_LIKELY" Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `likelihood` field will be omitted from the resulting object.\n - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.dictionary.new](#fn-inspect_configinspect_configdictionarynew) constructor.\n - `info_type` (`list[obj]`): CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing\ninfoTypes and that infoType is specified in 'info_types' field. Specifying the latter adds findings to the\none detected by the system. If built-in info type is not specified in 'info_types' list then the name is\ntreated as a custom info type. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.new](#fn-inspect_configinspect_configinfo_typenew) constructor.\n - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.regex.new](#fn-inspect_configinspect_configregexnew) constructor.\n - `stored_type` (`list[obj]`): A reference to a StoredInfoType to use with scanning. When `null`, the `stored_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.stored_type.new](#fn-inspect_configinspect_configstored_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.new` constructs a new object with attributes and blocks configured for the `custom_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `exclusion_type` (`string`): If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Possible values: ["EXCLUSION_TYPE_EXCLUDE"] When `null`, the `exclusion_type` field will be omitted from the resulting object.\n - `likelihood` (`string`): Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria\nspecified by the rule. Default value: "VERY_LIKELY" Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `likelihood` field will be omitted from the resulting object.\n - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.dictionary.new](#fn-inspect_configinspect_configdictionarynew) constructor.\n - `info_type` (`list[obj]`): CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing\ninfoTypes and that infoType is specified in 'info_types' field. Specifying the latter adds findings to the\none detected by the system. If built-in info type is not specified in 'info_types' list then the name is\ntreated as a custom info type. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.new](#fn-inspect_configinspect_configinfo_typenew) constructor.\n - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.regex.new](#fn-inspect_configinspect_configregexnew) constructor.\n - `stored_type` (`list[obj]`): A reference to a StoredInfoType to use with scanning. When `null`, the `stored_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.stored_type.new](#fn-inspect_configinspect_configstored_typenew) constructor.\n - `surrogate_type` (`list[obj]`): Message for detecting output from deidentification transformations that support reversing. When `null`, the `surrogate_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.surrogate_type.new](#fn-inspect_configinspect_configsurrogate_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_info_types` sub block.\n', args=[]), new( dictionary=null, exclusion_type=null, info_type=null, likelihood=null, regex=null, - stored_type=null + stored_type=null, + surrogate_type=null ):: std.prune(a={ dictionary: dictionary, exclusion_type: exclusion_type, @@ -53,6 +56,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); likelihood: likelihood, regex: regex, stored_type: stored_type, + surrogate_type: surrogate_type, }), regex:: { '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.regex.new` constructs a new object with attributes and blocks configured for the `regex`\nTerraform sub block.\n\n\n\n**Args**:\n - `group_indexes` (`list`): The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. When `null`, the `group_indexes` field will be omitted from the resulting object.\n - `pattern` (`string`): Pattern defining the regular expression.\nIts syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.\n\n**Returns**:\n - An attribute object that represents the `regex` sub block.\n', args=[]), @@ -72,6 +76,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); name: name, }), }, + surrogate_type:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.surrogate_type.new` constructs a new object with attributes and blocks configured for the `surrogate_type`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `surrogate_type` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, }, info_types:: { '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), @@ -86,11 +96,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); limits:: { max_findings_per_info_type:: { info_type:: { - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), new( - name + name, + version=null ):: std.prune(a={ name: name, + version: version, }), }, '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.new` constructs a new object with attributes and blocks configured for the `max_findings_per_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_findings` (`number`): Max findings limit for the given infoType.\n - `info_type` (`list[obj]`): Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does\nnot have an infoType, the DLP API applies the limit against all infoTypes that are found but not\nspecified in another InfoTypeLimit. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.limits.max_findings_per_info_type.info_type.new](#fn-inspect_configinspect_configlimitsinfo_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `max_findings_per_info_type` sub block.\n', args=[]), @@ -135,11 +147,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), rule_set:: { info_types:: { - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( - name + name, + version=null ):: std.prune(a={ name: name, + version: version, }), }, '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.new` constructs a new object with attributes and blocks configured for the `rule_set`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): List of infoTypes this rule set is applied to. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.info_types.new](#fn-inspect_configinspect_configinfo_typesnew) constructor.\n - `rules` (`list[obj]`): Set of rules to be applied to infoTypes. The rules are applied in order. When `null`, the `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-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.new](#fn-inspect_configinspect_configrulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rule_set` sub block.\n', args=[]), @@ -178,13 +192,45 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, + exclude_by_hotword:: { + hotword_regex:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex.new` constructs a new object with attributes and blocks configured for the `hotword_regex`\nTerraform sub block.\n\n\n\n**Args**:\n - `group_indexes` (`list`): The index of the submatch to extract as findings. When not specified,\nthe entire match is returned. No more than 3 may be included. When `null`, the `group_indexes` field will be omitted from the resulting object.\n - `pattern` (`string`): Pattern defining the regular expression. Its syntax\n(https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.\n\n**Returns**:\n - An attribute object that represents the `hotword_regex` sub block.\n', args=[]), + new( + pattern, + group_indexes=null + ):: std.prune(a={ + group_indexes: group_indexes, + pattern: pattern, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.new` constructs a new object with attributes and blocks configured for the `exclude_by_hotword`\nTerraform sub block.\n\n\n\n**Args**:\n - `hotword_regex` (`list[obj]`): Regular expression pattern defining what qualifies as a hotword. When `null`, the `hotword_regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex.new](#fn-inspect_configinspect_configrule_setrulesexclusion_rulehotword_regexnew) constructor.\n - `proximity` (`list[obj]`): Proximity of the finding within which the entire hotword must reside. The total length of the window cannot\nexceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be\nused to match substrings of the finding itself. For example, the certainty of a phone number regex\n'(\\d{3}) \\d{3}-\\d{4}' could be adjusted upwards if the area code is known to be the local area code of a company\noffice using the hotword regex '(xxx)', where 'xxx' is the area code in question. When `null`, the `proximity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity.new](#fn-inspect_configinspect_configrule_setrulesexclusion_ruleproximitynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `exclude_by_hotword` sub block.\n', args=[]), + new( + hotword_regex=null, + proximity=null + ):: std.prune(a={ + hotword_regex: hotword_regex, + proximity: proximity, + }), + proximity:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity.new` constructs a new object with attributes and blocks configured for the `proximity`\nTerraform sub block.\n\n\n\n**Args**:\n - `window_after` (`number`): Number of characters after the finding to consider. When `null`, the `window_after` field will be omitted from the resulting object.\n - `window_before` (`number`): Number of characters before the finding to consider. When `null`, the `window_before` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `proximity` sub block.\n', args=[]), + new( + window_after=null, + window_before=null + ):: std.prune(a={ + window_after: window_after, + window_before: window_before, + }), + }, + }, exclude_info_types:: { info_types:: { - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), new( - name + name, + version=null ):: std.prune(a={ name: name, + version: version, }), }, '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.new` constructs a new object with attributes and blocks configured for the `exclude_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): If a finding is matched by any of the infoType detectors listed here, the finding will be excluded from the scan results. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new](#fn-inspect_configinspect_configrule_setrulesexclusion_ruleinfo_typesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `exclude_info_types` sub block.\n', args=[]), @@ -194,14 +240,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); info_types: info_types, }), }, - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.new` constructs a new object with attributes and blocks configured for the `exclusion_rule`\nTerraform sub block.\n\n\n\n**Args**:\n - `matching_type` (`string`): How the rule is applied. See the documentation for more information: https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#MatchingType Possible values: ["MATCHING_TYPE_FULL_MATCH", "MATCHING_TYPE_PARTIAL_MATCH", "MATCHING_TYPE_INVERSE_MATCH"]\n - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.dictionary.new](#fn-inspect_configinspect_configrule_setrulesdictionarynew) constructor.\n - `exclude_info_types` (`list[obj]`): Set of infoTypes for which findings would affect this rule. When `null`, the `exclude_info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.new](#fn-inspect_configinspect_configrule_setrulesexclude_info_typesnew) constructor.\n - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.regex.new](#fn-inspect_configinspect_configrule_setrulesregexnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `exclusion_rule` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.new` constructs a new object with attributes and blocks configured for the `exclusion_rule`\nTerraform sub block.\n\n\n\n**Args**:\n - `matching_type` (`string`): How the rule is applied. See the documentation for more information: https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#MatchingType Possible values: ["MATCHING_TYPE_FULL_MATCH", "MATCHING_TYPE_PARTIAL_MATCH", "MATCHING_TYPE_INVERSE_MATCH"]\n - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.dictionary.new](#fn-inspect_configinspect_configrule_setrulesdictionarynew) constructor.\n - `exclude_by_hotword` (`list[obj]`): Drop if the hotword rule is contained in the proximate context.\nFor tabular data, the context includes the column name. When `null`, the `exclude_by_hotword` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.new](#fn-inspect_configinspect_configrule_setrulesexclude_by_hotwordnew) constructor.\n - `exclude_info_types` (`list[obj]`): Set of infoTypes for which findings would affect this rule. When `null`, the `exclude_info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.new](#fn-inspect_configinspect_configrule_setrulesexclude_info_typesnew) constructor.\n - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.regex.new](#fn-inspect_configinspect_configrule_setrulesregexnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `exclusion_rule` sub block.\n', args=[]), new( matching_type, dictionary=null, + exclude_by_hotword=null, exclude_info_types=null, regex=null ):: std.prune(a={ dictionary: dictionary, + exclude_by_hotword: exclude_by_hotword, exclude_info_types: exclude_info_types, matching_type: matching_type, regex: regex, diff --git a/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet b/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet index d7c4dcea..07c0bcd3 100644 --- a/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet +++ b/4.x/_gen/resources/data_loss_prevention_job_trigger.libsonnet @@ -5,7 +5,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); inspect_job:: { actions:: { deidentify:: { - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.actions.deidentify.new` constructs a new object with attributes and blocks configured for the `deidentify`\nTerraform sub block.\n\n\n\n**Args**:\n - `cloud_storage_output` (`string`): User settable Cloud Storage bucket and folders to store de-identified files.\n\nThis field must be set for cloud storage deidentification.\n\nThe output Cloud Storage bucket must be different from the input bucket.\n\nDe-identified files will overwrite files in the output path.\n\nForm of: gs://bucket/folder/ or gs://bucket\n - `file_types_to_transform` (`list`): List of user-specified file type groups to transform. If specified, only the files with these filetypes will be transformed.\n\nIf empty, all supported files will be transformed. Supported types may be automatically added over time. \n\nIf a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Possible values: ["IMAGE", "TEXT_FILE", "CSV", "TSV"] When `null`, the `file_types_to_transform` field will be omitted from the resulting object.\n - `transformation_config` (`list[obj]`): User specified deidentify templates and configs for structured, unstructured, and image files. When `null`, the `transformation_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_config.new](#fn-inspect_jobinspect_jobactionstransformation_confignew) constructor.\n - `transformation_details_storage_config` (`list[obj]`): Config for storing transformation details. When `null`, the `transformation_details_storage_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_details_storage_config.new](#fn-inspect_jobinspect_jobactionstransformation_details_storage_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `deidentify` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.actions.deidentify.new` constructs a new object with attributes and blocks configured for the `deidentify`\nTerraform sub block.\n\n\n\n**Args**:\n - `cloud_storage_output` (`string`): User settable Cloud Storage bucket and folders to store de-identified files.\n\nThis field must be set for cloud storage deidentification.\n\nThe output Cloud Storage bucket must be different from the input bucket.\n\nDe-identified files will overwrite files in the output path.\n\nForm of: gs://bucket/folder/ or gs://bucket\n - `file_types_to_transform` (`list`): List of user-specified file type groups to transform. If specified, only the files with these filetypes will be transformed.\n\nIf empty, all supported files will be transformed. Supported types may be automatically added over time.\n\nIf a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Possible values: ["IMAGE", "TEXT_FILE", "CSV", "TSV"] When `null`, the `file_types_to_transform` field will be omitted from the resulting object.\n - `transformation_config` (`list[obj]`): User specified deidentify templates and configs for structured, unstructured, and image files. When `null`, the `transformation_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_config.new](#fn-inspect_jobinspect_jobactionstransformation_confignew) constructor.\n - `transformation_details_storage_config` (`list[obj]`): Config for storing transformation details. When `null`, the `transformation_details_storage_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_details_storage_config.new](#fn-inspect_jobinspect_jobactionstransformation_details_storage_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `deidentify` sub block.\n', args=[]), new( cloud_storage_output, file_types_to_transform=null, @@ -123,13 +123,329 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.new` constructs a new object with attributes and blocks configured for the `inspect_job`\nTerraform sub block.\n\n\n\n**Args**:\n - `inspect_template_name` (`string`): The name of the template to run when this job is triggered.\n - `actions` (`list[obj]`): A task to execute on the completion of a job. When `null`, the `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-beta.google_data_loss_prevention_job_trigger.inspect_job.actions.new](#fn-inspect_jobactionsnew) constructor.\n - `storage_config` (`list[obj]`): Information on where to inspect When `null`, the `storage_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.storage_config.new](#fn-inspect_jobstorage_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `inspect_job` sub block.\n', args=[]), + inspect_config:: { + custom_info_types:: { + dictionary:: { + cloud_storage_path:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.cloud_storage_path.new` constructs a new object with attributes and blocks configured for the `cloud_storage_path`\nTerraform sub block.\n\n\n\n**Args**:\n - `path` (`string`): A url representing a file or path (no wildcards) in Cloud Storage. Example: 'gs://[BUCKET_NAME]/dictionary.txt'\n\n**Returns**:\n - An attribute object that represents the `cloud_storage_path` sub block.\n', args=[]), + new( + path + ):: std.prune(a={ + path: path, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.new` constructs a new object with attributes and blocks configured for the `dictionary`\nTerraform sub block.\n\n\n\n**Args**:\n - `cloud_storage_path` (`list[obj]`): Newline-delimited file of words in Cloud Storage. Only a single file is accepted. When `null`, the `cloud_storage_path` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.cloud_storage_path.new](#fn-inspect_jobinspect_jobinspect_configcustom_info_typescloud_storage_pathnew) constructor.\n - `word_list` (`list[obj]`): List of words or phrases to search for. When `null`, the `word_list` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.word_list.new](#fn-inspect_jobinspect_jobinspect_configcustom_info_typesword_listnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `dictionary` sub block.\n', args=[]), + new( + cloud_storage_path=null, + word_list=null + ):: std.prune(a={ + cloud_storage_path: cloud_storage_path, + word_list: word_list, + }), + word_list:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.word_list.new` constructs a new object with attributes and blocks configured for the `word_list`\nTerraform sub block.\n\n\n\n**Args**:\n - `words` (`list`): Words or phrases defining the dictionary. The dictionary must contain at least one\nphrase and every phrase must contain at least 2 characters that are letters or digits.\n\n**Returns**:\n - An attribute object that represents the `word_list` sub block.\n', args=[]), + new( + words + ):: std.prune(a={ + words: words, + }), + }, + }, + info_type:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names\nlisted at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), + new( + name, + version=null + ):: std.prune(a={ + name: name, + version: version, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.new` constructs a new object with attributes and blocks configured for the `custom_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `exclusion_type` (`string`): If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Possible values: ["EXCLUSION_TYPE_EXCLUDE"] When `null`, the `exclusion_type` field will be omitted from the resulting object.\n - `likelihood` (`string`): Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria\nspecified by the rule. Default value: "VERY_LIKELY" Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `likelihood` field will be omitted from the resulting object.\n - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.new](#fn-inspect_jobinspect_jobinspect_configdictionarynew) constructor.\n - `info_type` (`list[obj]`): CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing\ninfoTypes and that infoType is specified in 'info_types' field. Specifying the latter adds findings to the\none detected by the system. If built-in info type is not specified in 'info_types' list then the name is\ntreated as a custom info type. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.new](#fn-inspect_jobinspect_jobinspect_configinfo_typenew) constructor.\n - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.regex.new](#fn-inspect_jobinspect_jobinspect_configregexnew) constructor.\n - `stored_type` (`list[obj]`): A reference to a StoredInfoType to use with scanning. When `null`, the `stored_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.stored_type.new](#fn-inspect_jobinspect_jobinspect_configstored_typenew) constructor.\n - `surrogate_type` (`list[obj]`): Message for detecting output from deidentification transformations that support reversing. When `null`, the `surrogate_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.surrogate_type.new](#fn-inspect_jobinspect_jobinspect_configsurrogate_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_info_types` sub block.\n', args=[]), + new( + dictionary=null, + exclusion_type=null, + info_type=null, + likelihood=null, + regex=null, + stored_type=null, + surrogate_type=null + ):: std.prune(a={ + dictionary: dictionary, + exclusion_type: exclusion_type, + info_type: info_type, + likelihood: likelihood, + regex: regex, + stored_type: stored_type, + surrogate_type: surrogate_type, + }), + regex:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.regex.new` constructs a new object with attributes and blocks configured for the `regex`\nTerraform sub block.\n\n\n\n**Args**:\n - `group_indexes` (`list`): The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. When `null`, the `group_indexes` field will be omitted from the resulting object.\n - `pattern` (`string`): Pattern defining the regular expression.\nIts syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.\n\n**Returns**:\n - An attribute object that represents the `regex` sub block.\n', args=[]), + new( + pattern, + group_indexes=null + ):: std.prune(a={ + group_indexes: group_indexes, + pattern: pattern, + }), + }, + stored_type:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.stored_type.new` constructs a new object with attributes and blocks configured for the `stored_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Resource name of the requested StoredInfoType, for example 'organizations/433245324/storedInfoTypes/432452342'\nor 'projects/project-id/storedInfoTypes/432452342'.\n\n**Returns**:\n - An attribute object that represents the `stored_type` sub block.\n', args=[]), + new( + name + ):: std.prune(a={ + name: name, + }), + }, + surrogate_type:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.surrogate_type.new` constructs a new object with attributes and blocks configured for the `surrogate_type`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `surrogate_type` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + }, + info_types:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + new( + name, + version=null + ):: std.prune(a={ + name: name, + version: version, + }), + }, + limits:: { + max_findings_per_info_type:: { + info_type:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.new` constructs a new object with attributes and blocks configured for the `info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_type` sub block.\n', args=[]), + new( + name, + version=null + ):: std.prune(a={ + name: name, + version: version, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.new` constructs a new object with attributes and blocks configured for the `max_findings_per_info_type`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_findings` (`number`): Max findings limit for the given infoType. When `null`, the `max_findings` field will be omitted from the resulting object.\n - `info_type` (`list[obj]`): Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does\nnot have an infoType, the DLP API applies the limit against all infoTypes that are found but not\nspecified in another InfoTypeLimit. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.new](#fn-inspect_jobinspect_jobinspect_configlimitsinfo_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `max_findings_per_info_type` sub block.\n', args=[]), + new( + info_type=null, + max_findings=null + ):: std.prune(a={ + info_type: info_type, + max_findings: max_findings, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.new` constructs a new object with attributes and blocks configured for the `limits`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_findings_per_item` (`number`): Max number of findings that will be returned for each item scanned. The maximum returned is 2000. When `null`, the `max_findings_per_item` field will be omitted from the resulting object.\n - `max_findings_per_request` (`number`): Max number of findings that will be returned per request/job. The maximum returned is 2000. When `null`, the `max_findings_per_request` field will be omitted from the resulting object.\n - `max_findings_per_info_type` (`list[obj]`): Configuration of findings limit given for specified infoTypes. When `null`, the `max_findings_per_info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.new](#fn-inspect_jobinspect_jobinspect_configmax_findings_per_info_typenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `limits` sub block.\n', args=[]), + new( + max_findings_per_info_type=null, + max_findings_per_item=null, + max_findings_per_request=null + ):: std.prune(a={ + max_findings_per_info_type: max_findings_per_info_type, + max_findings_per_item: max_findings_per_item, + max_findings_per_request: max_findings_per_request, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.new` constructs a new object with attributes and blocks configured for the `inspect_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `exclude_info_types` (`bool`): When true, excludes type information of the findings. When `null`, the `exclude_info_types` field will be omitted from the resulting object.\n - `include_quote` (`bool`): When true, a contextual quote from the data that triggered a finding is included in the response. When `null`, the `include_quote` field will be omitted from the resulting object.\n - `min_likelihood` (`string`): Only returns findings equal or above this threshold. See https://cloud.google.com/dlp/docs/likelihood for more info Default value: "POSSIBLE" Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `min_likelihood` field will be omitted from the resulting object.\n - `custom_info_types` (`list[obj]`): Custom info types to be used. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. When `null`, the `custom_info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.new](#fn-inspect_jobinspect_jobcustom_info_typesnew) constructor.\n - `info_types` (`list[obj]`): Restricts what infoTypes to look for. The values must correspond to InfoType values returned by infoTypes.list\nor listed at https://cloud.google.com/dlp/docs/infotypes-reference.\n\nWhen no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run.\nBy default this may be all types, but may change over time as detectors are updated. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.info_types.new](#fn-inspect_jobinspect_jobinfo_typesnew) constructor.\n - `limits` (`list[obj]`): Configuration to control the number of findings returned. When `null`, the `limits` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.new](#fn-inspect_jobinspect_joblimitsnew) constructor.\n - `rule_set` (`list[obj]`): Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end,\nother rules are executed in the order they are specified for each info type. When `null`, the `rule_set` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.new](#fn-inspect_jobinspect_jobrule_setnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `inspect_config` sub block.\n', args=[]), + new( + custom_info_types=null, + exclude_info_types=null, + include_quote=null, + info_types=null, + limits=null, + min_likelihood=null, + rule_set=null + ):: std.prune(a={ + custom_info_types: custom_info_types, + exclude_info_types: exclude_info_types, + include_quote: include_quote, + info_types: info_types, + limits: limits, + min_likelihood: min_likelihood, + rule_set: rule_set, + }), + rule_set:: { + info_types:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + new( + name, + version=null + ):: std.prune(a={ + name: name, + version: version, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.new` constructs a new object with attributes and blocks configured for the `rule_set`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): List of infoTypes this rule set is applied to. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.info_types.new](#fn-inspect_jobinspect_jobinspect_configinfo_typesnew) constructor.\n - `rules` (`list[obj]`): Set of rules to be applied to infoTypes. The rules are applied in order. When `null`, the `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-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.new](#fn-inspect_jobinspect_jobinspect_configrulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rule_set` sub block.\n', args=[]), + new( + info_types=null, + rules=null + ):: std.prune(a={ + info_types: info_types, + rules: rules, + }), + rules:: { + exclusion_rule:: { + dictionary:: { + cloud_storage_path:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.cloud_storage_path.new` constructs a new object with attributes and blocks configured for the `cloud_storage_path`\nTerraform sub block.\n\n\n\n**Args**:\n - `path` (`string`): A url representing a file or path (no wildcards) in Cloud Storage. Example: 'gs://[BUCKET_NAME]/dictionary.txt'\n\n**Returns**:\n - An attribute object that represents the `cloud_storage_path` sub block.\n', args=[]), + new( + path + ):: std.prune(a={ + path: path, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.new` constructs a new object with attributes and blocks configured for the `dictionary`\nTerraform sub block.\n\n\n\n**Args**:\n - `cloud_storage_path` (`list[obj]`): Newline-delimited file of words in Cloud Storage. Only a single file is accepted. When `null`, the `cloud_storage_path` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.cloud_storage_path.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_rulecloud_storage_pathnew) constructor.\n - `word_list` (`list[obj]`): List of words or phrases to search for. When `null`, the `word_list` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.word_list.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_ruleword_listnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `dictionary` sub block.\n', args=[]), + new( + cloud_storage_path=null, + word_list=null + ):: std.prune(a={ + cloud_storage_path: cloud_storage_path, + word_list: word_list, + }), + word_list:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.word_list.new` constructs a new object with attributes and blocks configured for the `word_list`\nTerraform sub block.\n\n\n\n**Args**:\n - `words` (`list`): Words or phrases defining the dictionary. The dictionary must contain at least one\nphrase and every phrase must contain at least 2 characters that are letters or digits.\n\n**Returns**:\n - An attribute object that represents the `word_list` sub block.\n', args=[]), + new( + words + ):: std.prune(a={ + words: words, + }), + }, + }, + exclude_by_hotword:: { + hotword_regex:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex.new` constructs a new object with attributes and blocks configured for the `hotword_regex`\nTerraform sub block.\n\n\n\n**Args**:\n - `group_indexes` (`list`): The index of the submatch to extract as findings. When not specified,\nthe entire match is returned. No more than 3 may be included. When `null`, the `group_indexes` field will be omitted from the resulting object.\n - `pattern` (`string`): Pattern defining the regular expression. Its syntax\n(https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. When `null`, the `pattern` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `hotword_regex` sub block.\n', args=[]), + new( + group_indexes=null, + pattern=null + ):: std.prune(a={ + group_indexes: group_indexes, + pattern: pattern, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.new` constructs a new object with attributes and blocks configured for the `exclude_by_hotword`\nTerraform sub block.\n\n\n\n**Args**:\n - `hotword_regex` (`list[obj]`): Regular expression pattern defining what qualifies as a hotword. When `null`, the `hotword_regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_rulehotword_regexnew) constructor.\n - `proximity` (`list[obj]`): Proximity of the finding within which the entire hotword must reside. The total length of the window cannot\nexceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be\nused to match substrings of the finding itself. For example, the certainty of a phone number regex\n'(\\d{3}) \\d{3}-\\d{4}' could be adjusted upwards if the area code is known to be the local area code of a company\noffice using the hotword regex '(xxx)', where 'xxx' is the area code in question. When `null`, the `proximity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_ruleproximitynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `exclude_by_hotword` sub block.\n', args=[]), + new( + hotword_regex=null, + proximity=null + ):: std.prune(a={ + hotword_regex: hotword_regex, + proximity: proximity, + }), + proximity:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity.new` constructs a new object with attributes and blocks configured for the `proximity`\nTerraform sub block.\n\n\n\n**Args**:\n - `window_after` (`number`): Number of characters after the finding to consider. Either this or window_before must be specified When `null`, the `window_after` field will be omitted from the resulting object.\n - `window_before` (`number`): Number of characters before the finding to consider. Either this or window_after must be specified When `null`, the `window_before` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `proximity` sub block.\n', args=[]), + new( + window_after=null, + window_before=null + ):: std.prune(a={ + window_after: window_after, + window_before: window_before, + }), + }, + }, + exclude_info_types:: { + info_types:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed\nat https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type.\n - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `info_types` sub block.\n', args=[]), + new( + name, + version=null + ):: std.prune(a={ + name: name, + version: version, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.new` constructs a new object with attributes and blocks configured for the `exclude_info_types`\nTerraform sub block.\n\n\n\n**Args**:\n - `info_types` (`list[obj]`): If a finding is matched by any of the infoType detectors listed here, the finding will be excluded from the scan results. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_ruleinfo_typesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `exclude_info_types` sub block.\n', args=[]), + new( + info_types=null + ):: std.prune(a={ + info_types: info_types, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.new` constructs a new object with attributes and blocks configured for the `exclusion_rule`\nTerraform sub block.\n\n\n\n**Args**:\n - `matching_type` (`string`): How the rule is applied. See the documentation for more information: https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#MatchingType Possible values: ["MATCHING_TYPE_FULL_MATCH", "MATCHING_TYPE_PARTIAL_MATCH", "MATCHING_TYPE_INVERSE_MATCH"]\n - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesdictionarynew) constructor.\n - `exclude_by_hotword` (`list[obj]`): Drop if the hotword rule is contained in the proximate context. When `null`, the `exclude_by_hotword` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclude_by_hotwordnew) constructor.\n - `exclude_info_types` (`list[obj]`): Set of infoTypes for which findings would affect this rule. When `null`, the `exclude_info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclude_info_typesnew) constructor.\n - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.regex.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesregexnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `exclusion_rule` sub block.\n', args=[]), + new( + matching_type, + dictionary=null, + exclude_by_hotword=null, + exclude_info_types=null, + regex=null + ):: std.prune(a={ + dictionary: dictionary, + exclude_by_hotword: exclude_by_hotword, + exclude_info_types: exclude_info_types, + matching_type: matching_type, + regex: regex, + }), + regex:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.regex.new` constructs a new object with attributes and blocks configured for the `regex`\nTerraform sub block.\n\n\n\n**Args**:\n - `group_indexes` (`list`): The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. When `null`, the `group_indexes` field will be omitted from the resulting object.\n - `pattern` (`string`): Pattern defining the regular expression.\nIts syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.\n\n**Returns**:\n - An attribute object that represents the `regex` sub block.\n', args=[]), + new( + pattern, + group_indexes=null + ):: std.prune(a={ + group_indexes: group_indexes, + pattern: pattern, + }), + }, + }, + hotword_rule:: { + hotword_regex:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.hotword_regex.new` constructs a new object with attributes and blocks configured for the `hotword_regex`\nTerraform sub block.\n\n\n\n**Args**:\n - `group_indexes` (`list`): The index of the submatch to extract as findings. When not specified,\nthe entire match is returned. No more than 3 may be included. When `null`, the `group_indexes` field will be omitted from the resulting object.\n - `pattern` (`string`): Pattern defining the regular expression. Its syntax\n(https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. When `null`, the `pattern` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `hotword_regex` sub block.\n', args=[]), + new( + group_indexes=null, + pattern=null + ):: std.prune(a={ + group_indexes: group_indexes, + pattern: pattern, + }), + }, + likelihood_adjustment:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.likelihood_adjustment.new` constructs a new object with attributes and blocks configured for the `likelihood_adjustment`\nTerraform sub block.\n\n\n\n**Args**:\n - `fixed_likelihood` (`string`): Set the likelihood of a finding to a fixed value. Either this or relative_likelihood can be set. Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `fixed_likelihood` field will be omitted from the resulting object.\n - `relative_likelihood` (`number`): Increase or decrease the likelihood by the specified number of levels. For example,\nif a finding would be POSSIBLE without the detection rule and relativeLikelihood is 1,\nthen it is upgraded to LIKELY, while a value of -1 would downgrade it to UNLIKELY.\nLikelihood may never drop below VERY_UNLIKELY or exceed VERY_LIKELY, so applying an\nadjustment of 1 followed by an adjustment of -1 when base likelihood is VERY_LIKELY\nwill result in a final likelihood of LIKELY. Either this or fixed_likelihood can be set. When `null`, the `relative_likelihood` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `likelihood_adjustment` sub block.\n', args=[]), + new( + fixed_likelihood=null, + relative_likelihood=null + ):: std.prune(a={ + fixed_likelihood: fixed_likelihood, + relative_likelihood: relative_likelihood, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.new` constructs a new object with attributes and blocks configured for the `hotword_rule`\nTerraform sub block.\n\n\n\n**Args**:\n - `hotword_regex` (`list[obj]`): Regular expression pattern defining what qualifies as a hotword. When `null`, the `hotword_regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.hotword_regex.new](#fn-inspect_jobinspect_jobinspect_configrule_setruleshotword_regexnew) constructor.\n - `likelihood_adjustment` (`list[obj]`): Likelihood adjustment to apply to all matching findings. When `null`, the `likelihood_adjustment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.likelihood_adjustment.new](#fn-inspect_jobinspect_jobinspect_configrule_setruleslikelihood_adjustmentnew) constructor.\n - `proximity` (`list[obj]`): Proximity of the finding within which the entire hotword must reside. The total length of the window cannot\nexceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be\nused to match substrings of the finding itself. For example, the certainty of a phone number regex\n'(\\d{3}) \\d{3}-\\d{4}' could be adjusted upwards if the area code is known to be the local area code of a company\noffice using the hotword regex '(xxx)', where 'xxx' is the area code in question. When `null`, the `proximity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.proximity.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesproximitynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `hotword_rule` sub block.\n', args=[]), + new( + hotword_regex=null, + likelihood_adjustment=null, + proximity=null + ):: std.prune(a={ + hotword_regex: hotword_regex, + likelihood_adjustment: likelihood_adjustment, + proximity: proximity, + }), + proximity:: { + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.proximity.new` constructs a new object with attributes and blocks configured for the `proximity`\nTerraform sub block.\n\n\n\n**Args**:\n - `window_after` (`number`): Number of characters after the finding to consider. Either this or window_before must be specified When `null`, the `window_after` field will be omitted from the resulting object.\n - `window_before` (`number`): Number of characters before the finding to consider. Either this or window_after must be specified When `null`, the `window_before` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `proximity` sub block.\n', args=[]), + new( + window_after=null, + window_before=null + ):: std.prune(a={ + window_after: window_after, + window_before: window_before, + }), + }, + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.new` constructs a new object with attributes and blocks configured for the `rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `exclusion_rule` (`list[obj]`): The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results. When `null`, the `exclusion_rule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.new](#fn-inspect_jobinspect_jobinspect_configrule_setexclusion_rulenew) constructor.\n - `hotword_rule` (`list[obj]`): Hotword-based detection rule. When `null`, the `hotword_rule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.new](#fn-inspect_jobinspect_jobinspect_configrule_sethotword_rulenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rules` sub block.\n', args=[]), + new( + exclusion_rule=null, + hotword_rule=null + ):: std.prune(a={ + exclusion_rule: exclusion_rule, + hotword_rule: hotword_rule, + }), + }, + }, + }, + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.new` constructs a new object with attributes and blocks configured for the `inspect_job`\nTerraform sub block.\n\n\n\n**Args**:\n - `inspect_template_name` (`string`): The name of the template to run when this job is triggered.\n - `actions` (`list[obj]`): A task to execute on the completion of a job. When `null`, the `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-beta.google_data_loss_prevention_job_trigger.inspect_job.actions.new](#fn-inspect_jobactionsnew) constructor.\n - `inspect_config` (`list[obj]`): The core content of the template. When `null`, the `inspect_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-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.new](#fn-inspect_jobinspect_confignew) constructor.\n - `storage_config` (`list[obj]`): Information on where to inspect When `null`, the `storage_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.storage_config.new](#fn-inspect_jobstorage_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `inspect_job` sub block.\n', args=[]), new( inspect_template_name, actions=null, + inspect_config=null, storage_config=null ):: std.prune(a={ actions: actions, + inspect_config: inspect_config, inspect_template_name: inspect_template_name, storage_config: storage_config, }), @@ -143,7 +459,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); name: name, }), }, - '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.storage_config.big_query_options.new` constructs a new object with attributes and blocks configured for the `big_query_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `rows_limit` (`number`): Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. \nIf not set, or if set to 0, all rows will be scanned. Only one of rowsLimit and rowsLimitPercent can be \nspecified. Cannot be used in conjunction with TimespanConfig. When `null`, the `rows_limit` field will be omitted from the resulting object.\n - `rows_limit_percent` (`number`): Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. \nMust be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of \nrowsLimit and rowsLimitPercent can be specified. Cannot be used in conjunction with TimespanConfig. When `null`, the `rows_limit_percent` field will be omitted from the resulting object.\n - `sample_method` (`string`): How to sample rows if not all rows are scanned. Meaningful only when used in conjunction with either \nrowsLimit or rowsLimitPercent. If not specified, rows are scanned in the order BigQuery reads them. Default value: "TOP" Possible values: ["TOP", "RANDOM_START"] When `null`, the `sample_method` field will be omitted from the resulting object.\n - `identifying_fields` (`list[obj]`): Specifies the BigQuery fields that will be returned with findings.\nIf not specified, no identifying fields will be returned for findings. When `null`, the `identifying_fields` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.storage_config.big_query_options.identifying_fields.new](#fn-inspect_jobinspect_jobstorage_configidentifying_fieldsnew) constructor.\n - `table_reference` (`list[obj]`): Set of files to scan. When `null`, the `table_reference` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.storage_config.big_query_options.table_reference.new](#fn-inspect_jobinspect_jobstorage_configtable_referencenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `big_query_options` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_data_loss_prevention_job_trigger.inspect_job.storage_config.big_query_options.new` constructs a new object with attributes and blocks configured for the `big_query_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `rows_limit` (`number`): Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted.\nIf not set, or if set to 0, all rows will be scanned. Only one of rowsLimit and rowsLimitPercent can be\nspecified. Cannot be used in conjunction with TimespanConfig. When `null`, the `rows_limit` field will be omitted from the resulting object.\n - `rows_limit_percent` (`number`): Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down.\nMust be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of\nrowsLimit and rowsLimitPercent can be specified. Cannot be used in conjunction with TimespanConfig. When `null`, the `rows_limit_percent` field will be omitted from the resulting object.\n - `sample_method` (`string`): How to sample rows if not all rows are scanned. Meaningful only when used in conjunction with either\nrowsLimit or rowsLimitPercent. If not specified, rows are scanned in the order BigQuery reads them. Default value: "TOP" Possible values: ["TOP", "RANDOM_START"] When `null`, the `sample_method` field will be omitted from the resulting object.\n - `identifying_fields` (`list[obj]`): Specifies the BigQuery fields that will be returned with findings.\nIf not specified, no identifying fields will be returned for findings. When `null`, the `identifying_fields` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.storage_config.big_query_options.identifying_fields.new](#fn-inspect_jobinspect_jobstorage_configidentifying_fieldsnew) constructor.\n - `table_reference` (`list[obj]`): Set of files to scan. When `null`, the `table_reference` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.storage_config.big_query_options.table_reference.new](#fn-inspect_jobinspect_jobstorage_configtable_referencenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `big_query_options` sub block.\n', args=[]), new( identifying_fields=null, rows_limit=null, diff --git a/4.x/_gen/resources/database_migration_service_connection_profile.libsonnet b/4.x/_gen/resources/database_migration_service_connection_profile.libsonnet new file mode 100644 index 00000000..a745cef2 --- /dev/null +++ b/4.x/_gen/resources/database_migration_service_connection_profile.libsonnet @@ -0,0 +1,408 @@ +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='google_database_migration_service_connection_profile', url='', help='`google_database_migration_service_connection_profile` represents the `google-beta_google_database_migration_service_connection_profile` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + alloydb:: { + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.alloydb.new` constructs a new object with attributes and blocks configured for the `alloydb`\nTerraform sub block.\n\n\n\n**Args**:\n - `cluster_id` (`string`): Required. The AlloyDB cluster ID that this connection profile is associated with.\n - `settings` (`list[obj]`): Immutable. Metadata used to create the destination AlloyDB cluster. When `null`, the `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-beta.google_database_migration_service_connection_profile.alloydb.settings.new](#fn-alloydbsettingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `alloydb` sub block.\n', args=[]), + new( + cluster_id, + settings=null + ):: std.prune(a={ + cluster_id: cluster_id, + settings: settings, + }), + settings:: { + initial_user:: { + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.alloydb.settings.initial_user.new` constructs a new object with attributes and blocks configured for the `initial_user`\nTerraform sub block.\n\n\n\n**Args**:\n - `password` (`string`): The initial password for the user.\n - `user` (`string`): The database username.\n\n**Returns**:\n - An attribute object that represents the `initial_user` sub block.\n', args=[]), + new( + password, + user + ):: std.prune(a={ + password: password, + user: user, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.alloydb.settings.new` constructs a new object with attributes and blocks configured for the `settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `labels` (`obj`): Labels for the AlloyDB cluster created by DMS. When `null`, the `labels` field will be omitted from the resulting object.\n - `vpc_network` (`string`): Required. 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/{project_number}/global/networks/{network_id}'. This is required to create a cluster.\n - `initial_user` (`list[obj]`): Required. Input only. 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-beta.google_database_migration_service_connection_profile.alloydb.settings.initial_user.new](#fn-alloydballoydbinitial_usernew) constructor.\n - `primary_instance_settings` (`list[obj]`): Settings for the cluster's primary instance When `null`, the `primary_instance_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-beta.google_database_migration_service_connection_profile.alloydb.settings.primary_instance_settings.new](#fn-alloydballoydbprimary_instance_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `settings` sub block.\n', args=[]), + new( + vpc_network, + initial_user=null, + labels=null, + primary_instance_settings=null + ):: std.prune(a={ + initial_user: initial_user, + labels: labels, + primary_instance_settings: primary_instance_settings, + vpc_network: vpc_network, + }), + primary_instance_settings:: { + machine_config:: { + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.alloydb.settings.primary_instance_settings.machine_config.new` constructs a new object with attributes and blocks configured for the `machine_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `cpu_count` (`number`): The number of CPU's in the VM instance.\n\n**Returns**:\n - An attribute object that represents the `machine_config` sub block.\n', args=[]), + new( + cpu_count + ):: std.prune(a={ + cpu_count: cpu_count, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.alloydb.settings.primary_instance_settings.new` constructs a new object with attributes and blocks configured for the `primary_instance_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `database_flags` (`obj`): Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used. When `null`, the `database_flags` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels for the AlloyDB primary instance created by DMS. When `null`, the `labels` field will be omitted from the resulting object.\n - `machine_config` (`list[obj]`): Configuration for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.alloydb.settings.primary_instance_settings.machine_config.new](#fn-alloydballoydbsettingsmachine_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `primary_instance_settings` sub block.\n', args=[]), + new( + database_flags=null, + labels=null, + machine_config=null + ):: std.prune(a={ + database_flags: database_flags, + labels: labels, + machine_config: machine_config, + }), + }, + }, + }, + cloudsql:: { + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.cloudsql.new` constructs a new object with attributes and blocks configured for the `cloudsql`\nTerraform sub block.\n\n\n\n**Args**:\n - `settings` (`list[obj]`): Immutable. Metadata used to create the destination Cloud SQL database. When `null`, the `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-beta.google_database_migration_service_connection_profile.cloudsql.settings.new](#fn-cloudsqlsettingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `cloudsql` sub block.\n', args=[]), + new( + settings=null + ):: std.prune(a={ + settings: settings, + }), + settings:: { + ip_config:: { + authorized_networks:: { + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.cloudsql.settings.ip_config.authorized_networks.new` constructs a new object with attributes and blocks configured for the `authorized_networks`\nTerraform sub block.\n\n\n\n**Args**:\n - `expire_time` (`string`): The time when this access control entry expires in RFC 3339 format. When `null`, the `expire_time` field will be omitted from the resulting object.\n - `label` (`string`): A label to identify this entry. When `null`, the `label` field will be omitted from the resulting object.\n - `ttl` (`string`): Input only. The time-to-leave of this access control entry. When `null`, the `ttl` field will be omitted from the resulting object.\n - `value` (`string`): The allowlisted value for the access control list.\n\n**Returns**:\n - An attribute object that represents the `authorized_networks` sub block.\n', args=[]), + new( + value, + expire_time=null, + label=null, + ttl=null + ):: std.prune(a={ + expire_time: expire_time, + label: label, + ttl: ttl, + value: value, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.cloudsql.settings.ip_config.new` constructs a new object with attributes and blocks configured for the `ip_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `enable_ipv4` (`bool`): Whether the instance should be assigned an IPv4 address or not. When `null`, the `enable_ipv4` field will be omitted from the resulting object.\n - `private_network` (`string`): The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default.\nThis setting can be updated, but it cannot be removed after it is set. When `null`, the `private_network` field will be omitted from the resulting object.\n - `require_ssl` (`bool`): Whether SSL connections over IP should be enforced or not. When `null`, the `require_ssl` field will be omitted from the resulting object.\n - `authorized_networks` (`list[obj]`): The list of external networks that are allowed to connect to the instance using the IP. When `null`, the `authorized_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-beta.google_database_migration_service_connection_profile.cloudsql.settings.ip_config.authorized_networks.new](#fn-cloudsqlcloudsqlsettingsauthorized_networksnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ip_config` sub block.\n', args=[]), + new( + authorized_networks=null, + enable_ipv4=null, + private_network=null, + require_ssl=null + ):: std.prune(a={ + authorized_networks: authorized_networks, + enable_ipv4: enable_ipv4, + private_network: private_network, + require_ssl: require_ssl, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.cloudsql.settings.new` constructs a new object with attributes and blocks configured for the `settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `activation_policy` (`string`): The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Possible values: ["ALWAYS", "NEVER"] When `null`, the `activation_policy` field will be omitted from the resulting object.\n - `auto_storage_increase` (`bool`): If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity.\nIf the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB. When `null`, the `auto_storage_increase` field will be omitted from the resulting object.\n - `cmek_key_name` (`string`): The KMS key name used for the csql instance. When `null`, the `cmek_key_name` field will be omitted from the resulting object.\n - `collation` (`string`): The Cloud SQL default instance level collation. When `null`, the `collation` field will be omitted from the resulting object.\n - `data_disk_size_gb` (`string`): The storage capacity available to the database, in GB. The minimum (and default) size is 10GB. When `null`, the `data_disk_size_gb` field will be omitted from the resulting object.\n - `data_disk_type` (`string`): The type of storage. Possible values: ["PD_SSD", "PD_HDD"] When `null`, the `data_disk_type` field will be omitted from the resulting object.\n - `database_flags` (`obj`): The database flags passed to the Cloud SQL instance at startup. When `null`, the `database_flags` field will be omitted from the resulting object.\n - `database_version` (`string`): The database engine type and version.\nCurrently supported values located at https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.connectionProfiles#sqldatabaseversion When `null`, the `database_version` field will be omitted from the resulting object.\n - `root_password` (`string`): Input only. Initial root password. When `null`, the `root_password` field will be omitted from the resulting object.\n - `source_id` (`string`): The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID\n - `storage_auto_resize_limit` (`string`): The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. When `null`, the `storage_auto_resize_limit` field will be omitted from the resulting object.\n - `tier` (`string`): The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances).\nFor more information, see https://cloud.google.com/sql/docs/mysql/instance-settings When `null`, the `tier` field will be omitted from the resulting object.\n - `user_labels` (`obj`): The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. When `null`, the `user_labels` field will be omitted from the resulting object.\n - `zone` (`string`): The Google Cloud Platform zone where your Cloud SQL datdabse instance is located. When `null`, the `zone` field will be omitted from the resulting object.\n - `ip_config` (`list[obj]`): The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled. When `null`, the `ip_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-beta.google_database_migration_service_connection_profile.cloudsql.settings.ip_config.new](#fn-cloudsqlcloudsqlip_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `settings` sub block.\n', args=[]), + new( + source_id, + activation_policy=null, + auto_storage_increase=null, + cmek_key_name=null, + collation=null, + data_disk_size_gb=null, + data_disk_type=null, + database_flags=null, + database_version=null, + ip_config=null, + root_password=null, + storage_auto_resize_limit=null, + tier=null, + user_labels=null, + zone=null + ):: std.prune(a={ + activation_policy: activation_policy, + auto_storage_increase: auto_storage_increase, + cmek_key_name: cmek_key_name, + collation: collation, + data_disk_size_gb: data_disk_size_gb, + data_disk_type: data_disk_type, + database_flags: database_flags, + database_version: database_version, + ip_config: ip_config, + root_password: root_password, + source_id: source_id, + storage_auto_resize_limit: storage_auto_resize_limit, + tier: tier, + user_labels: user_labels, + zone: zone, + }), + }, + }, + mysql:: { + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.mysql.new` constructs a new object with attributes and blocks configured for the `mysql`\nTerraform sub block.\n\n\n\n**Args**:\n - `cloud_sql_id` (`string`): If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. When `null`, the `cloud_sql_id` field will be omitted from the resulting object.\n - `host` (`string`): Required. The IP or hostname of the source MySQL database.\n - `password` (`string`): Required. Input only. The password for the user that Database Migration Service will be using to connect to the database.\nThis field is not returned on request, and the value is encrypted when stored in Database Migration Service.\n - `port` (`number`): Required. The network port of the source MySQL database.\n - `username` (`string`): Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.\n - `ssl` (`list[obj]`): SSL configuration for the destination to connect to the source database. When `null`, the `ssl` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.mysql.ssl.new](#fn-mysqlsslnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `mysql` sub block.\n', args=[]), + new( + host, + password, + port, + username, + cloud_sql_id=null, + ssl=null + ):: std.prune(a={ + cloud_sql_id: cloud_sql_id, + host: host, + password: password, + port: port, + ssl: ssl, + username: username, + }), + ssl:: { + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.mysql.ssl.new` constructs a new object with attributes and blocks configured for the `ssl`\nTerraform sub block.\n\n\n\n**Args**:\n - `ca_certificate` (`string`): Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate.\nThe replica will use this certificate to verify it's connecting to the right host.\n - `client_certificate` (`string`): Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.\nIf this field is used then the 'clientKey' field is mandatory When `null`, the `client_certificate` field will be omitted from the resulting object.\n - `client_key` (`string`): Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate.\nIf this field is used then the 'clientCertificate' field is mandatory. When `null`, the `client_key` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ssl` sub block.\n', args=[]), + new( + ca_certificate, + client_certificate=null, + client_key=null + ):: std.prune(a={ + ca_certificate: ca_certificate, + client_certificate: client_certificate, + client_key: client_key, + }), + }, + }, + '#new':: d.fn(help="\n`google-beta.google_database_migration_service_connection_profile.new` injects a new `google-beta_google_database_migration_service_connection_profile` 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-beta.google_database_migration_service_connection_profile.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_database_migration_service_connection_profile` using the reference:\n\n $._ref.google-beta_google_database_migration_service_connection_profile.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_database_migration_service_connection_profile.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 - `connection_profile_id` (`string`): The ID of the connection profile.\n - `display_name` (`string`): The connection profile display name. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the connection profile should reside. When `null`, the `location` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `alloydb` (`list[obj]`): Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. When `null`, the `alloydb` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.alloydb.new](#fn-alloydbnew) constructor.\n - `cloudsql` (`list[obj]`): Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. When `null`, the `cloudsql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.cloudsql.new](#fn-cloudsqlnew) constructor.\n - `mysql` (`list[obj]`): Specifies connection parameters required specifically for MySQL databases. When `null`, the `mysql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.mysql.new](#fn-mysqlnew) constructor.\n - `postgresql` (`list[obj]`): Specifies connection parameters required specifically for PostgreSQL databases. When `null`, the `postgresql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.postgresql.new](#fn-postgresqlnew) 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-beta.google_database_migration_service_connection_profile.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, + connection_profile_id, + alloydb=null, + cloudsql=null, + display_name=null, + labels=null, + location=null, + mysql=null, + postgresql=null, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_database_migration_service_connection_profile', + label=resourceLabel, + attrs=self.newAttrs( + alloydb=alloydb, + cloudsql=cloudsql, + connection_profile_id=connection_profile_id, + display_name=display_name, + labels=labels, + location=location, + mysql=mysql, + postgresql=postgresql, + project=project, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.newAttrs` constructs a new object with attributes and blocks configured for the `google_database_migration_service_connection_profile`\nTerraform resource.\n\nUnlike [google-beta.google_database_migration_service_connection_profile.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 - `connection_profile_id` (`string`): The ID of the connection profile.\n - `display_name` (`string`): The connection profile display name. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the connection profile should reside. When `null`, the `location` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `alloydb` (`list[obj]`): Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. When `null`, the `alloydb` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.alloydb.new](#fn-alloydbnew) constructor.\n - `cloudsql` (`list[obj]`): Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. When `null`, the `cloudsql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.cloudsql.new](#fn-cloudsqlnew) constructor.\n - `mysql` (`list[obj]`): Specifies connection parameters required specifically for MySQL databases. When `null`, the `mysql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.mysql.new](#fn-mysqlnew) constructor.\n - `postgresql` (`list[obj]`): Specifies connection parameters required specifically for PostgreSQL databases. When `null`, the `postgresql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.postgresql.new](#fn-postgresqlnew) 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-beta.google_database_migration_service_connection_profile.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 `google_database_migration_service_connection_profile` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + connection_profile_id, + alloydb=null, + cloudsql=null, + display_name=null, + labels=null, + location=null, + mysql=null, + postgresql=null, + project=null, + timeouts=null + ):: std.prune(a={ + alloydb: alloydb, + cloudsql: cloudsql, + connection_profile_id: connection_profile_id, + display_name: display_name, + labels: labels, + location: location, + mysql: mysql, + postgresql: postgresql, + project: project, + timeouts: timeouts, + }), + postgresql:: { + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.postgresql.new` constructs a new object with attributes and blocks configured for the `postgresql`\nTerraform sub block.\n\n\n\n**Args**:\n - `cloud_sql_id` (`string`): If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. When `null`, the `cloud_sql_id` field will be omitted from the resulting object.\n - `host` (`string`): Required. The IP or hostname of the source MySQL database.\n - `password` (`string`): Required. Input only. The password for the user that Database Migration Service will be using to connect to the database.\nThis field is not returned on request, and the value is encrypted when stored in Database Migration Service.\n - `port` (`number`): Required. The network port of the source MySQL database.\n - `username` (`string`): Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.\n - `ssl` (`list[obj]`): SSL configuration for the destination to connect to the source database. When `null`, the `ssl` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.postgresql.ssl.new](#fn-postgresqlsslnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `postgresql` sub block.\n', args=[]), + new( + host, + password, + port, + username, + cloud_sql_id=null, + ssl=null + ):: std.prune(a={ + cloud_sql_id: cloud_sql_id, + host: host, + password: password, + port: port, + ssl: ssl, + username: username, + }), + ssl:: { + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.postgresql.ssl.new` constructs a new object with attributes and blocks configured for the `ssl`\nTerraform sub block.\n\n\n\n**Args**:\n - `ca_certificate` (`string`): Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate.\nThe replica will use this certificate to verify it's connecting to the right host.\n - `client_certificate` (`string`): Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.\nIf this field is used then the 'clientKey' field is mandatory When `null`, the `client_certificate` field will be omitted from the resulting object.\n - `client_key` (`string`): Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate.\nIf this field is used then the 'clientCertificate' field is mandatory. When `null`, the `client_key` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ssl` sub block.\n', args=[]), + new( + ca_certificate, + client_certificate=null, + client_key=null + ):: std.prune(a={ + ca_certificate: ca_certificate, + client_certificate: client_certificate, + client_key: client_key, + }), + }, + }, + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_database_migration_service_connection_profile.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, + }), + }, + '#withAlloydb':: d.fn(help='`google-beta.list[obj].withAlloydb` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the alloydb 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-beta.list[obj].withAlloydbMixin](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 `alloydb` field.\n', args=[]), + withAlloydb(resourceLabel, value): { + resource+: { + google_database_migration_service_connection_profile+: { + [resourceLabel]+: { + alloydb: value, + }, + }, + }, + }, + '#withAlloydbMixin':: d.fn(help='`google-beta.list[obj].withAlloydbMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the alloydb 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-beta.list[obj].withAlloydb](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 `alloydb` field.\n', args=[]), + withAlloydbMixin(resourceLabel, value): { + resource+: { + google_database_migration_service_connection_profile+: { + [resourceLabel]+: { + alloydb+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withCloudsql':: d.fn(help='`google-beta.list[obj].withCloudsql` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the cloudsql 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-beta.list[obj].withCloudsqlMixin](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 `cloudsql` field.\n', args=[]), + withCloudsql(resourceLabel, value): { + resource+: { + google_database_migration_service_connection_profile+: { + [resourceLabel]+: { + cloudsql: value, + }, + }, + }, + }, + '#withCloudsqlMixin':: d.fn(help='`google-beta.list[obj].withCloudsqlMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the cloudsql 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-beta.list[obj].withCloudsql](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 `cloudsql` field.\n', args=[]), + withCloudsqlMixin(resourceLabel, value): { + resource+: { + google_database_migration_service_connection_profile+: { + [resourceLabel]+: { + cloudsql+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withConnectionProfileId':: d.fn(help='`google-beta.string.withConnectionProfileId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the connection_profile_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 `connection_profile_id` field.\n', args=[]), + withConnectionProfileId(resourceLabel, value): { + resource+: { + google_database_migration_service_connection_profile+: { + [resourceLabel]+: { + connection_profile_id: value, + }, + }, + }, + }, + '#withDisplayName':: d.fn(help='`google-beta.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_database_migration_service_connection_profile+: { + [resourceLabel]+: { + display_name: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google-beta.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_database_migration_service_connection_profile+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google-beta.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_database_migration_service_connection_profile+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withMysql':: d.fn(help='`google-beta.list[obj].withMysql` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the mysql 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-beta.list[obj].withMysqlMixin](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 `mysql` field.\n', args=[]), + withMysql(resourceLabel, value): { + resource+: { + google_database_migration_service_connection_profile+: { + [resourceLabel]+: { + mysql: value, + }, + }, + }, + }, + '#withMysqlMixin':: d.fn(help='`google-beta.list[obj].withMysqlMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the mysql 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-beta.list[obj].withMysql](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 `mysql` field.\n', args=[]), + withMysqlMixin(resourceLabel, value): { + resource+: { + google_database_migration_service_connection_profile+: { + [resourceLabel]+: { + mysql+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withPostgresql':: d.fn(help='`google-beta.list[obj].withPostgresql` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the postgresql 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-beta.list[obj].withPostgresqlMixin](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 `postgresql` field.\n', args=[]), + withPostgresql(resourceLabel, value): { + resource+: { + google_database_migration_service_connection_profile+: { + [resourceLabel]+: { + postgresql: value, + }, + }, + }, + }, + '#withPostgresqlMixin':: d.fn(help='`google-beta.list[obj].withPostgresqlMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the postgresql 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-beta.list[obj].withPostgresql](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 `postgresql` field.\n', args=[]), + withPostgresqlMixin(resourceLabel, value): { + resource+: { + google_database_migration_service_connection_profile+: { + [resourceLabel]+: { + postgresql+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_database_migration_service_connection_profile+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.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-beta.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_database_migration_service_connection_profile+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.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-beta.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_database_migration_service_connection_profile+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/dialogflow_agent.libsonnet b/4.x/_gen/resources/dialogflow_agent.libsonnet index a0ae851a..fe0a06ee 100644 --- a/4.x/_gen/resources/dialogflow_agent.libsonnet +++ b/4.x/_gen/resources/dialogflow_agent.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='google_dialogflow_agent', url='', help='`google_dialogflow_agent` represents the `google-beta_google_dialogflow_agent` 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-beta.google_dialogflow_agent.new` injects a new `google-beta_google_dialogflow_agent` 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-beta.google_dialogflow_agent.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_dialogflow_agent` using the reference:\n\n $._ref.google-beta_google_dialogflow_agent.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_dialogflow_agent.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 - `api_version` (`string`): API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query\ndifferent service endpoints for different API versions. However, bots connectors and webhook calls will follow \nthe specified API version.\n* API_VERSION_V1: Legacy V1 API.\n* API_VERSION_V2: V2 API.\n* API_VERSION_V2_BETA_1: V2beta1 API. Possible values: [\u0026#34;API_VERSION_V1\u0026#34;, \u0026#34;API_VERSION_V2\u0026#34;, \u0026#34;API_VERSION_V2_BETA_1\u0026#34;] When `null`, the `api_version` field will be omitted from the resulting object.\n - `avatar_uri` (`string`): The URI of the agent\u0026#39;s avatar, which are used throughout the Dialogflow console. When an image URL is entered\ninto this field, the Dialogflow will save the image in the backend. The address of the backend image returned\nfrom the API will be shown in the [avatarUriBackend] field. When `null`, the `avatar_uri` field will be omitted from the resulting object.\n - `classification_threshold` (`number`): To filter out false positive results and still get variety in matched natural language inputs for your agent,\nyou can tune the machine learning classification threshold. If the returned score value is less than the threshold\nvalue, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be \ntriggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the \ndefault of 0.3 is used. When `null`, the `classification_threshold` field will be omitted from the resulting object.\n - `default_language_code` (`string`): The default language of the agent as a language tag. [See Language Support](https://cloud.google.com/dialogflow/docs/reference/language) \nfor a list of the currently supported language codes. This field cannot be updated after creation.\n - `description` (`string`): The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The name of this agent.\n - `enable_logging` (`bool`): Determines whether this agent should log conversation queries. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `match_mode` (`string`): Determines how intents are detected from user queries.\n* MATCH_MODE_HYBRID: Best for agents with a small number of examples in intents and/or wide use of templates\nsyntax and composite entities.\n* MATCH_MODE_ML_ONLY: Can be used for agents with a large number of examples in intents, especially the ones\nusing @sys.any or very large developer entities. Possible values: [\u0026#34;MATCH_MODE_HYBRID\u0026#34;, \u0026#34;MATCH_MODE_ML_ONLY\u0026#34;] When `null`, the `match_mode` 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 - `supported_language_codes` (`list`): The list of all languages supported by this agent (except for the defaultLanguageCode). When `null`, the `supported_language_codes` field will be omitted from the resulting object.\n - `tier` (`string`): The agent tier. If not specified, TIER_STANDARD is assumed.\n* TIER_STANDARD: Standard tier.\n* TIER_ENTERPRISE: Enterprise tier (Essentials).\n* TIER_ENTERPRISE_PLUS: Enterprise tier (Plus).\nNOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between \nthe Terraform state and Dialogflow if the agent tier is changed outside of Terraform. Possible values: [\u0026#34;TIER_STANDARD\u0026#34;, \u0026#34;TIER_ENTERPRISE\u0026#34;, \u0026#34;TIER_ENTERPRISE_PLUS\u0026#34;] When `null`, the `tier` field will be omitted from the resulting object.\n - `time_zone` (`string`): The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York,\nEurope/Paris.\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-beta.google_dialogflow_agent.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-beta.google_dialogflow_agent.new` injects a new `google-beta_google_dialogflow_agent` 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-beta.google_dialogflow_agent.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_dialogflow_agent` using the reference:\n\n $._ref.google-beta_google_dialogflow_agent.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_dialogflow_agent.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 - `api_version` (`string`): API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query\ndifferent service endpoints for different API versions. However, bots connectors and webhook calls will follow\nthe specified API version.\n* API_VERSION_V1: Legacy V1 API.\n* API_VERSION_V2: V2 API.\n* API_VERSION_V2_BETA_1: V2beta1 API. Possible values: [\u0026#34;API_VERSION_V1\u0026#34;, \u0026#34;API_VERSION_V2\u0026#34;, \u0026#34;API_VERSION_V2_BETA_1\u0026#34;] When `null`, the `api_version` field will be omitted from the resulting object.\n - `avatar_uri` (`string`): The URI of the agent\u0026#39;s avatar, which are used throughout the Dialogflow console. When an image URL is entered\ninto this field, the Dialogflow will save the image in the backend. The address of the backend image returned\nfrom the API will be shown in the [avatarUriBackend] field. When `null`, the `avatar_uri` field will be omitted from the resulting object.\n - `classification_threshold` (`number`): To filter out false positive results and still get variety in matched natural language inputs for your agent,\nyou can tune the machine learning classification threshold. If the returned score value is less than the threshold\nvalue, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be\ntriggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the\ndefault of 0.3 is used. When `null`, the `classification_threshold` field will be omitted from the resulting object.\n - `default_language_code` (`string`): The default language of the agent as a language tag. [See Language Support](https://cloud.google.com/dialogflow/docs/reference/language)\nfor a list of the currently supported language codes. This field cannot be updated after creation.\n - `description` (`string`): The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The name of this agent.\n - `enable_logging` (`bool`): Determines whether this agent should log conversation queries. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `match_mode` (`string`): Determines how intents are detected from user queries.\n* MATCH_MODE_HYBRID: Best for agents with a small number of examples in intents and/or wide use of templates\nsyntax and composite entities.\n* MATCH_MODE_ML_ONLY: Can be used for agents with a large number of examples in intents, especially the ones\nusing @sys.any or very large developer entities. Possible values: [\u0026#34;MATCH_MODE_HYBRID\u0026#34;, \u0026#34;MATCH_MODE_ML_ONLY\u0026#34;] When `null`, the `match_mode` 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 - `supported_language_codes` (`list`): The list of all languages supported by this agent (except for the defaultLanguageCode). When `null`, the `supported_language_codes` field will be omitted from the resulting object.\n - `tier` (`string`): The agent tier. If not specified, TIER_STANDARD is assumed.\n* TIER_STANDARD: Standard tier.\n* TIER_ENTERPRISE: Enterprise tier (Essentials).\n* TIER_ENTERPRISE_PLUS: Enterprise tier (Plus).\nNOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between\nthe Terraform state and Dialogflow if the agent tier is changed outside of Terraform. Possible values: [\u0026#34;TIER_STANDARD\u0026#34;, \u0026#34;TIER_ENTERPRISE\u0026#34;, \u0026#34;TIER_ENTERPRISE_PLUS\u0026#34;] When `null`, the `tier` field will be omitted from the resulting object.\n - `time_zone` (`string`): The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York,\nEurope/Paris.\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-beta.google_dialogflow_agent.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, default_language_code, @@ -39,7 +39,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_dialogflow_agent.newAttrs` constructs a new object with attributes and blocks configured for the `google_dialogflow_agent`\nTerraform resource.\n\nUnlike [google-beta.google_dialogflow_agent.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 - `api_version` (`string`): API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query\ndifferent service endpoints for different API versions. However, bots connectors and webhook calls will follow \nthe specified API version.\n* API_VERSION_V1: Legacy V1 API.\n* API_VERSION_V2: V2 API.\n* API_VERSION_V2_BETA_1: V2beta1 API. Possible values: ["API_VERSION_V1", "API_VERSION_V2", "API_VERSION_V2_BETA_1"] When `null`, the `api_version` field will be omitted from the resulting object.\n - `avatar_uri` (`string`): The URI of the agent's avatar, which are used throughout the Dialogflow console. When an image URL is entered\ninto this field, the Dialogflow will save the image in the backend. The address of the backend image returned\nfrom the API will be shown in the [avatarUriBackend] field. When `null`, the `avatar_uri` field will be omitted from the resulting object.\n - `classification_threshold` (`number`): To filter out false positive results and still get variety in matched natural language inputs for your agent,\nyou can tune the machine learning classification threshold. If the returned score value is less than the threshold\nvalue, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be \ntriggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the \ndefault of 0.3 is used. When `null`, the `classification_threshold` field will be omitted from the resulting object.\n - `default_language_code` (`string`): The default language of the agent as a language tag. [See Language Support](https://cloud.google.com/dialogflow/docs/reference/language) \nfor a list of the currently supported language codes. This field cannot be updated after creation.\n - `description` (`string`): The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The name of this agent.\n - `enable_logging` (`bool`): Determines whether this agent should log conversation queries. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `match_mode` (`string`): Determines how intents are detected from user queries.\n* MATCH_MODE_HYBRID: Best for agents with a small number of examples in intents and/or wide use of templates\nsyntax and composite entities.\n* MATCH_MODE_ML_ONLY: Can be used for agents with a large number of examples in intents, especially the ones\nusing @sys.any or very large developer entities. Possible values: ["MATCH_MODE_HYBRID", "MATCH_MODE_ML_ONLY"] When `null`, the `match_mode` 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 - `supported_language_codes` (`list`): The list of all languages supported by this agent (except for the defaultLanguageCode). When `null`, the `supported_language_codes` field will be omitted from the resulting object.\n - `tier` (`string`): The agent tier. If not specified, TIER_STANDARD is assumed.\n* TIER_STANDARD: Standard tier.\n* TIER_ENTERPRISE: Enterprise tier (Essentials).\n* TIER_ENTERPRISE_PLUS: Enterprise tier (Plus).\nNOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between \nthe Terraform state and Dialogflow if the agent tier is changed outside of Terraform. Possible values: ["TIER_STANDARD", "TIER_ENTERPRISE", "TIER_ENTERPRISE_PLUS"] When `null`, the `tier` field will be omitted from the resulting object.\n - `time_zone` (`string`): The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York,\nEurope/Paris.\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-beta.google_dialogflow_agent.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 `google_dialogflow_agent` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_dialogflow_agent.newAttrs` constructs a new object with attributes and blocks configured for the `google_dialogflow_agent`\nTerraform resource.\n\nUnlike [google-beta.google_dialogflow_agent.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 - `api_version` (`string`): API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query\ndifferent service endpoints for different API versions. However, bots connectors and webhook calls will follow\nthe specified API version.\n* API_VERSION_V1: Legacy V1 API.\n* API_VERSION_V2: V2 API.\n* API_VERSION_V2_BETA_1: V2beta1 API. Possible values: ["API_VERSION_V1", "API_VERSION_V2", "API_VERSION_V2_BETA_1"] When `null`, the `api_version` field will be omitted from the resulting object.\n - `avatar_uri` (`string`): The URI of the agent's avatar, which are used throughout the Dialogflow console. When an image URL is entered\ninto this field, the Dialogflow will save the image in the backend. The address of the backend image returned\nfrom the API will be shown in the [avatarUriBackend] field. When `null`, the `avatar_uri` field will be omitted from the resulting object.\n - `classification_threshold` (`number`): To filter out false positive results and still get variety in matched natural language inputs for your agent,\nyou can tune the machine learning classification threshold. If the returned score value is less than the threshold\nvalue, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be\ntriggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the\ndefault of 0.3 is used. When `null`, the `classification_threshold` field will be omitted from the resulting object.\n - `default_language_code` (`string`): The default language of the agent as a language tag. [See Language Support](https://cloud.google.com/dialogflow/docs/reference/language)\nfor a list of the currently supported language codes. This field cannot be updated after creation.\n - `description` (`string`): The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The name of this agent.\n - `enable_logging` (`bool`): Determines whether this agent should log conversation queries. When `null`, the `enable_logging` field will be omitted from the resulting object.\n - `match_mode` (`string`): Determines how intents are detected from user queries.\n* MATCH_MODE_HYBRID: Best for agents with a small number of examples in intents and/or wide use of templates\nsyntax and composite entities.\n* MATCH_MODE_ML_ONLY: Can be used for agents with a large number of examples in intents, especially the ones\nusing @sys.any or very large developer entities. Possible values: ["MATCH_MODE_HYBRID", "MATCH_MODE_ML_ONLY"] When `null`, the `match_mode` 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 - `supported_language_codes` (`list`): The list of all languages supported by this agent (except for the defaultLanguageCode). When `null`, the `supported_language_codes` field will be omitted from the resulting object.\n - `tier` (`string`): The agent tier. If not specified, TIER_STANDARD is assumed.\n* TIER_STANDARD: Standard tier.\n* TIER_ENTERPRISE: Enterprise tier (Essentials).\n* TIER_ENTERPRISE_PLUS: Enterprise tier (Plus).\nNOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between\nthe Terraform state and Dialogflow if the agent tier is changed outside of Terraform. Possible values: ["TIER_STANDARD", "TIER_ENTERPRISE", "TIER_ENTERPRISE_PLUS"] When `null`, the `tier` field will be omitted from the resulting object.\n - `time_zone` (`string`): The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York,\nEurope/Paris.\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-beta.google_dialogflow_agent.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 `google_dialogflow_agent` resource into the root Terraform configuration.\n', args=[]), newAttrs( default_language_code, display_name, diff --git a/4.x/_gen/resources/dialogflow_intent.libsonnet b/4.x/_gen/resources/dialogflow_intent.libsonnet index 938e5857..e5857599 100644 --- a/4.x/_gen/resources/dialogflow_intent.libsonnet +++ b/4.x/_gen/resources/dialogflow_intent.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='google_dialogflow_intent', url='', help='`google_dialogflow_intent` represents the `google-beta_google_dialogflow_intent` 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-beta.google_dialogflow_intent.new` injects a new `google-beta_google_dialogflow_intent` 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-beta.google_dialogflow_intent.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_dialogflow_intent` using the reference:\n\n $._ref.google-beta_google_dialogflow_intent.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_dialogflow_intent.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 - `action` (`string`): The name of the action associated with the intent.\nNote: The action name must not contain whitespaces. When `null`, the `action` field will be omitted from the resulting object.\n - `default_response_platforms` (`list`): The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED\n(i.e. default platform). Possible values: [\u0026#34;FACEBOOK\u0026#34;, \u0026#34;SLACK\u0026#34;, \u0026#34;TELEGRAM\u0026#34;, \u0026#34;KIK\u0026#34;, \u0026#34;SKYPE\u0026#34;, \u0026#34;LINE\u0026#34;, \u0026#34;VIBER\u0026#34;, \u0026#34;ACTIONS_ON_GOOGLE\u0026#34;, \u0026#34;GOOGLE_HANGOUTS\u0026#34;] When `null`, the `default_response_platforms` field will be omitted from the resulting object.\n - `display_name` (`string`): The name of this intent to be displayed on the console.\n - `events` (`list`): The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of\nthe contexts must be present in the active user session for an event to trigger this intent. See the \n[events reference](https://cloud.google.com/dialogflow/docs/events-overview) for more details. When `null`, the `events` field will be omitted from the resulting object.\n - `input_context_names` (`list`): The list of context names required for this intent to be triggered.\nFormat: projects/\u0026lt;Project ID\u0026gt;/agent/sessions/-/contexts/\u0026lt;Context ID\u0026gt;. When `null`, the `input_context_names` field will be omitted from the resulting object.\n - `is_fallback` (`bool`): Indicates whether this is a fallback intent. When `null`, the `is_fallback` field will be omitted from the resulting object.\n - `ml_disabled` (`bool`): Indicates whether Machine Learning is disabled for the intent.\nNote: If mlDisabled setting is set to true, then this intent is not taken into account during inference in ML\nONLY match mode. Also, auto-markup in the UI is turned off. When `null`, the `ml_disabled` field will be omitted from the resulting object.\n - `parent_followup_intent_name` (`string`): The unique identifier of the parent intent in the chain of followup intents.\nFormat: projects/\u0026lt;Project ID\u0026gt;/agent/intents/\u0026lt;Intent ID\u0026gt;. When `null`, the `parent_followup_intent_name` field will be omitted from the resulting object.\n - `priority` (`number`): The priority of this intent. Higher numbers represent higher priorities.\n - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds\n to the Normal priority in the console.\n - If the supplied value is negative, the intent is ignored in runtime detect intent requests. When `null`, the `priority` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `reset_contexts` (`bool`): Indicates whether to delete all contexts in the current session when this intent is matched. When `null`, the `reset_contexts` field will be omitted from the resulting object.\n - `webhook_state` (`string`): Indicates whether webhooks are enabled for the intent.\n* WEBHOOK_STATE_ENABLED: Webhook is enabled in the agent and in the intent.\n* WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING: Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook. Possible values: [\u0026#34;WEBHOOK_STATE_ENABLED\u0026#34;, \u0026#34;WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING\u0026#34;] When `null`, the `webhook_state` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dialogflow_intent.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-beta.google_dialogflow_intent.new` injects a new `google-beta_google_dialogflow_intent` 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-beta.google_dialogflow_intent.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_dialogflow_intent` using the reference:\n\n $._ref.google-beta_google_dialogflow_intent.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_dialogflow_intent.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 - `action` (`string`): The name of the action associated with the intent.\nNote: The action name must not contain whitespaces. When `null`, the `action` field will be omitted from the resulting object.\n - `default_response_platforms` (`list`): The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED\n(i.e. default platform). Possible values: [\u0026#34;FACEBOOK\u0026#34;, \u0026#34;SLACK\u0026#34;, \u0026#34;TELEGRAM\u0026#34;, \u0026#34;KIK\u0026#34;, \u0026#34;SKYPE\u0026#34;, \u0026#34;LINE\u0026#34;, \u0026#34;VIBER\u0026#34;, \u0026#34;ACTIONS_ON_GOOGLE\u0026#34;, \u0026#34;GOOGLE_HANGOUTS\u0026#34;] When `null`, the `default_response_platforms` field will be omitted from the resulting object.\n - `display_name` (`string`): The name of this intent to be displayed on the console.\n - `events` (`list`): The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of\nthe contexts must be present in the active user session for an event to trigger this intent. See the\n[events reference](https://cloud.google.com/dialogflow/docs/events-overview) for more details. When `null`, the `events` field will be omitted from the resulting object.\n - `input_context_names` (`list`): The list of context names required for this intent to be triggered.\nFormat: projects/\u0026lt;Project ID\u0026gt;/agent/sessions/-/contexts/\u0026lt;Context ID\u0026gt;. When `null`, the `input_context_names` field will be omitted from the resulting object.\n - `is_fallback` (`bool`): Indicates whether this is a fallback intent. When `null`, the `is_fallback` field will be omitted from the resulting object.\n - `ml_disabled` (`bool`): Indicates whether Machine Learning is disabled for the intent.\nNote: If mlDisabled setting is set to true, then this intent is not taken into account during inference in ML\nONLY match mode. Also, auto-markup in the UI is turned off. When `null`, the `ml_disabled` field will be omitted from the resulting object.\n - `parent_followup_intent_name` (`string`): The unique identifier of the parent intent in the chain of followup intents.\nFormat: projects/\u0026lt;Project ID\u0026gt;/agent/intents/\u0026lt;Intent ID\u0026gt;. When `null`, the `parent_followup_intent_name` field will be omitted from the resulting object.\n - `priority` (`number`): The priority of this intent. Higher numbers represent higher priorities.\n - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds\n to the Normal priority in the console.\n - If the supplied value is negative, the intent is ignored in runtime detect intent requests. When `null`, the `priority` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `reset_contexts` (`bool`): Indicates whether to delete all contexts in the current session when this intent is matched. When `null`, the `reset_contexts` field will be omitted from the resulting object.\n - `webhook_state` (`string`): Indicates whether webhooks are enabled for the intent.\n* WEBHOOK_STATE_ENABLED: Webhook is enabled in the agent and in the intent.\n* WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING: Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook. Possible values: [\u0026#34;WEBHOOK_STATE_ENABLED\u0026#34;, \u0026#34;WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING\u0026#34;] When `null`, the `webhook_state` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dialogflow_intent.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, @@ -39,7 +39,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_dialogflow_intent.newAttrs` constructs a new object with attributes and blocks configured for the `google_dialogflow_intent`\nTerraform resource.\n\nUnlike [google-beta.google_dialogflow_intent.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 - `action` (`string`): The name of the action associated with the intent.\nNote: The action name must not contain whitespaces. When `null`, the `action` field will be omitted from the resulting object.\n - `default_response_platforms` (`list`): The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED\n(i.e. default platform). Possible values: ["FACEBOOK", "SLACK", "TELEGRAM", "KIK", "SKYPE", "LINE", "VIBER", "ACTIONS_ON_GOOGLE", "GOOGLE_HANGOUTS"] When `null`, the `default_response_platforms` field will be omitted from the resulting object.\n - `display_name` (`string`): The name of this intent to be displayed on the console.\n - `events` (`list`): The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of\nthe contexts must be present in the active user session for an event to trigger this intent. See the \n[events reference](https://cloud.google.com/dialogflow/docs/events-overview) for more details. When `null`, the `events` field will be omitted from the resulting object.\n - `input_context_names` (`list`): The list of context names required for this intent to be triggered.\nFormat: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>. When `null`, the `input_context_names` field will be omitted from the resulting object.\n - `is_fallback` (`bool`): Indicates whether this is a fallback intent. When `null`, the `is_fallback` field will be omitted from the resulting object.\n - `ml_disabled` (`bool`): Indicates whether Machine Learning is disabled for the intent.\nNote: If mlDisabled setting is set to true, then this intent is not taken into account during inference in ML\nONLY match mode. Also, auto-markup in the UI is turned off. When `null`, the `ml_disabled` field will be omitted from the resulting object.\n - `parent_followup_intent_name` (`string`): The unique identifier of the parent intent in the chain of followup intents.\nFormat: projects/<Project ID>/agent/intents/<Intent ID>. When `null`, the `parent_followup_intent_name` field will be omitted from the resulting object.\n - `priority` (`number`): The priority of this intent. Higher numbers represent higher priorities.\n - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds\n to the Normal priority in the console.\n - If the supplied value is negative, the intent is ignored in runtime detect intent requests. When `null`, the `priority` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `reset_contexts` (`bool`): Indicates whether to delete all contexts in the current session when this intent is matched. When `null`, the `reset_contexts` field will be omitted from the resulting object.\n - `webhook_state` (`string`): Indicates whether webhooks are enabled for the intent.\n* WEBHOOK_STATE_ENABLED: Webhook is enabled in the agent and in the intent.\n* WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING: Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook. Possible values: ["WEBHOOK_STATE_ENABLED", "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING"] When `null`, the `webhook_state` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dialogflow_intent.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 `google_dialogflow_intent` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_dialogflow_intent.newAttrs` constructs a new object with attributes and blocks configured for the `google_dialogflow_intent`\nTerraform resource.\n\nUnlike [google-beta.google_dialogflow_intent.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 - `action` (`string`): The name of the action associated with the intent.\nNote: The action name must not contain whitespaces. When `null`, the `action` field will be omitted from the resulting object.\n - `default_response_platforms` (`list`): The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED\n(i.e. default platform). Possible values: ["FACEBOOK", "SLACK", "TELEGRAM", "KIK", "SKYPE", "LINE", "VIBER", "ACTIONS_ON_GOOGLE", "GOOGLE_HANGOUTS"] When `null`, the `default_response_platforms` field will be omitted from the resulting object.\n - `display_name` (`string`): The name of this intent to be displayed on the console.\n - `events` (`list`): The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of\nthe contexts must be present in the active user session for an event to trigger this intent. See the\n[events reference](https://cloud.google.com/dialogflow/docs/events-overview) for more details. When `null`, the `events` field will be omitted from the resulting object.\n - `input_context_names` (`list`): The list of context names required for this intent to be triggered.\nFormat: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>. When `null`, the `input_context_names` field will be omitted from the resulting object.\n - `is_fallback` (`bool`): Indicates whether this is a fallback intent. When `null`, the `is_fallback` field will be omitted from the resulting object.\n - `ml_disabled` (`bool`): Indicates whether Machine Learning is disabled for the intent.\nNote: If mlDisabled setting is set to true, then this intent is not taken into account during inference in ML\nONLY match mode. Also, auto-markup in the UI is turned off. When `null`, the `ml_disabled` field will be omitted from the resulting object.\n - `parent_followup_intent_name` (`string`): The unique identifier of the parent intent in the chain of followup intents.\nFormat: projects/<Project ID>/agent/intents/<Intent ID>. When `null`, the `parent_followup_intent_name` field will be omitted from the resulting object.\n - `priority` (`number`): The priority of this intent. Higher numbers represent higher priorities.\n - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds\n to the Normal priority in the console.\n - If the supplied value is negative, the intent is ignored in runtime detect intent requests. When `null`, the `priority` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `reset_contexts` (`bool`): Indicates whether to delete all contexts in the current session when this intent is matched. When `null`, the `reset_contexts` field will be omitted from the resulting object.\n - `webhook_state` (`string`): Indicates whether webhooks are enabled for the intent.\n* WEBHOOK_STATE_ENABLED: Webhook is enabled in the agent and in the intent.\n* WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING: Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook. Possible values: ["WEBHOOK_STATE_ENABLED", "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING"] When `null`, the `webhook_state` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dialogflow_intent.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 `google_dialogflow_intent` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, action=null, diff --git a/4.x/_gen/resources/dns_managed_zone.libsonnet b/4.x/_gen/resources/dns_managed_zone.libsonnet index 2c23a309..833b528c 100644 --- a/4.x/_gen/resources/dns_managed_zone.libsonnet +++ b/4.x/_gen/resources/dns_managed_zone.libsonnet @@ -149,7 +149,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, private_visibility_config:: { gke_clusters:: { - '#new':: d.fn(help='\n`google-beta.google_dns_managed_zone.private_visibility_config.gke_clusters.new` constructs a new object with attributes and blocks configured for the `gke_clusters`\nTerraform sub block.\n\n\n\n**Args**:\n - `gke_cluster_name` (`string`): The resource name of the cluster to bind this ManagedZone to. \nThis should be specified in the format like \n'projects/*/locations/*/clusters/*'\n\n**Returns**:\n - An attribute object that represents the `gke_clusters` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_dns_managed_zone.private_visibility_config.gke_clusters.new` constructs a new object with attributes and blocks configured for the `gke_clusters`\nTerraform sub block.\n\n\n\n**Args**:\n - `gke_cluster_name` (`string`): The resource name of the cluster to bind this ManagedZone to.\nThis should be specified in the format like\n'projects/*/locations/*/clusters/*'\n\n**Returns**:\n - An attribute object that represents the `gke_clusters` sub block.\n', args=[]), new( gke_cluster_name ):: std.prune(a={ diff --git a/4.x/_gen/resources/dns_response_policy.libsonnet b/4.x/_gen/resources/dns_response_policy.libsonnet index 8e834034..c01becd4 100644 --- a/4.x/_gen/resources/dns_response_policy.libsonnet +++ b/4.x/_gen/resources/dns_response_policy.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_dns_response_policy', url='', help='`google_dns_response_policy` represents the `google-beta_google_dns_response_policy` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), gke_clusters:: { - '#new':: d.fn(help='\n`google-beta.google_dns_response_policy.gke_clusters.new` constructs a new object with attributes and blocks configured for the `gke_clusters`\nTerraform sub block.\n\n\n\n**Args**:\n - `gke_cluster_name` (`string`): The resource name of the cluster to bind this ManagedZone to. \nThis should be specified in the format like \n'projects/*/locations/*/clusters/*'\n\n**Returns**:\n - An attribute object that represents the `gke_clusters` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_dns_response_policy.gke_clusters.new` constructs a new object with attributes and blocks configured for the `gke_clusters`\nTerraform sub block.\n\n\n\n**Args**:\n - `gke_cluster_name` (`string`): The resource name of the cluster to bind this ManagedZone to.\nThis should be specified in the format like\n'projects/*/locations/*/clusters/*'\n\n**Returns**:\n - An attribute object that represents the `gke_clusters` sub block.\n', args=[]), new( gke_cluster_name ):: std.prune(a={ diff --git a/4.x/_gen/resources/firebase_apple_app.libsonnet b/4.x/_gen/resources/firebase_apple_app.libsonnet index f60c5443..7641f0c8 100644 --- a/4.x/_gen/resources/firebase_apple_app.libsonnet +++ b/4.x/_gen/resources/firebase_apple_app.libsonnet @@ -2,12 +2,12 @@ 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='google_firebase_apple_app', url='', help='`google_firebase_apple_app` represents the `google-beta_google_firebase_apple_app` 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-beta.google_firebase_apple_app.new` injects a new `google-beta_google_firebase_apple_app` 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-beta.google_firebase_apple_app.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_firebase_apple_app` using the reference:\n\n $._ref.google-beta_google_firebase_apple_app.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_firebase_apple_app.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_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object.\n - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore. When `null`, the `bundle_id` field will be omitted from the resulting object.\n - `deletion_policy` (`string`): (Optional) Set to \u0026#39;ABANDON\u0026#39; to allow the Apple to be untracked from terraform state\nrather than deleted upon \u0026#39;terraform destroy\u0026#39;. This is useful because the Apple may be\nserving traffic. Set to \u0026#39;DELETE\u0026#39; to delete the Apple. Defaults to \u0026#39;DELETE\u0026#39;. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\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 - `team_id` (`string`): The Apple Developer Team ID associated with the App in the App Store. When `null`, the `team_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_apple_app.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-beta.google_firebase_apple_app.new` injects a new `google-beta_google_firebase_apple_app` 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-beta.google_firebase_apple_app.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_firebase_apple_app` using the reference:\n\n $._ref.google-beta_google_firebase_apple_app.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_firebase_apple_app.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_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object.\n - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore.\n - `deletion_policy` (`string`): (Optional) Set to \u0026#39;ABANDON\u0026#39; to allow the Apple to be untracked from terraform state\nrather than deleted upon \u0026#39;terraform destroy\u0026#39;. This is useful because the Apple may be\nserving traffic. Set to \u0026#39;DELETE\u0026#39; to delete the Apple. Defaults to \u0026#39;DELETE\u0026#39;. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\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 - `team_id` (`string`): The Apple Developer Team ID associated with the App in the App Store. When `null`, the `team_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_apple_app.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, + bundle_id, display_name, app_store_id=null, - bundle_id=null, deletion_policy=null, project=null, team_id=null, @@ -27,11 +27,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_firebase_apple_app.newAttrs` constructs a new object with attributes and blocks configured for the `google_firebase_apple_app`\nTerraform resource.\n\nUnlike [google-beta.google_firebase_apple_app.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_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object.\n - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore. When `null`, the `bundle_id` field will be omitted from the resulting object.\n - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the Apple to be untracked from terraform state\nrather than deleted upon 'terraform destroy'. This is useful because the Apple may be\nserving traffic. Set to 'DELETE' to delete the Apple. Defaults to 'DELETE'. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `team_id` (`string`): The Apple Developer Team ID associated with the App in the App Store. When `null`, the `team_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_apple_app.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 `google_firebase_apple_app` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_firebase_apple_app.newAttrs` constructs a new object with attributes and blocks configured for the `google_firebase_apple_app`\nTerraform resource.\n\nUnlike [google-beta.google_firebase_apple_app.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_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object.\n - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore.\n - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the Apple to be untracked from terraform state\nrather than deleted upon 'terraform destroy'. This is useful because the Apple may be\nserving traffic. Set to 'DELETE' to delete the Apple. Defaults to 'DELETE'. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `team_id` (`string`): The Apple Developer Team ID associated with the App in the App Store. When `null`, the `team_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_apple_app.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 `google_firebase_apple_app` resource into the root Terraform configuration.\n', args=[]), newAttrs( + bundle_id, display_name, app_store_id=null, - bundle_id=null, deletion_policy=null, project=null, team_id=null, diff --git a/4.x/_gen/resources/firebase_database_instance.libsonnet b/4.x/_gen/resources/firebase_database_instance.libsonnet index 0d83ddce..254d75ed 100644 --- a/4.x/_gen/resources/firebase_database_instance.libsonnet +++ b/4.x/_gen/resources/firebase_database_instance.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='google_firebase_database_instance', url='', help='`google_firebase_database_instance` represents the `google-beta_google_firebase_database_instance` 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-beta.google_firebase_database_instance.new` injects a new `google-beta_google_firebase_database_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-beta.google_firebase_database_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_firebase_database_instance` using the reference:\n\n $._ref.google-beta_google_firebase_database_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_firebase_database_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 - `desired_state` (`string`): The intended database state. When `null`, the `desired_state` field will be omitted from the resulting object.\n - `instance_id` (`string`): The globally unique identifier of the Firebase Realtime Database instance. \nInstance IDs cannot be reused after deletion.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): A reference to the region where the Firebase Realtime database resides.\nCheck all [available regions](https://firebase.google.com/docs/projects/locations#rtdb-locations)\n - `type` (`string`): The database type.\nEach project can create one default Firebase Realtime Database, which cannot be deleted once created.\nCreating user Databases is only available for projects on the Blaze plan.\nProjects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value: \u0026#34;USER_DATABASE\u0026#34; Possible values: [\u0026#34;DEFAULT_DATABASE\u0026#34;, \u0026#34;USER_DATABASE\u0026#34;] When `null`, the `type` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_database_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-beta.google_firebase_database_instance.new` injects a new `google-beta_google_firebase_database_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-beta.google_firebase_database_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_firebase_database_instance` using the reference:\n\n $._ref.google-beta_google_firebase_database_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_firebase_database_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 - `desired_state` (`string`): The intended database state. When `null`, the `desired_state` field will be omitted from the resulting object.\n - `instance_id` (`string`): The globally unique identifier of the Firebase Realtime Database instance.\nInstance IDs cannot be reused after deletion.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): A reference to the region where the Firebase Realtime database resides.\nCheck all [available regions](https://firebase.google.com/docs/projects/locations#rtdb-locations)\n - `type` (`string`): The database type.\nEach project can create one default Firebase Realtime Database, which cannot be deleted once created.\nCreating user Databases is only available for projects on the Blaze plan.\nProjects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value: \u0026#34;USER_DATABASE\u0026#34; Possible values: [\u0026#34;DEFAULT_DATABASE\u0026#34;, \u0026#34;USER_DATABASE\u0026#34;] When `null`, the `type` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_database_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, instance_id, @@ -25,7 +25,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_firebase_database_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_firebase_database_instance`\nTerraform resource.\n\nUnlike [google-beta.google_firebase_database_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 - `desired_state` (`string`): The intended database state. When `null`, the `desired_state` field will be omitted from the resulting object.\n - `instance_id` (`string`): The globally unique identifier of the Firebase Realtime Database instance. \nInstance IDs cannot be reused after deletion.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): A reference to the region where the Firebase Realtime database resides.\nCheck all [available regions](https://firebase.google.com/docs/projects/locations#rtdb-locations)\n - `type` (`string`): The database type.\nEach project can create one default Firebase Realtime Database, which cannot be deleted once created.\nCreating user Databases is only available for projects on the Blaze plan.\nProjects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value: "USER_DATABASE" Possible values: ["DEFAULT_DATABASE", "USER_DATABASE"] When `null`, the `type` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_database_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 `google_firebase_database_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_firebase_database_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_firebase_database_instance`\nTerraform resource.\n\nUnlike [google-beta.google_firebase_database_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 - `desired_state` (`string`): The intended database state. When `null`, the `desired_state` field will be omitted from the resulting object.\n - `instance_id` (`string`): The globally unique identifier of the Firebase Realtime Database instance.\nInstance IDs cannot be reused after deletion.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): A reference to the region where the Firebase Realtime database resides.\nCheck all [available regions](https://firebase.google.com/docs/projects/locations#rtdb-locations)\n - `type` (`string`): The database type.\nEach project can create one default Firebase Realtime Database, which cannot be deleted once created.\nCreating user Databases is only available for projects on the Blaze plan.\nProjects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value: "USER_DATABASE" Possible values: ["DEFAULT_DATABASE", "USER_DATABASE"] When `null`, the `type` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_database_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 `google_firebase_database_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( instance_id, region, diff --git a/4.x/_gen/resources/gke_hub_membership.libsonnet b/4.x/_gen/resources/gke_hub_membership.libsonnet index e9e245c0..703053b5 100644 --- a/4.x/_gen/resources/gke_hub_membership.libsonnet +++ b/4.x/_gen/resources/gke_hub_membership.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_gke_hub_membership', url='', help='`google_gke_hub_membership` represents the `google-beta_google_gke_hub_membership` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), authority:: { - '#new':: d.fn(help='\n`google-beta.google_gke_hub_membership.authority.new` constructs a new object with attributes and blocks configured for the `authority`\nTerraform sub block.\n\n\n\n**Args**:\n - `issuer` (`string`): A JSON Web Token (JWT) issuer URI. 'issuer' must start with 'https://' and // be a valid \nwith length <2000 characters. For example: 'https://container.googleapis.com/v1/projects/my-project/locations/us-west1/clusters/my-cluster' (must be 'locations' rather than 'zones'). If the cluster is provisioned with Terraform, this is '"https://container.googleapis.com/v1/${google_container_cluster.my-cluster.id}"'.\n\n**Returns**:\n - An attribute object that represents the `authority` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_gke_hub_membership.authority.new` constructs a new object with attributes and blocks configured for the `authority`\nTerraform sub block.\n\n\n\n**Args**:\n - `issuer` (`string`): A JSON Web Token (JWT) issuer URI. 'issuer' must start with 'https://' and // be a valid\nwith length <2000 characters. For example: 'https://container.googleapis.com/v1/projects/my-project/locations/us-west1/clusters/my-cluster' (must be 'locations' rather than 'zones'). If the cluster is provisioned with Terraform, this is '"https://container.googleapis.com/v1/${google_container_cluster.my-cluster.id}"'.\n\n**Returns**:\n - An attribute object that represents the `authority` sub block.\n', args=[]), new( issuer ):: std.prune(a={ diff --git a/4.x/_gen/resources/gkeonprem_vmware_cluster.libsonnet b/4.x/_gen/resources/gkeonprem_vmware_cluster.libsonnet new file mode 100644 index 00000000..4fbf9b79 --- /dev/null +++ b/4.x/_gen/resources/gkeonprem_vmware_cluster.libsonnet @@ -0,0 +1,618 @@ +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='google_gkeonprem_vmware_cluster', url='', help='`google_gkeonprem_vmware_cluster` represents the `google-beta_google_gkeonprem_vmware_cluster` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + anti_affinity_groups:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.anti_affinity_groups.new` constructs a new object with attributes and blocks configured for the `anti_affinity_groups`\nTerraform sub block.\n\n\n\n**Args**:\n - `aag_config_disabled` (`bool`): Spread nodes across at least three physical hosts (requires at least three\nhosts).\nEnabled by default.\n\n**Returns**:\n - An attribute object that represents the `anti_affinity_groups` sub block.\n', args=[]), + new( + aag_config_disabled + ):: std.prune(a={ + aag_config_disabled: aag_config_disabled, + }), + }, + authorization:: { + admin_users:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.authorization.admin_users.new` constructs a new object with attributes and blocks configured for the `admin_users`\nTerraform sub block.\n\n\n\n**Args**:\n - `username` (`string`): The name of the user, e.g. 'my-gcp-id@gmail.com'.\n\n**Returns**:\n - An attribute object that represents the `admin_users` sub block.\n', args=[]), + new( + username + ):: std.prune(a={ + username: username, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.authorization.new` constructs a new object with attributes and blocks configured for the `authorization`\nTerraform sub block.\n\n\n\n**Args**:\n - `admin_users` (`list[obj]`): Users that will be granted the cluster-admin role on the cluster, providing\nfull access to the cluster. When `null`, the `admin_users` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.authorization.admin_users.new](#fn-authorizationadmin_usersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `authorization` sub block.\n', args=[]), + new( + admin_users=null + ):: std.prune(a={ + admin_users: admin_users, + }), + }, + auto_repair_config:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.auto_repair_config.new` constructs a new object with attributes and blocks configured for the `auto_repair_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether auto repair is enabled.\n\n**Returns**:\n - An attribute object that represents the `auto_repair_config` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, + control_plane_node:: { + auto_resize_config:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.control_plane_node.auto_resize_config.new` constructs a new object with attributes and blocks configured for the `auto_resize_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Whether to enable control plane node auto resizing.\n\n**Returns**:\n - An attribute object that represents the `auto_resize_config` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.control_plane_node.new` constructs a new object with attributes and blocks configured for the `control_plane_node`\nTerraform sub block.\n\n\n\n**Args**:\n - `cpus` (`number`): The number of CPUs for each admin cluster node that serve as control planes\nfor this VMware User Cluster. (default: 4 CPUs) When `null`, the `cpus` field will be omitted from the resulting object.\n - `memory` (`number`): The megabytes of memory for each admin cluster node that serves as a\ncontrol plane for this VMware User Cluster (default: 8192 MB memory). When `null`, the `memory` field will be omitted from the resulting object.\n - `replicas` (`number`): The number of control plane nodes for this VMware User Cluster.\n(default: 1 replica). When `null`, the `replicas` field will be omitted from the resulting object.\n - `auto_resize_config` (`list[obj]`): AutoResizeConfig provides auto resizing configurations. When `null`, the `auto_resize_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-beta.google_gkeonprem_vmware_cluster.control_plane_node.auto_resize_config.new](#fn-control_plane_nodeauto_resize_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `control_plane_node` sub block.\n', args=[]), + new( + auto_resize_config=null, + cpus=null, + memory=null, + replicas=null + ):: std.prune(a={ + auto_resize_config: auto_resize_config, + cpus: cpus, + memory: memory, + replicas: replicas, + }), + }, + dataplane_v2:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.dataplane_v2.new` constructs a new object with attributes and blocks configured for the `dataplane_v2`\nTerraform sub block.\n\n\n\n**Args**:\n - `advanced_networking` (`bool`): Enable advanced networking which requires dataplane_v2_enabled to be set true. When `null`, the `advanced_networking` field will be omitted from the resulting object.\n - `dataplane_v2_enabled` (`bool`): Enables Dataplane V2. When `null`, the `dataplane_v2_enabled` field will be omitted from the resulting object.\n - `windows_dataplane_v2_enabled` (`bool`): Enable Dataplane V2 for clusters with Windows nodes. When `null`, the `windows_dataplane_v2_enabled` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `dataplane_v2` sub block.\n', args=[]), + new( + advanced_networking=null, + dataplane_v2_enabled=null, + windows_dataplane_v2_enabled=null + ):: std.prune(a={ + advanced_networking: advanced_networking, + dataplane_v2_enabled: dataplane_v2_enabled, + windows_dataplane_v2_enabled: windows_dataplane_v2_enabled, + }), + }, + load_balancer:: { + f5_config:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.load_balancer.f5_config.new` constructs a new object with attributes and blocks configured for the `f5_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `address` (`string`): The load balancer's IP address. When `null`, the `address` field will be omitted from the resulting object.\n - `partition` (`string`): he preexisting partition to be used by the load balancer. T\nhis partition is usually created for the admin cluster for example:\n'my-f5-admin-partition'. When `null`, the `partition` field will be omitted from the resulting object.\n - `snat_pool` (`string`): The pool name. Only necessary, if using SNAT. When `null`, the `snat_pool` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `f5_config` sub block.\n', args=[]), + new( + address=null, + partition=null, + snat_pool=null + ):: std.prune(a={ + address: address, + partition: partition, + snat_pool: snat_pool, + }), + }, + manual_lb_config:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.load_balancer.manual_lb_config.new` constructs a new object with attributes and blocks configured for the `manual_lb_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `control_plane_node_port` (`number`): NodePort for control plane service. The Kubernetes API server in the admin\ncluster is implemented as a Service of type NodePort (ex. 30968). When `null`, the `control_plane_node_port` field will be omitted from the resulting object.\n - `ingress_http_node_port` (`number`): NodePort for ingress service's http. The ingress service in the admin\ncluster is implemented as a Service of type NodePort (ex. 32527). When `null`, the `ingress_http_node_port` field will be omitted from the resulting object.\n - `ingress_https_node_port` (`number`): NodePort for ingress service's https. The ingress service in the admin\ncluster is implemented as a Service of type NodePort (ex. 30139). When `null`, the `ingress_https_node_port` field will be omitted from the resulting object.\n - `konnectivity_server_node_port` (`number`): NodePort for konnectivity server service running as a sidecar in each\nkube-apiserver pod (ex. 30564). When `null`, the `konnectivity_server_node_port` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `manual_lb_config` sub block.\n', args=[]), + new( + control_plane_node_port=null, + ingress_http_node_port=null, + ingress_https_node_port=null, + konnectivity_server_node_port=null + ):: std.prune(a={ + control_plane_node_port: control_plane_node_port, + ingress_http_node_port: ingress_http_node_port, + ingress_https_node_port: ingress_https_node_port, + konnectivity_server_node_port: konnectivity_server_node_port, + }), + }, + metal_lb_config:: { + address_pools:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.load_balancer.metal_lb_config.address_pools.new` constructs a new object with attributes and blocks configured for the `address_pools`\nTerraform sub block.\n\n\n\n**Args**:\n - `addresses` (`list`): The addresses that are part of this pool. Each address\nmust be either in the CIDR form (1.2.3.0/24) or range\nform (1.2.3.1-1.2.3.5).\n - `avoid_buggy_ips` (`bool`): If true, avoid using IPs ending in .0 or .255.\nThis avoids buggy consumer devices mistakenly dropping IPv4 traffic for\nthose special IP addresses. When `null`, the `avoid_buggy_ips` field will be omitted from the resulting object.\n - `manual_assign` (`bool`): If true, prevent IP addresses from being automatically assigned. When `null`, the `manual_assign` field will be omitted from the resulting object.\n - `pool` (`string`): The name of the address pool.\n\n**Returns**:\n - An attribute object that represents the `address_pools` sub block.\n', args=[]), + new( + addresses, + pool, + avoid_buggy_ips=null, + manual_assign=null + ):: std.prune(a={ + addresses: addresses, + avoid_buggy_ips: avoid_buggy_ips, + manual_assign: manual_assign, + pool: pool, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.load_balancer.metal_lb_config.new` constructs a new object with attributes and blocks configured for the `metal_lb_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `address_pools` (`list[obj]`): AddressPools is a list of non-overlapping IP pools used by load balancer\ntyped services. All addresses must be routable to load balancer nodes.\nIngressVIP must be included in the pools. When `null`, the `address_pools` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.load_balancer.metal_lb_config.address_pools.new](#fn-load_balancerload_balanceraddress_poolsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `metal_lb_config` sub block.\n', args=[]), + new( + address_pools=null + ):: std.prune(a={ + address_pools: address_pools, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.load_balancer.new` constructs a new object with attributes and blocks configured for the `load_balancer`\nTerraform sub block.\n\n\n\n**Args**:\n - `f5_config` (`list[obj]`): Configuration for F5 Big IP typed load balancers. When `null`, the `f5_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-beta.google_gkeonprem_vmware_cluster.load_balancer.f5_config.new](#fn-load_balancerf5_confignew) constructor.\n - `manual_lb_config` (`list[obj]`): Manually configured load balancers. When `null`, the `manual_lb_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-beta.google_gkeonprem_vmware_cluster.load_balancer.manual_lb_config.new](#fn-load_balancermanual_lb_confignew) constructor.\n - `metal_lb_config` (`list[obj]`): Configuration for MetalLB typed load balancers. When `null`, the `metal_lb_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-beta.google_gkeonprem_vmware_cluster.load_balancer.metal_lb_config.new](#fn-load_balancermetal_lb_confignew) constructor.\n - `vip_config` (`list[obj]`): The VIPs used by the load balancer. When `null`, the `vip_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-beta.google_gkeonprem_vmware_cluster.load_balancer.vip_config.new](#fn-load_balancervip_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `load_balancer` sub block.\n', args=[]), + new( + f5_config=null, + manual_lb_config=null, + metal_lb_config=null, + vip_config=null + ):: std.prune(a={ + f5_config: f5_config, + manual_lb_config: manual_lb_config, + metal_lb_config: metal_lb_config, + vip_config: vip_config, + }), + vip_config:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.load_balancer.vip_config.new` constructs a new object with attributes and blocks configured for the `vip_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `control_plane_vip` (`string`): The VIP which you previously set aside for the Kubernetes API of this cluster. When `null`, the `control_plane_vip` field will be omitted from the resulting object.\n - `ingress_vip` (`string`): The VIP which you previously set aside for ingress traffic into this cluster. When `null`, the `ingress_vip` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `vip_config` sub block.\n', args=[]), + new( + control_plane_vip=null, + ingress_vip=null + ):: std.prune(a={ + control_plane_vip: control_plane_vip, + ingress_vip: ingress_vip, + }), + }, + }, + network_config:: { + control_plane_v2_config:: { + control_plane_ip_block:: { + ips:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.control_plane_ip_block.ips.new` constructs a new object with attributes and blocks configured for the `ips`\nTerraform sub block.\n\n\n\n**Args**:\n - `hostname` (`string`): Hostname of the machine. VM's name will be used if this field is empty. When `null`, the `hostname` field will be omitted from the resulting object.\n - `ip` (`string`): IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24). When `null`, the `ip` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ips` sub block.\n', args=[]), + new( + hostname=null, + ip=null + ):: std.prune(a={ + hostname: hostname, + ip: ip, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.control_plane_ip_block.new` constructs a new object with attributes and blocks configured for the `control_plane_ip_block`\nTerraform sub block.\n\n\n\n**Args**:\n - `gateway` (`string`): The network gateway used by the VMware User Cluster. When `null`, the `gateway` field will be omitted from the resulting object.\n - `netmask` (`string`): The netmask used by the VMware User Cluster. When `null`, the `netmask` field will be omitted from the resulting object.\n - `ips` (`list[obj]`): The node's network configurations used by the VMware User Cluster. When `null`, the `ips` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.control_plane_ip_block.ips.new](#fn-network_confignetwork_configcontrol_plane_v2_configipsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `control_plane_ip_block` sub block.\n', args=[]), + new( + gateway=null, + ips=null, + netmask=null + ):: std.prune(a={ + gateway: gateway, + ips: ips, + netmask: netmask, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.new` constructs a new object with attributes and blocks configured for the `control_plane_v2_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `control_plane_ip_block` (`list[obj]`): Static IP addresses for the control plane nodes. When `null`, the `control_plane_ip_block` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.control_plane_ip_block.new](#fn-network_confignetwork_configcontrol_plane_ip_blocknew) constructor.\n\n**Returns**:\n - An attribute object that represents the `control_plane_v2_config` sub block.\n', args=[]), + new( + control_plane_ip_block=null + ):: std.prune(a={ + control_plane_ip_block: control_plane_ip_block, + }), + }, + dhcp_ip_config:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.network_config.dhcp_ip_config.new` constructs a new object with attributes and blocks configured for the `dhcp_ip_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): enabled is a flag to mark if DHCP IP allocation is\nused for VMware user clusters.\n\n**Returns**:\n - An attribute object that represents the `dhcp_ip_config` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, + host_config:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.network_config.host_config.new` constructs a new object with attributes and blocks configured for the `host_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `dns_search_domains` (`list`): DNS search domains. When `null`, the `dns_search_domains` field will be omitted from the resulting object.\n - `dns_servers` (`list`): DNS servers. When `null`, the `dns_servers` field will be omitted from the resulting object.\n - `ntp_servers` (`list`): NTP servers. When `null`, the `ntp_servers` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `host_config` sub block.\n', args=[]), + new( + dns_search_domains=null, + dns_servers=null, + ntp_servers=null + ):: std.prune(a={ + dns_search_domains: dns_search_domains, + dns_servers: dns_servers, + ntp_servers: ntp_servers, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_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 - `pod_address_cidr_blocks` (`list`): All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges.\nOnly a single range is supported. This field cannot be changed after creation.\n - `service_address_cidr_blocks` (`list`): All services in the cluster are assigned an RFC1918 IPv4 address\nfrom these ranges. Only a single range is supported.. This field\ncannot be changed after creation.\n - `control_plane_v2_config` (`list[obj]`): Configuration for control plane V2 mode. When `null`, the `control_plane_v2_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-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.new](#fn-network_configcontrol_plane_v2_confignew) constructor.\n - `dhcp_ip_config` (`list[obj]`): Configuration settings for a DHCP IP configuration. When `null`, the `dhcp_ip_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-beta.google_gkeonprem_vmware_cluster.network_config.dhcp_ip_config.new](#fn-network_configdhcp_ip_confignew) constructor.\n - `host_config` (`list[obj]`): Represents common network settings irrespective of the host's IP address. When `null`, the `host_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-beta.google_gkeonprem_vmware_cluster.network_config.host_config.new](#fn-network_confighost_confignew) constructor.\n - `static_ip_config` (`list[obj]`): Configuration settings for a static IP configuration. When `null`, the `static_ip_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-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.new](#fn-network_configstatic_ip_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `network_config` sub block.\n', args=[]), + new( + pod_address_cidr_blocks, + service_address_cidr_blocks, + control_plane_v2_config=null, + dhcp_ip_config=null, + host_config=null, + static_ip_config=null + ):: std.prune(a={ + control_plane_v2_config: control_plane_v2_config, + dhcp_ip_config: dhcp_ip_config, + host_config: host_config, + pod_address_cidr_blocks: pod_address_cidr_blocks, + service_address_cidr_blocks: service_address_cidr_blocks, + static_ip_config: static_ip_config, + }), + static_ip_config:: { + ip_blocks:: { + ips:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.ip_blocks.ips.new` constructs a new object with attributes and blocks configured for the `ips`\nTerraform sub block.\n\n\n\n**Args**:\n - `hostname` (`string`): Hostname of the machine. VM's name will be used if this field is empty.\n - `ip` (`string`): IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).\n\n**Returns**:\n - An attribute object that represents the `ips` sub block.\n', args=[]), + new( + hostname, + ip + ):: std.prune(a={ + hostname: hostname, + ip: ip, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.ip_blocks.new` constructs a new object with attributes and blocks configured for the `ip_blocks`\nTerraform sub block.\n\n\n\n**Args**:\n - `gateway` (`string`): The network gateway used by the VMware User Cluster.\n - `netmask` (`string`): The netmask used by the VMware User Cluster.\n - `ips` (`list[obj]`): The node's network configurations used by the VMware User Cluster. When `null`, the `ips` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.ip_blocks.ips.new](#fn-network_confignetwork_configstatic_ip_configipsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ip_blocks` sub block.\n', args=[]), + new( + gateway, + netmask, + ips=null + ):: std.prune(a={ + gateway: gateway, + ips: ips, + netmask: netmask, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.new` constructs a new object with attributes and blocks configured for the `static_ip_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `ip_blocks` (`list[obj]`): Represents the configuration values for static IP allocation to nodes. When `null`, the `ip_blocks` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.ip_blocks.new](#fn-network_confignetwork_configip_blocksnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `static_ip_config` sub block.\n', args=[]), + new( + ip_blocks=null + ):: std.prune(a={ + ip_blocks: ip_blocks, + }), + }, + }, + '#new':: d.fn(help="\n`google-beta.google_gkeonprem_vmware_cluster.new` injects a new `google-beta_google_gkeonprem_vmware_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-beta.google_gkeonprem_vmware_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_gkeonprem_vmware_cluster` using the reference:\n\n $._ref.google-beta_google_gkeonprem_vmware_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_gkeonprem_vmware_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 - `admin_cluster_membership` (`string`): The admin cluster this VMware User Cluster belongs to.\nThis is the full resource name of the admin cluster\u0026#39;s hub membership.\nIn the future, references to other resource types might be allowed if\nadmin clusters are modeled as their own resources.\n - `annotations` (`obj`): Annotations on the VMware User Cluster.\nThis field has the same restrictions as Kubernetes annotations.\nThe total size of all keys and values combined is limited to 256k.\nKey can have 2 segments: prefix (optional) and name (required),\nseparated by a slash (/).\nPrefix must be a DNS subdomain.\nName must be 63 characters or less, begin and end with alphanumerics,\nwith dashes (-), underscores (_), dots (.), and alphanumerics between. When `null`, the `annotations` field will be omitted from the resulting object.\n - `description` (`string`): A human readable description of this VMware User Cluster. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_control_plane_v2` (`bool`): Enable control plane V2. Default to false. When `null`, the `enable_control_plane_v2` field will be omitted from the resulting object.\n - `location` (`string`): The location of the resource.\n - `name` (`string`): The VMware cluster name.\n - `on_prem_version` (`string`): The Anthos clusters on the VMware version for your user cluster.\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 - `vm_tracking_enabled` (`bool`): Enable VM tracking. When `null`, the `vm_tracking_enabled` field will be omitted from the resulting object.\n - `anti_affinity_groups` (`list[obj]`): AAGConfig specifies whether to spread VMware User Cluster nodes across at\nleast three physical hosts in the datacenter. When `null`, the `anti_affinity_groups` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.anti_affinity_groups.new](#fn-anti_affinity_groupsnew) constructor.\n - `authorization` (`list[obj]`): RBAC policy that will be applied and managed by GKE On-Prem. When `null`, the `authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.authorization.new](#fn-authorizationnew) constructor.\n - `auto_repair_config` (`list[obj]`): Configuration for auto repairing. When `null`, the `auto_repair_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-beta.google_gkeonprem_vmware_cluster.auto_repair_config.new](#fn-auto_repair_confignew) constructor.\n - `control_plane_node` (`list[obj]`): VMware User Cluster control plane nodes must have either 1 or 3 replicas. When `null`, the `control_plane_node` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.control_plane_node.new](#fn-control_plane_nodenew) constructor.\n - `dataplane_v2` (`list[obj]`): VmwareDataplaneV2Config specifies configuration for Dataplane V2. When `null`, the `dataplane_v2` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.dataplane_v2.new](#fn-dataplane_v2new) constructor.\n - `load_balancer` (`list[obj]`): Load Balancer configuration. When `null`, the `load_balancer` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.load_balancer.new](#fn-load_balancernew) constructor.\n - `network_config` (`list[obj]`): The VMware User Cluster 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-beta.google_gkeonprem_vmware_cluster.network_config.new](#fn-network_confignew) constructor.\n - `storage` (`list[obj]`): Storage configuration. When `null`, the `storage` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.storage.new](#fn-storagenew) 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-beta.google_gkeonprem_vmware_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, + admin_cluster_membership, + location, + name, + on_prem_version, + annotations=null, + anti_affinity_groups=null, + authorization=null, + auto_repair_config=null, + control_plane_node=null, + dataplane_v2=null, + description=null, + enable_control_plane_v2=null, + load_balancer=null, + network_config=null, + project=null, + storage=null, + timeouts=null, + vm_tracking_enabled=null, + _meta={} + ):: tf.withResource( + type='google_gkeonprem_vmware_cluster', + label=resourceLabel, + attrs=self.newAttrs( + admin_cluster_membership=admin_cluster_membership, + annotations=annotations, + anti_affinity_groups=anti_affinity_groups, + authorization=authorization, + auto_repair_config=auto_repair_config, + control_plane_node=control_plane_node, + dataplane_v2=dataplane_v2, + description=description, + enable_control_plane_v2=enable_control_plane_v2, + load_balancer=load_balancer, + location=location, + name=name, + network_config=network_config, + on_prem_version=on_prem_version, + project=project, + storage=storage, + timeouts=timeouts, + vm_tracking_enabled=vm_tracking_enabled + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `google_gkeonprem_vmware_cluster`\nTerraform resource.\n\nUnlike [google-beta.google_gkeonprem_vmware_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 - `admin_cluster_membership` (`string`): The admin cluster this VMware User Cluster belongs to.\nThis is the full resource name of the admin cluster's hub membership.\nIn the future, references to other resource types might be allowed if\nadmin clusters are modeled as their own resources.\n - `annotations` (`obj`): Annotations on the VMware User Cluster.\nThis field has the same restrictions as Kubernetes annotations.\nThe total size of all keys and values combined is limited to 256k.\nKey can have 2 segments: prefix (optional) and name (required),\nseparated by a slash (/).\nPrefix must be a DNS subdomain.\nName must be 63 characters or less, begin and end with alphanumerics,\nwith dashes (-), underscores (_), dots (.), and alphanumerics between. When `null`, the `annotations` field will be omitted from the resulting object.\n - `description` (`string`): A human readable description of this VMware User Cluster. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_control_plane_v2` (`bool`): Enable control plane V2. Default to false. When `null`, the `enable_control_plane_v2` field will be omitted from the resulting object.\n - `location` (`string`): The location of the resource.\n - `name` (`string`): The VMware cluster name.\n - `on_prem_version` (`string`): The Anthos clusters on the VMware version for your user cluster.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `vm_tracking_enabled` (`bool`): Enable VM tracking. When `null`, the `vm_tracking_enabled` field will be omitted from the resulting object.\n - `anti_affinity_groups` (`list[obj]`): AAGConfig specifies whether to spread VMware User Cluster nodes across at\nleast three physical hosts in the datacenter. When `null`, the `anti_affinity_groups` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.anti_affinity_groups.new](#fn-anti_affinity_groupsnew) constructor.\n - `authorization` (`list[obj]`): RBAC policy that will be applied and managed by GKE On-Prem. When `null`, the `authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.authorization.new](#fn-authorizationnew) constructor.\n - `auto_repair_config` (`list[obj]`): Configuration for auto repairing. When `null`, the `auto_repair_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-beta.google_gkeonprem_vmware_cluster.auto_repair_config.new](#fn-auto_repair_confignew) constructor.\n - `control_plane_node` (`list[obj]`): VMware User Cluster control plane nodes must have either 1 or 3 replicas. When `null`, the `control_plane_node` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.control_plane_node.new](#fn-control_plane_nodenew) constructor.\n - `dataplane_v2` (`list[obj]`): VmwareDataplaneV2Config specifies configuration for Dataplane V2. When `null`, the `dataplane_v2` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.dataplane_v2.new](#fn-dataplane_v2new) constructor.\n - `load_balancer` (`list[obj]`): Load Balancer configuration. When `null`, the `load_balancer` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.load_balancer.new](#fn-load_balancernew) constructor.\n - `network_config` (`list[obj]`): The VMware User Cluster 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-beta.google_gkeonprem_vmware_cluster.network_config.new](#fn-network_confignew) constructor.\n - `storage` (`list[obj]`): Storage configuration. When `null`, the `storage` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.storage.new](#fn-storagenew) 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-beta.google_gkeonprem_vmware_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 `google_gkeonprem_vmware_cluster` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + admin_cluster_membership, + location, + name, + on_prem_version, + annotations=null, + anti_affinity_groups=null, + authorization=null, + auto_repair_config=null, + control_plane_node=null, + dataplane_v2=null, + description=null, + enable_control_plane_v2=null, + load_balancer=null, + network_config=null, + project=null, + storage=null, + timeouts=null, + vm_tracking_enabled=null + ):: std.prune(a={ + admin_cluster_membership: admin_cluster_membership, + annotations: annotations, + anti_affinity_groups: anti_affinity_groups, + authorization: authorization, + auto_repair_config: auto_repair_config, + control_plane_node: control_plane_node, + dataplane_v2: dataplane_v2, + description: description, + enable_control_plane_v2: enable_control_plane_v2, + load_balancer: load_balancer, + location: location, + name: name, + network_config: network_config, + on_prem_version: on_prem_version, + project: project, + storage: storage, + timeouts: timeouts, + vm_tracking_enabled: vm_tracking_enabled, + }), + storage:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.storage.new` constructs a new object with attributes and blocks configured for the `storage`\nTerraform sub block.\n\n\n\n**Args**:\n - `vsphere_csi_disabled` (`bool`): Whether or not to deploy vSphere CSI components in the VMware User Cluster.\nEnabled by default.\n\n**Returns**:\n - An attribute object that represents the `storage` sub block.\n', args=[]), + new( + vsphere_csi_disabled + ):: std.prune(a={ + vsphere_csi_disabled: vsphere_csi_disabled, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_cluster.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, + }), + }, + '#withAdminClusterMembership':: d.fn(help='`google-beta.string.withAdminClusterMembership` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the admin_cluster_membership 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 `admin_cluster_membership` field.\n', args=[]), + withAdminClusterMembership(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + admin_cluster_membership: value, + }, + }, + }, + }, + '#withAnnotations':: d.fn(help='`google-beta.obj.withAnnotations` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the annotations 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 `annotations` field.\n', args=[]), + withAnnotations(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + annotations: value, + }, + }, + }, + }, + '#withAntiAffinityGroups':: d.fn(help='`google-beta.list[obj].withAntiAffinityGroups` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the anti_affinity_groups 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-beta.list[obj].withAntiAffinityGroupsMixin](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 `anti_affinity_groups` field.\n', args=[]), + withAntiAffinityGroups(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + anti_affinity_groups: value, + }, + }, + }, + }, + '#withAntiAffinityGroupsMixin':: d.fn(help='`google-beta.list[obj].withAntiAffinityGroupsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the anti_affinity_groups 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-beta.list[obj].withAntiAffinityGroups](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 `anti_affinity_groups` field.\n', args=[]), + withAntiAffinityGroupsMixin(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + anti_affinity_groups+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withAuthorization':: d.fn(help='`google-beta.list[obj].withAuthorization` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the authorization 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-beta.list[obj].withAuthorizationMixin](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 `authorization` field.\n', args=[]), + withAuthorization(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + authorization: value, + }, + }, + }, + }, + '#withAuthorizationMixin':: d.fn(help='`google-beta.list[obj].withAuthorizationMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the authorization 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-beta.list[obj].withAuthorization](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 `authorization` field.\n', args=[]), + withAuthorizationMixin(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + authorization+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withAutoRepairConfig':: d.fn(help='`google-beta.list[obj].withAutoRepairConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the auto_repair_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-beta.list[obj].withAutoRepairConfigMixin](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 `auto_repair_config` field.\n', args=[]), + withAutoRepairConfig(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + auto_repair_config: value, + }, + }, + }, + }, + '#withAutoRepairConfigMixin':: d.fn(help='`google-beta.list[obj].withAutoRepairConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the auto_repair_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-beta.list[obj].withAutoRepairConfig](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 `auto_repair_config` field.\n', args=[]), + withAutoRepairConfigMixin(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + auto_repair_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withControlPlaneNode':: d.fn(help='`google-beta.list[obj].withControlPlaneNode` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the control_plane_node 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-beta.list[obj].withControlPlaneNodeMixin](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 `control_plane_node` field.\n', args=[]), + withControlPlaneNode(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + control_plane_node: value, + }, + }, + }, + }, + '#withControlPlaneNodeMixin':: d.fn(help='`google-beta.list[obj].withControlPlaneNodeMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the control_plane_node 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-beta.list[obj].withControlPlaneNode](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 `control_plane_node` field.\n', args=[]), + withControlPlaneNodeMixin(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + control_plane_node+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withDataplaneV2':: d.fn(help='`google-beta.list[obj].withDataplaneV2` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the dataplane_v2 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-beta.list[obj].withDataplaneV2Mixin](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 `dataplane_v2` field.\n', args=[]), + withDataplaneV2(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + dataplane_v2: value, + }, + }, + }, + }, + '#withDataplaneV2Mixin':: d.fn(help='`google-beta.list[obj].withDataplaneV2Mixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the dataplane_v2 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-beta.list[obj].withDataplaneV2](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 `dataplane_v2` field.\n', args=[]), + withDataplaneV2Mixin(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + dataplane_v2+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withDescription':: d.fn(help='`google-beta.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_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withEnableControlPlaneV2':: d.fn(help='`google-beta.bool.withEnableControlPlaneV2` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the enable_control_plane_v2 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 `enable_control_plane_v2` field.\n', args=[]), + withEnableControlPlaneV2(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + enable_control_plane_v2: value, + }, + }, + }, + }, + '#withLoadBalancer':: d.fn(help='`google-beta.list[obj].withLoadBalancer` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the load_balancer 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-beta.list[obj].withLoadBalancerMixin](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 `load_balancer` field.\n', args=[]), + withLoadBalancer(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + load_balancer: value, + }, + }, + }, + }, + '#withLoadBalancerMixin':: d.fn(help='`google-beta.list[obj].withLoadBalancerMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the load_balancer 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-beta.list[obj].withLoadBalancer](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 `load_balancer` field.\n', args=[]), + withLoadBalancerMixin(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + load_balancer+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google-beta.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_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google-beta.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_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withNetworkConfig':: d.fn(help='`google-beta.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-beta.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_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + network_config: value, + }, + }, + }, + }, + '#withNetworkConfigMixin':: d.fn(help='`google-beta.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-beta.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_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + network_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withOnPremVersion':: d.fn(help='`google-beta.string.withOnPremVersion` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the on_prem_version 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 `on_prem_version` field.\n', args=[]), + withOnPremVersion(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + on_prem_version: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withStorage':: d.fn(help='`google-beta.list[obj].withStorage` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the storage 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-beta.list[obj].withStorageMixin](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 `storage` field.\n', args=[]), + withStorage(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + storage: value, + }, + }, + }, + }, + '#withStorageMixin':: d.fn(help='`google-beta.list[obj].withStorageMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the storage 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-beta.list[obj].withStorage](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 `storage` field.\n', args=[]), + withStorageMixin(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + storage+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.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-beta.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_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.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-beta.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_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withVmTrackingEnabled':: d.fn(help='`google-beta.bool.withVmTrackingEnabled` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the vm_tracking_enabled field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `vm_tracking_enabled` field.\n', args=[]), + withVmTrackingEnabled(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_cluster+: { + [resourceLabel]+: { + vm_tracking_enabled: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/gkeonprem_vmware_node_pool.libsonnet b/4.x/_gen/resources/gkeonprem_vmware_node_pool.libsonnet new file mode 100644 index 00000000..afc18207 --- /dev/null +++ b/4.x/_gen/resources/gkeonprem_vmware_node_pool.libsonnet @@ -0,0 +1,234 @@ +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='google_gkeonprem_vmware_node_pool', url='', help='`google_gkeonprem_vmware_node_pool` represents the `google-beta_google_gkeonprem_vmware_node_pool` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + config:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_node_pool.config.new` constructs a new object with attributes and blocks configured for the `config`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_size_gb` (`number`): VMware disk size to be used during creation. When `null`, the `boot_disk_size_gb` field will be omitted from the resulting object.\n - `cpus` (`number`): The number of CPUs for each node in the node pool. When `null`, the `cpus` field will be omitted from the resulting object.\n - `enable_load_balancer` (`bool`): Allow node pool traffic to be load balanced. Only works for clusters with\nMetalLB load balancers. When `null`, the `enable_load_balancer` field will be omitted from the resulting object.\n - `image` (`string`): The OS image name in vCenter, only valid when using Windows. When `null`, the `image` field will be omitted from the resulting object.\n - `image_type` (`string`): The OS image to be used for each node in a node pool.\nCurrently 'cos', 'ubuntu', 'ubuntu_containerd' and 'windows' are supported.\n - `labels` (`obj`): The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided. When `null`, the `labels` field will be omitted from the resulting object.\n - `memory_mb` (`number`): The megabytes of memory for each node in the node pool. When `null`, the `memory_mb` field will be omitted from the resulting object.\n - `replicas` (`number`): The number of nodes in the node pool. When `null`, the `replicas` field will be omitted from the resulting object.\n - `taints` (`list[obj]`): The initial taints assigned to nodes of this node pool. When `null`, the `taints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_node_pool.config.taints.new](#fn-configtaintsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `config` sub block.\n', args=[]), + new( + image_type, + boot_disk_size_gb=null, + cpus=null, + enable_load_balancer=null, + image=null, + labels=null, + memory_mb=null, + replicas=null, + taints=null + ):: std.prune(a={ + boot_disk_size_gb: boot_disk_size_gb, + cpus: cpus, + enable_load_balancer: enable_load_balancer, + image: image, + image_type: image_type, + labels: labels, + memory_mb: memory_mb, + replicas: replicas, + taints: taints, + }), + taints:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_node_pool.config.taints.new` constructs a new object with attributes and blocks configured for the `taints`\nTerraform sub block.\n\n\n\n**Args**:\n - `effect` (`string`): Available taint effects. Possible values: ["EFFECT_UNSPECIFIED", "NO_SCHEDULE", "PREFER_NO_SCHEDULE", "NO_EXECUTE"] When `null`, the `effect` field will be omitted from the resulting object.\n - `key` (`string`): Key associated with the effect.\n - `value` (`string`): Value associated with the effect.\n\n**Returns**:\n - An attribute object that represents the `taints` sub block.\n', args=[]), + new( + key, + value, + effect=null + ):: std.prune(a={ + effect: effect, + key: key, + value: value, + }), + }, + }, + '#new':: d.fn(help="\n`google-beta.google_gkeonprem_vmware_node_pool.new` injects a new `google-beta_google_gkeonprem_vmware_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-beta.google_gkeonprem_vmware_node_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_gkeonprem_vmware_node_pool` using the reference:\n\n $._ref.google-beta_google_gkeonprem_vmware_node_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_gkeonprem_vmware_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`): Annotations on the node Pool.\nThis field has the same restrictions as Kubernetes annotations.\nThe total size of all keys and values combined is limited to 256k.\nKey can have 2 segments: prefix (optional) and name (required),\nseparated by a slash (/).\nPrefix must be a DNS subdomain.\nName must be 63 characters or less, begin and end with alphanumerics,\nwith dashes (-), underscores (_), dots (.), and alphanumerics between. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the node pool. When `null`, the `display_name` field will be omitted from the resulting object.\n - `location` (`string`): The location of the resource.\n - `name` (`string`): The vmware node pool name.\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 - `vmware_cluster` (`string`): The cluster this node pool belongs to.\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-beta.google_gkeonprem_vmware_node_pool.config.new](#fn-confignew) constructor.\n - `node_pool_autoscaling` (`list[obj]`): Node Pool autoscaling config for the node pool. When `null`, the `node_pool_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-beta.google_gkeonprem_vmware_node_pool.node_pool_autoscaling.new](#fn-node_pool_autoscalingnew) 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-beta.google_gkeonprem_vmware_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, + location, + name, + vmware_cluster, + annotations=null, + config=null, + display_name=null, + node_pool_autoscaling=null, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_gkeonprem_vmware_node_pool', + label=resourceLabel, + attrs=self.newAttrs( + annotations=annotations, + config=config, + display_name=display_name, + location=location, + name=name, + node_pool_autoscaling=node_pool_autoscaling, + project=project, + timeouts=timeouts, + vmware_cluster=vmware_cluster + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_node_pool.newAttrs` constructs a new object with attributes and blocks configured for the `google_gkeonprem_vmware_node_pool`\nTerraform resource.\n\nUnlike [google-beta.google_gkeonprem_vmware_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`): Annotations on the node Pool.\nThis field has the same restrictions as Kubernetes annotations.\nThe total size of all keys and values combined is limited to 256k.\nKey can have 2 segments: prefix (optional) and name (required),\nseparated by a slash (/).\nPrefix must be a DNS subdomain.\nName must be 63 characters or less, begin and end with alphanumerics,\nwith dashes (-), underscores (_), dots (.), and alphanumerics between. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the node pool. When `null`, the `display_name` field will be omitted from the resulting object.\n - `location` (`string`): The location of the resource.\n - `name` (`string`): The vmware node pool name.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `vmware_cluster` (`string`): The cluster this node pool belongs to.\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-beta.google_gkeonprem_vmware_node_pool.config.new](#fn-confignew) constructor.\n - `node_pool_autoscaling` (`list[obj]`): Node Pool autoscaling config for the node pool. When `null`, the `node_pool_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-beta.google_gkeonprem_vmware_node_pool.node_pool_autoscaling.new](#fn-node_pool_autoscalingnew) 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-beta.google_gkeonprem_vmware_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 `google_gkeonprem_vmware_node_pool` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + location, + name, + vmware_cluster, + annotations=null, + config=null, + display_name=null, + node_pool_autoscaling=null, + project=null, + timeouts=null + ):: std.prune(a={ + annotations: annotations, + config: config, + display_name: display_name, + location: location, + name: name, + node_pool_autoscaling: node_pool_autoscaling, + project: project, + timeouts: timeouts, + vmware_cluster: vmware_cluster, + }), + node_pool_autoscaling:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_node_pool.node_pool_autoscaling.new` constructs a new object with attributes and blocks configured for the `node_pool_autoscaling`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_replicas` (`number`): Maximum number of replicas in the NodePool.\n - `min_replicas` (`number`): Minimum number of replicas in the NodePool.\n\n**Returns**:\n - An attribute object that represents the `node_pool_autoscaling` sub block.\n', args=[]), + new( + max_replicas, + min_replicas + ):: std.prune(a={ + max_replicas: max_replicas, + min_replicas: min_replicas, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_gkeonprem_vmware_node_pool.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, + }), + }, + '#withAnnotations':: d.fn(help='`google-beta.obj.withAnnotations` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the annotations 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 `annotations` field.\n', args=[]), + withAnnotations(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + annotations: value, + }, + }, + }, + }, + '#withConfig':: d.fn(help='`google-beta.list[obj].withConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the 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-beta.list[obj].withConfigMixin](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 `config` field.\n', args=[]), + withConfig(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + config: value, + }, + }, + }, + }, + '#withConfigMixin':: d.fn(help='`google-beta.list[obj].withConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the 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-beta.list[obj].withConfig](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 `config` field.\n', args=[]), + withConfigMixin(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withDisplayName':: d.fn(help='`google-beta.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_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + display_name: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google-beta.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_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google-beta.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_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withNodePoolAutoscaling':: d.fn(help='`google-beta.list[obj].withNodePoolAutoscaling` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the node_pool_autoscaling 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-beta.list[obj].withNodePoolAutoscalingMixin](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_autoscaling` field.\n', args=[]), + withNodePoolAutoscaling(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + node_pool_autoscaling: value, + }, + }, + }, + }, + '#withNodePoolAutoscalingMixin':: d.fn(help='`google-beta.list[obj].withNodePoolAutoscalingMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the node_pool_autoscaling 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-beta.list[obj].withNodePoolAutoscaling](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_autoscaling` field.\n', args=[]), + withNodePoolAutoscalingMixin(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + node_pool_autoscaling+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.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-beta.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_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.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-beta.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_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withVmwareCluster':: d.fn(help='`google-beta.string.withVmwareCluster` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the vmware_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 `vmware_cluster` field.\n', args=[]), + withVmwareCluster(resourceLabel, value): { + resource+: { + google_gkeonprem_vmware_node_pool+: { + [resourceLabel]+: { + vmware_cluster: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/healthcare_fhir_store.libsonnet b/4.x/_gen/resources/healthcare_fhir_store.libsonnet index ad296679..6ab056ab 100644 --- a/4.x/_gen/resources/healthcare_fhir_store.libsonnet +++ b/4.x/_gen/resources/healthcare_fhir_store.libsonnet @@ -74,7 +74,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, notification_configs:: { - '#new':: d.fn(help='\n`google-beta.google_healthcare_fhir_store.notification_configs.new` constructs a new object with attributes and blocks configured for the `notification_configs`\nTerraform sub block.\n\n\n\n**Args**:\n - `pubsub_topic` (`string`): The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client.\nPubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message.\nIt is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message\nwas published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a\nproject. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given\nCloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.\n - `send_full_resource` (`bool`): Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation.\nNote that setting this to true does not guarantee that all resources will be sent in the format of \nfull FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be\nsent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether \nit needs to fetch the full resource as a separate operation. When `null`, the `send_full_resource` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `notification_configs` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_healthcare_fhir_store.notification_configs.new` constructs a new object with attributes and blocks configured for the `notification_configs`\nTerraform sub block.\n\n\n\n**Args**:\n - `pubsub_topic` (`string`): The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client.\nPubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message.\nIt is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message\nwas published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a\nproject. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given\nCloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.\n - `send_full_resource` (`bool`): Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation.\nNote that setting this to true does not guarantee that all resources will be sent in the format of\nfull FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be\nsent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether\nit needs to fetch the full resource as a separate operation. When `null`, the `send_full_resource` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `notification_configs` sub block.\n', args=[]), new( pubsub_topic, send_full_resource=null diff --git a/4.x/_gen/resources/iam_workforce_pool.libsonnet b/4.x/_gen/resources/iam_workforce_pool.libsonnet index e5ea91ac..0e81b7d3 100644 --- a/4.x/_gen/resources/iam_workforce_pool.libsonnet +++ b/4.x/_gen/resources/iam_workforce_pool.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='google_iam_workforce_pool', url='', help='`google_iam_workforce_pool` represents the `google-beta_google_iam_workforce_pool` 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-beta.google_iam_workforce_pool.new` injects a new `google-beta_google_iam_workforce_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-beta.google_iam_workforce_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_iam_workforce_pool` using the reference:\n\n $._ref.google-beta_google_iam_workforce_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_iam_workforce_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 - `description` (`string`): A user-specified description of the pool. Cannot exceed 256 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `disabled` (`bool`): Whether the pool is disabled. You cannot use a disabled pool to exchange tokens,\nor use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. When `null`, the `disabled` field will be omitted from the resulting object.\n - `display_name` (`string`): A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. When `null`, the `display_name` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource.\n - `parent` (`string`): Immutable. The resource name of the parent. Format: \u0026#39;organizations/{org-id}\u0026#39;.\n - `session_duration` (`string`): Duration that the Google Cloud access tokens, console sign-in sessions,\nand \u0026#39;gcloud\u0026#39; sign-in sessions from this pool are valid. \nMust be greater than 15 minutes (900s) and less than 12 hours (43200s).\nIf \u0026#39;sessionDuration\u0026#39; is not configured, minted credentials have a default duration of one hour (3600s).\nA duration in seconds with up to nine fractional digits, ending with \u0026#39;\u0026#39;s\u0026#39;\u0026#39;. Example: \u0026#34;\u0026#39;3.5s\u0026#39;\u0026#34;. When `null`, the `session_duration` field will be omitted from the resulting object.\n - `workforce_pool_id` (`string`): The name of the pool. The ID must be a globally unique string of 6 to 63 lowercase letters,\ndigits, or hyphens. It must start with a letter, and cannot have a trailing hyphen.\nThe prefix \u0026#39;gcp-\u0026#39; is reserved for use by Google, and may not be specified.\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-beta.google_iam_workforce_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-beta.google_iam_workforce_pool.new` injects a new `google-beta_google_iam_workforce_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-beta.google_iam_workforce_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_iam_workforce_pool` using the reference:\n\n $._ref.google-beta_google_iam_workforce_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_iam_workforce_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 - `description` (`string`): A user-specified description of the pool. Cannot exceed 256 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `disabled` (`bool`): Whether the pool is disabled. You cannot use a disabled pool to exchange tokens,\nor use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. When `null`, the `disabled` field will be omitted from the resulting object.\n - `display_name` (`string`): A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. When `null`, the `display_name` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource.\n - `parent` (`string`): Immutable. The resource name of the parent. Format: \u0026#39;organizations/{org-id}\u0026#39;.\n - `session_duration` (`string`): Duration that the Google Cloud access tokens, console sign-in sessions,\nand \u0026#39;gcloud\u0026#39; sign-in sessions from this pool are valid.\nMust be greater than 15 minutes (900s) and less than 12 hours (43200s).\nIf \u0026#39;sessionDuration\u0026#39; is not configured, minted credentials have a default duration of one hour (3600s).\nA duration in seconds with up to nine fractional digits, ending with \u0026#39;\u0026#39;s\u0026#39;\u0026#39;. Example: \u0026#34;\u0026#39;3.5s\u0026#39;\u0026#34;. When `null`, the `session_duration` field will be omitted from the resulting object.\n - `workforce_pool_id` (`string`): The name of the pool. The ID must be a globally unique string of 6 to 63 lowercase letters,\ndigits, or hyphens. It must start with a letter, and cannot have a trailing hyphen.\nThe prefix \u0026#39;gcp-\u0026#39; is reserved for use by Google, and may not be specified.\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-beta.google_iam_workforce_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, location, @@ -29,7 +29,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_iam_workforce_pool.newAttrs` constructs a new object with attributes and blocks configured for the `google_iam_workforce_pool`\nTerraform resource.\n\nUnlike [google-beta.google_iam_workforce_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 - `description` (`string`): A user-specified description of the pool. Cannot exceed 256 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `disabled` (`bool`): Whether the pool is disabled. You cannot use a disabled pool to exchange tokens,\nor use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. When `null`, the `disabled` field will be omitted from the resulting object.\n - `display_name` (`string`): A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. When `null`, the `display_name` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource.\n - `parent` (`string`): Immutable. The resource name of the parent. Format: 'organizations/{org-id}'.\n - `session_duration` (`string`): Duration that the Google Cloud access tokens, console sign-in sessions,\nand 'gcloud' sign-in sessions from this pool are valid. \nMust be greater than 15 minutes (900s) and less than 12 hours (43200s).\nIf 'sessionDuration' is not configured, minted credentials have a default duration of one hour (3600s).\nA duration in seconds with up to nine fractional digits, ending with ''s''. Example: "'3.5s'". When `null`, the `session_duration` field will be omitted from the resulting object.\n - `workforce_pool_id` (`string`): The name of the pool. The ID must be a globally unique string of 6 to 63 lowercase letters,\ndigits, or hyphens. It must start with a letter, and cannot have a trailing hyphen.\nThe prefix 'gcp-' is reserved for use by Google, and may not be specified.\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-beta.google_iam_workforce_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 `google_iam_workforce_pool` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_iam_workforce_pool.newAttrs` constructs a new object with attributes and blocks configured for the `google_iam_workforce_pool`\nTerraform resource.\n\nUnlike [google-beta.google_iam_workforce_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 - `description` (`string`): A user-specified description of the pool. Cannot exceed 256 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `disabled` (`bool`): Whether the pool is disabled. You cannot use a disabled pool to exchange tokens,\nor use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. When `null`, the `disabled` field will be omitted from the resulting object.\n - `display_name` (`string`): A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. When `null`, the `display_name` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource.\n - `parent` (`string`): Immutable. The resource name of the parent. Format: 'organizations/{org-id}'.\n - `session_duration` (`string`): Duration that the Google Cloud access tokens, console sign-in sessions,\nand 'gcloud' sign-in sessions from this pool are valid.\nMust be greater than 15 minutes (900s) and less than 12 hours (43200s).\nIf 'sessionDuration' is not configured, minted credentials have a default duration of one hour (3600s).\nA duration in seconds with up to nine fractional digits, ending with ''s''. Example: "'3.5s'". When `null`, the `session_duration` field will be omitted from the resulting object.\n - `workforce_pool_id` (`string`): The name of the pool. The ID must be a globally unique string of 6 to 63 lowercase letters,\ndigits, or hyphens. It must start with a letter, and cannot have a trailing hyphen.\nThe prefix 'gcp-' is reserved for use by Google, and may not be specified.\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-beta.google_iam_workforce_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 `google_iam_workforce_pool` resource into the root Terraform configuration.\n', args=[]), newAttrs( location, parent, diff --git a/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet b/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet index 63a33a29..1407388b 100644 --- a/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet +++ b/4.x/_gen/resources/iam_workforce_pool_provider.libsonnet @@ -84,7 +84,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, saml:: { - '#new':: d.fn(help='\n`google-beta.google_iam_workforce_pool_provider.saml.new` constructs a new object with attributes and blocks configured for the `saml`\nTerraform sub block.\n\n\n\n**Args**:\n - `idp_metadata_xml` (`string`): SAML Identity provider configuration metadata xml doc.\nThe xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf).\nThe max size of the acceptable xml document will be bounded to 128k characters.\n\nThe metadata xml document should satisfy the following constraints:\n1) Must contain an Identity Provider Entity ID.\n2) Must contain at least one non-expired signing key certificate.\n3) For each signing key: \n a) Valid from should be no more than 7 days from now. \n b) Valid to should be no more than 10 years in the future. \n4) Up to 3 IdP signing keys are allowed in the metadata xml.\n\nWhen updating the provider's metadata xml, at least one non-expired signing key\nmust overlap with the existing metadata. This requirement is skipped if there are\nno non-expired signing keys present in the existing metadata.\n\n**Returns**:\n - An attribute object that represents the `saml` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_iam_workforce_pool_provider.saml.new` constructs a new object with attributes and blocks configured for the `saml`\nTerraform sub block.\n\n\n\n**Args**:\n - `idp_metadata_xml` (`string`): SAML Identity provider configuration metadata xml doc.\nThe xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf).\nThe max size of the acceptable xml document will be bounded to 128k characters.\n\nThe metadata xml document should satisfy the following constraints:\n1) Must contain an Identity Provider Entity ID.\n2) Must contain at least one non-expired signing key certificate.\n3) For each signing key:\n a) Valid from should be no more than 7 days from now.\n b) Valid to should be no more than 10 years in the future.\n4) Up to 3 IdP signing keys are allowed in the metadata xml.\n\nWhen updating the provider's metadata xml, at least one non-expired signing key\nmust overlap with the existing metadata. This requirement is skipped if there are\nno non-expired signing keys present in the existing metadata.\n\n**Returns**:\n - An attribute object that represents the `saml` sub block.\n', args=[]), new( idp_metadata_xml ):: std.prune(a={ diff --git a/4.x/_gen/resources/identity_platform_project_default_config.libsonnet b/4.x/_gen/resources/identity_platform_project_default_config.libsonnet index 1fd318e8..1e387d02 100644 --- a/4.x/_gen/resources/identity_platform_project_default_config.libsonnet +++ b/4.x/_gen/resources/identity_platform_project_default_config.libsonnet @@ -35,7 +35,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, email:: { - '#new':: d.fn(help='\n`google-beta.google_identity_platform_project_default_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. When `null`, the `enabled` field will be omitted from the resulting object.\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':: d.fn(help='\n`google-beta.google_identity_platform_project_default_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. When `null`, the `enabled` field will be omitted from the resulting object.\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=null, password_required=null diff --git a/4.x/_gen/resources/kms_crypto_key.libsonnet b/4.x/_gen/resources/kms_crypto_key.libsonnet index d66b7130..3a9f5882 100644 --- a/4.x/_gen/resources/kms_crypto_key.libsonnet +++ b/4.x/_gen/resources/kms_crypto_key.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_kms_crypto_key', url='', help='`google_kms_crypto_key` represents the `google-beta_google_kms_crypto_key` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google-beta.google_kms_crypto_key.new` injects a new `google-beta_google_kms_crypto_key` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_kms_crypto_key.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_kms_crypto_key` using the reference:\n\n $._ref.google-beta_google_kms_crypto_key.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_kms_crypto_key.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `destroy_scheduled_duration` (`string`): The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED.\nIf not specified at creation time, the default duration is 24 hours. When `null`, the `destroy_scheduled_duration` field will be omitted from the resulting object.\n - `import_only` (`bool`): Whether this key may contain imported versions only. When `null`, the `import_only` field will be omitted from the resulting object.\n - `key_ring` (`string`): The KeyRing that this key belongs to.\nFormat: \u0026#39;\u0026#39;projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}\u0026#39;\u0026#39;.\n - `labels` (`obj`): Labels with user-defined metadata to apply to this resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The resource name for the CryptoKey.\n - `purpose` (`string`): The immutable purpose of this CryptoKey. See the\n[purpose reference](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose)\nfor possible inputs. Default value: \u0026#34;ENCRYPT_DECRYPT\u0026#34; Possible values: [\u0026#34;ENCRYPT_DECRYPT\u0026#34;, \u0026#34;ASYMMETRIC_SIGN\u0026#34;, \u0026#34;ASYMMETRIC_DECRYPT\u0026#34;, \u0026#34;MAC\u0026#34;] When `null`, the `purpose` field will be omitted from the resulting object.\n - `rotation_period` (`string`): Every time this period passes, generate a new CryptoKeyVersion and set it as the primary.\nThe first rotation will take place after the specified period. The rotation period has\nthe format of a decimal number with up to 9 fractional digits, followed by the\nletter \u0026#39;s\u0026#39; (seconds). It must be greater than a day (ie, 86400). When `null`, the `rotation_period` field will be omitted from the resulting object.\n - `skip_initial_version_creation` (`bool`): If set to true, the request will create a CryptoKey without any CryptoKeyVersions. \nYou must use the \u0026#39;google_kms_key_ring_import_job\u0026#39; resource to import the CryptoKeyVersion. When `null`, the `skip_initial_version_creation` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.timeouts.new](#fn-timeoutsnew) constructor.\n - `version_template` (`list[obj]`): A template describing settings for new crypto key versions. When `null`, the `version_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.version_template.new](#fn-version_templatenew) 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-beta.google_kms_crypto_key.new` injects a new `google-beta_google_kms_crypto_key` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_kms_crypto_key.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_kms_crypto_key` using the reference:\n\n $._ref.google-beta_google_kms_crypto_key.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_kms_crypto_key.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `destroy_scheduled_duration` (`string`): The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED.\nIf not specified at creation time, the default duration is 24 hours. When `null`, the `destroy_scheduled_duration` field will be omitted from the resulting object.\n - `import_only` (`bool`): Whether this key may contain imported versions only. When `null`, the `import_only` field will be omitted from the resulting object.\n - `key_ring` (`string`): The KeyRing that this key belongs to.\nFormat: \u0026#39;\u0026#39;projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}\u0026#39;\u0026#39;.\n - `labels` (`obj`): Labels with user-defined metadata to apply to this resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The resource name for the CryptoKey.\n - `purpose` (`string`): The immutable purpose of this CryptoKey. See the\n[purpose reference](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose)\nfor possible inputs. Default value: \u0026#34;ENCRYPT_DECRYPT\u0026#34; Possible values: [\u0026#34;ENCRYPT_DECRYPT\u0026#34;, \u0026#34;ASYMMETRIC_SIGN\u0026#34;, \u0026#34;ASYMMETRIC_DECRYPT\u0026#34;, \u0026#34;MAC\u0026#34;] When `null`, the `purpose` field will be omitted from the resulting object.\n - `rotation_period` (`string`): Every time this period passes, generate a new CryptoKeyVersion and set it as the primary.\nThe first rotation will take place after the specified period. The rotation period has\nthe format of a decimal number with up to 9 fractional digits, followed by the\nletter \u0026#39;s\u0026#39; (seconds). It must be greater than a day (ie, 86400). When `null`, the `rotation_period` field will be omitted from the resulting object.\n - `skip_initial_version_creation` (`bool`): If set to true, the request will create a CryptoKey without any CryptoKeyVersions.\nYou must use the \u0026#39;google_kms_key_ring_import_job\u0026#39; resource to import the CryptoKeyVersion. When `null`, the `skip_initial_version_creation` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.timeouts.new](#fn-timeoutsnew) constructor.\n - `version_template` (`list[obj]`): A template describing settings for new crypto key versions. When `null`, the `version_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.version_template.new](#fn-version_templatenew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, key_ring, @@ -33,7 +33,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_kms_crypto_key.newAttrs` constructs a new object with attributes and blocks configured for the `google_kms_crypto_key`\nTerraform resource.\n\nUnlike [google-beta.google_kms_crypto_key.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `destroy_scheduled_duration` (`string`): The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED.\nIf not specified at creation time, the default duration is 24 hours. When `null`, the `destroy_scheduled_duration` field will be omitted from the resulting object.\n - `import_only` (`bool`): Whether this key may contain imported versions only. When `null`, the `import_only` field will be omitted from the resulting object.\n - `key_ring` (`string`): The KeyRing that this key belongs to.\nFormat: ''projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}''.\n - `labels` (`obj`): Labels with user-defined metadata to apply to this resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The resource name for the CryptoKey.\n - `purpose` (`string`): The immutable purpose of this CryptoKey. See the\n[purpose reference](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose)\nfor possible inputs. Default value: "ENCRYPT_DECRYPT" Possible values: ["ENCRYPT_DECRYPT", "ASYMMETRIC_SIGN", "ASYMMETRIC_DECRYPT", "MAC"] When `null`, the `purpose` field will be omitted from the resulting object.\n - `rotation_period` (`string`): Every time this period passes, generate a new CryptoKeyVersion and set it as the primary.\nThe first rotation will take place after the specified period. The rotation period has\nthe format of a decimal number with up to 9 fractional digits, followed by the\nletter 's' (seconds). It must be greater than a day (ie, 86400). When `null`, the `rotation_period` field will be omitted from the resulting object.\n - `skip_initial_version_creation` (`bool`): If set to true, the request will create a CryptoKey without any CryptoKeyVersions. \nYou must use the 'google_kms_key_ring_import_job' resource to import the CryptoKeyVersion. When `null`, the `skip_initial_version_creation` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.timeouts.new](#fn-timeoutsnew) constructor.\n - `version_template` (`list[obj]`): A template describing settings for new crypto key versions. When `null`, the `version_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.version_template.new](#fn-version_templatenew) 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 `google_kms_crypto_key` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_kms_crypto_key.newAttrs` constructs a new object with attributes and blocks configured for the `google_kms_crypto_key`\nTerraform resource.\n\nUnlike [google-beta.google_kms_crypto_key.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `destroy_scheduled_duration` (`string`): The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED.\nIf not specified at creation time, the default duration is 24 hours. When `null`, the `destroy_scheduled_duration` field will be omitted from the resulting object.\n - `import_only` (`bool`): Whether this key may contain imported versions only. When `null`, the `import_only` field will be omitted from the resulting object.\n - `key_ring` (`string`): The KeyRing that this key belongs to.\nFormat: ''projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}''.\n - `labels` (`obj`): Labels with user-defined metadata to apply to this resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): The resource name for the CryptoKey.\n - `purpose` (`string`): The immutable purpose of this CryptoKey. See the\n[purpose reference](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose)\nfor possible inputs. Default value: "ENCRYPT_DECRYPT" Possible values: ["ENCRYPT_DECRYPT", "ASYMMETRIC_SIGN", "ASYMMETRIC_DECRYPT", "MAC"] When `null`, the `purpose` field will be omitted from the resulting object.\n - `rotation_period` (`string`): Every time this period passes, generate a new CryptoKeyVersion and set it as the primary.\nThe first rotation will take place after the specified period. The rotation period has\nthe format of a decimal number with up to 9 fractional digits, followed by the\nletter 's' (seconds). It must be greater than a day (ie, 86400). When `null`, the `rotation_period` field will be omitted from the resulting object.\n - `skip_initial_version_creation` (`bool`): If set to true, the request will create a CryptoKey without any CryptoKeyVersions.\nYou must use the 'google_kms_key_ring_import_job' resource to import the CryptoKeyVersion. When `null`, the `skip_initial_version_creation` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.timeouts.new](#fn-timeoutsnew) constructor.\n - `version_template` (`list[obj]`): A template describing settings for new crypto key versions. When `null`, the `version_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.version_template.new](#fn-version_templatenew) 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 `google_kms_crypto_key` resource into the root Terraform configuration.\n', args=[]), newAttrs( key_ring, name, diff --git a/4.x/_gen/resources/logging_metric.libsonnet b/4.x/_gen/resources/logging_metric.libsonnet index f15ec675..b43c683c 100644 --- a/4.x/_gen/resources/logging_metric.libsonnet +++ b/4.x/_gen/resources/logging_metric.libsonnet @@ -59,7 +59,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); value_type: value_type, }), }, - '#new':: d.fn(help='\n`google-beta.google_logging_metric.metric_descriptor.new` constructs a new object with attributes and blocks configured for the `metric_descriptor`\nTerraform sub block.\n\n\n\n**Args**:\n - `display_name` (`string`): A concise name for the metric, which can be displayed in user interfaces. Use sentence case \nwithout an ending period, for example "Request count". This field is optional but it is \nrecommended to be set for any metrics associated with user-visible concepts, such as Quota. When `null`, the `display_name` field will be omitted from the resulting object.\n - `metric_kind` (`string`): Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of metricKind and valueType might not be supported.\nFor counter metrics, set this to DELTA. Possible values: ["DELTA", "GAUGE", "CUMULATIVE"]\n - `unit` (`string`): The unit in which the metric value is reported. It is only applicable if the valueType is\n'INT64', 'DOUBLE', or 'DISTRIBUTION'. The supported units are a subset of\n[The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard When `null`, the `unit` field will be omitted from the resulting object.\n - `value_type` (`string`): Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of metricKind and valueType might not be supported.\nFor counter metrics, set this to INT64. Possible values: ["BOOL", "INT64", "DOUBLE", "STRING", "DISTRIBUTION", "MONEY"]\n - `labels` (`list[obj]`): The set of labels that can be used to describe a specific instance of this metric type. For\nexample, the appengine.googleapis.com/http/server/response_latencies metric type has a label\nfor the HTTP response code, response_code, so you can look at latencies for successful responses\nor just for responses that failed. When `null`, the `labels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_logging_metric.metric_descriptor.labels.new](#fn-metric_descriptorlabelsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `metric_descriptor` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_logging_metric.metric_descriptor.new` constructs a new object with attributes and blocks configured for the `metric_descriptor`\nTerraform sub block.\n\n\n\n**Args**:\n - `display_name` (`string`): A concise name for the metric, which can be displayed in user interfaces. Use sentence case\nwithout an ending period, for example "Request count". This field is optional but it is\nrecommended to be set for any metrics associated with user-visible concepts, such as Quota. When `null`, the `display_name` field will be omitted from the resulting object.\n - `metric_kind` (`string`): Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of metricKind and valueType might not be supported.\nFor counter metrics, set this to DELTA. Possible values: ["DELTA", "GAUGE", "CUMULATIVE"]\n - `unit` (`string`): The unit in which the metric value is reported. It is only applicable if the valueType is\n'INT64', 'DOUBLE', or 'DISTRIBUTION'. The supported units are a subset of\n[The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard When `null`, the `unit` field will be omitted from the resulting object.\n - `value_type` (`string`): Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of metricKind and valueType might not be supported.\nFor counter metrics, set this to INT64. Possible values: ["BOOL", "INT64", "DOUBLE", "STRING", "DISTRIBUTION", "MONEY"]\n - `labels` (`list[obj]`): The set of labels that can be used to describe a specific instance of this metric type. For\nexample, the appengine.googleapis.com/http/server/response_latencies metric type has a label\nfor the HTTP response code, response_code, so you can look at latencies for successful responses\nor just for responses that failed. When `null`, the `labels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_logging_metric.metric_descriptor.labels.new](#fn-metric_descriptorlabelsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `metric_descriptor` sub block.\n', args=[]), new( metric_kind, value_type, diff --git a/4.x/_gen/resources/monitoring_service.libsonnet b/4.x/_gen/resources/monitoring_service.libsonnet index 2792efa1..53fb1f75 100644 --- a/4.x/_gen/resources/monitoring_service.libsonnet +++ b/4.x/_gen/resources/monitoring_service.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_monitoring_service', url='', help='`google_monitoring_service` represents the `google-beta_google_monitoring_service` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), basic_service:: { - '#new':: d.fn(help='\n`google-beta.google_monitoring_service.basic_service.new` constructs a new object with attributes and blocks configured for the `basic_service`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_labels` (`obj`): Labels that specify the resource that emits the monitoring data \nwhich is used for SLO reporting of this 'Service'. When `null`, the `service_labels` field will be omitted from the resulting object.\n - `service_type` (`string`): The type of service that this basic service defines, e.g. \nAPP_ENGINE service type When `null`, the `service_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `basic_service` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_monitoring_service.basic_service.new` constructs a new object with attributes and blocks configured for the `basic_service`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_labels` (`obj`): Labels that specify the resource that emits the monitoring data\nwhich is used for SLO reporting of this 'Service'. When `null`, the `service_labels` field will be omitted from the resulting object.\n - `service_type` (`string`): The type of service that this basic service defines, e.g.\nAPP_ENGINE service type When `null`, the `service_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `basic_service` sub block.\n', args=[]), new( service_labels=null, service_type=null diff --git a/4.x/_gen/resources/network_security_address_group.libsonnet b/4.x/_gen/resources/network_security_address_group.libsonnet new file mode 100644 index 00000000..f22b93fb --- /dev/null +++ b/4.x/_gen/resources/network_security_address_group.libsonnet @@ -0,0 +1,168 @@ +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='google_network_security_address_group', url='', help='`google_network_security_address_group` represents the `google-beta_google_network_security_address_group` 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-beta.google_network_security_address_group.new` injects a new `google-beta_google_network_security_address_group` 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-beta.google_network_security_address_group.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_security_address_group` using the reference:\n\n $._ref.google-beta_google_network_security_address_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_security_address_group.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 - `capacity` (`number`): Capacity of the Address Group.\n - `description` (`string`): Free-text description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `items` (`list`): List of items. When `null`, the `items` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the AddressGroup resource.\nAn object containing a list of \u0026#34;key\u0026#34;: value pairs. Example: { \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 location of the gateway security policy.\nThe default value is \u0026#39;global\u0026#39;.\n - `name` (`string`): Name of the AddressGroup resource.\n - `parent` (`string`): The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}. When `null`, the `parent` field will be omitted from the resulting object.\n - `type` (`string`): The type of the Address Group. Possible values are \u0026#34;IPV4\u0026#34; or \u0026#34;IPV6\u0026#34;. Possible values: [\u0026#34;IPV4\u0026#34;, \u0026#34;IPV6\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-beta.google_network_security_address_group.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, + capacity, + location, + name, + type, + description=null, + items=null, + labels=null, + parent=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_network_security_address_group', + label=resourceLabel, + attrs=self.newAttrs( + capacity=capacity, + description=description, + items=items, + labels=labels, + location=location, + name=name, + parent=parent, + timeouts=timeouts, + type=type + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_network_security_address_group.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_security_address_group`\nTerraform resource.\n\nUnlike [google-beta.google_network_security_address_group.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 - `capacity` (`number`): Capacity of the Address Group.\n - `description` (`string`): Free-text description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `items` (`list`): List of items. When `null`, the `items` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the AddressGroup resource.\nAn object containing 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.\n - `location` (`string`): The location of the gateway security policy.\nThe default value is 'global'.\n - `name` (`string`): Name of the AddressGroup resource.\n - `parent` (`string`): The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}. When `null`, the `parent` field will be omitted from the resulting object.\n - `type` (`string`): The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values: ["IPV4", "IPV6"]\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-beta.google_network_security_address_group.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 `google_network_security_address_group` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + capacity, + location, + name, + type, + description=null, + items=null, + labels=null, + parent=null, + timeouts=null + ):: std.prune(a={ + capacity: capacity, + description: description, + items: items, + labels: labels, + location: location, + name: name, + parent: parent, + timeouts: timeouts, + type: type, + }), + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_network_security_address_group.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, + }), + }, + '#withCapacity':: d.fn(help='`google-beta.number.withCapacity` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the capacity 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 `capacity` field.\n', args=[]), + withCapacity(resourceLabel, value): { + resource+: { + google_network_security_address_group+: { + [resourceLabel]+: { + capacity: value, + }, + }, + }, + }, + '#withDescription':: d.fn(help='`google-beta.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_network_security_address_group+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withItems':: d.fn(help='`google-beta.list.withItems` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the items 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 `items` field.\n', args=[]), + withItems(resourceLabel, value): { + resource+: { + google_network_security_address_group+: { + [resourceLabel]+: { + items: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google-beta.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_network_security_address_group+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google-beta.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_network_security_address_group+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google-beta.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_network_security_address_group+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withParent':: d.fn(help='`google-beta.string.withParent` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the parent field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `parent` field.\n', args=[]), + withParent(resourceLabel, value): { + resource+: { + google_network_security_address_group+: { + [resourceLabel]+: { + parent: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.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-beta.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_network_security_address_group+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.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-beta.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_network_security_address_group+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withType':: d.fn(help='`google-beta.string.withType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `type` field.\n', args=[]), + withType(resourceLabel, value): { + resource+: { + google_network_security_address_group+: { + [resourceLabel]+: { + type: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/network_security_authorization_policy.libsonnet b/4.x/_gen/resources/network_security_authorization_policy.libsonnet new file mode 100644 index 00000000..d4b10385 --- /dev/null +++ b/4.x/_gen/resources/network_security_authorization_policy.libsonnet @@ -0,0 +1,208 @@ +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='google_network_security_authorization_policy', url='', help='`google_network_security_authorization_policy` represents the `google-beta_google_network_security_authorization_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-beta.google_network_security_authorization_policy.new` injects a new `google-beta_google_network_security_authorization_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-beta.google_network_security_authorization_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_security_authorization_policy` using the reference:\n\n $._ref.google-beta_google_network_security_authorization_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_security_authorization_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 - `action` (`string`): The action to take when a rule match is found. Possible values are \u0026#34;ALLOW\u0026#34; or \u0026#34;DENY\u0026#34;. Possible values: [\u0026#34;ALLOW\u0026#34;, \u0026#34;DENY\u0026#34;]\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`): Set of label tags associated with the AuthorizationPolicy resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location of the authorization policy.\nThe default value is \u0026#39;global\u0026#39;. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the AuthorizationPolicy 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 - `rules` (`list[obj]`): List of rules to match. Note that at least one of the rules must match in order for the action specified in the \u0026#39;action\u0026#39; field to be taken. \nA rule is a match if there is a matching source and destination. If left blank, the action specified in the action field will be applied on every request. When `null`, the `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-beta.google_network_security_authorization_policy.rules.new](#fn-rulesnew) 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-beta.google_network_security_authorization_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + action, + name, + description=null, + labels=null, + location=null, + project=null, + rules=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_network_security_authorization_policy', + label=resourceLabel, + attrs=self.newAttrs( + action=action, + description=description, + labels=labels, + location=location, + name=name, + project=project, + rules=rules, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_network_security_authorization_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_security_authorization_policy`\nTerraform resource.\n\nUnlike [google-beta.google_network_security_authorization_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 - `action` (`string`): The action to take when a rule match is found. Possible values are "ALLOW" or "DENY". Possible values: ["ALLOW", "DENY"]\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`): Set of label tags associated with the AuthorizationPolicy resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location of the authorization policy.\nThe default value is 'global'. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the AuthorizationPolicy 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 - `rules` (`list[obj]`): List of rules to match. Note that at least one of the rules must match in order for the action specified in the 'action' field to be taken. \nA rule is a match if there is a matching source and destination. If left blank, the action specified in the action field will be applied on every request. When `null`, the `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-beta.google_network_security_authorization_policy.rules.new](#fn-rulesnew) 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-beta.google_network_security_authorization_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_network_security_authorization_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + action, + name, + description=null, + labels=null, + location=null, + project=null, + rules=null, + timeouts=null + ):: std.prune(a={ + action: action, + description: description, + labels: labels, + location: location, + name: name, + project: project, + rules: rules, + timeouts: timeouts, + }), + rules:: { + destinations:: { + http_header_match:: { + '#new':: d.fn(help='\n`google-beta.google_network_security_authorization_policy.rules.destinations.http_header_match.new` constructs a new object with attributes and blocks configured for the `http_header_match`\nTerraform sub block.\n\n\n\n**Args**:\n - `header_name` (`string`): The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method".\n - `regex_match` (`string`): The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier.\n\n**Returns**:\n - An attribute object that represents the `http_header_match` sub block.\n', args=[]), + new( + header_name, + regex_match + ):: std.prune(a={ + header_name: header_name, + regex_match: regex_match, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_security_authorization_policy.rules.destinations.new` constructs a new object with attributes and blocks configured for the `destinations`\nTerraform sub block.\n\n\n\n**Args**:\n - `hosts` (`list`): List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example "*.myorg.com") or a presence (any) match "*".\n - `methods` (`list`): A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.\n - `ports` (`list`): List of destination ports to match. At least one port should match.\n - `http_header_match` (`list[obj]`): Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. \nAvoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. When `null`, the `http_header_match` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_authorization_policy.rules.destinations.http_header_match.new](#fn-rulesruleshttp_header_matchnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `destinations` sub block.\n', args=[]), + new( + hosts, + methods, + ports, + http_header_match=null + ):: std.prune(a={ + hosts: hosts, + http_header_match: http_header_match, + methods: methods, + ports: ports, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_security_authorization_policy.rules.new` constructs a new object with attributes and blocks configured for the `rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `destinations` (`list[obj]`): List of attributes for the traffic destination. All of the destinations must match. A destination is a match if a request matches all the specified hosts, ports, methods and headers. \nIf not set, the action specified in the 'action' field will be applied without any rule checks for the destination. When `null`, the `destinations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_authorization_policy.rules.destinations.new](#fn-rulesdestinationsnew) constructor.\n - `sources` (`list[obj]`): List of attributes for the traffic source. All of the sources must match. A source is a match if both principals and ipBlocks match. \nIf not set, the action specified in the 'action' field will be applied without any rule checks for the source. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_authorization_policy.rules.sources.new](#fn-rulessourcesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rules` sub block.\n', args=[]), + new( + destinations=null, + sources=null + ):: std.prune(a={ + destinations: destinations, + sources: sources, + }), + sources:: { + '#new':: d.fn(help='\n`google-beta.google_network_security_authorization_policy.rules.sources.new` constructs a new object with attributes and blocks configured for the `sources`\nTerraform sub block.\n\n\n\n**Args**:\n - `ip_blocks` (`list`): List of CIDR ranges to match based on source IP address. At least one IP block should match. Single IP (e.g., "1.2.3.4") and CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on source IP alone should be avoided. \nThe IP addresses of any load balancers or proxies should be considered untrusted. When `null`, the `ip_blocks` field will be omitted from the resulting object.\n - `principals` (`list`): List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, "*/service-account") or a presence match "*". \nAuthorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. When `null`, the `principals` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sources` sub block.\n', args=[]), + new( + ip_blocks=null, + principals=null + ):: std.prune(a={ + ip_blocks: ip_blocks, + principals: principals, + }), + }, + }, + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_network_security_authorization_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `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, + }), + }, + '#withAction':: d.fn(help='`google-beta.string.withAction` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the action 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 `action` field.\n', args=[]), + withAction(resourceLabel, value): { + resource+: { + google_network_security_authorization_policy+: { + [resourceLabel]+: { + action: value, + }, + }, + }, + }, + '#withDescription':: d.fn(help='`google-beta.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_network_security_authorization_policy+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google-beta.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_network_security_authorization_policy+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google-beta.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_network_security_authorization_policy+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google-beta.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_network_security_authorization_policy+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_network_security_authorization_policy+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRules':: d.fn(help='`google-beta.list[obj].withRules` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the rules 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-beta.list[obj].withRulesMixin](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 `rules` field.\n', args=[]), + withRules(resourceLabel, value): { + resource+: { + google_network_security_authorization_policy+: { + [resourceLabel]+: { + rules: value, + }, + }, + }, + }, + '#withRulesMixin':: d.fn(help='`google-beta.list[obj].withRulesMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the rules 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-beta.list[obj].withRules](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 `rules` field.\n', args=[]), + withRulesMixin(resourceLabel, value): { + resource+: { + google_network_security_authorization_policy+: { + [resourceLabel]+: { + rules+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.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-beta.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_network_security_authorization_policy+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.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-beta.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_network_security_authorization_policy+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/network_security_client_tls_policy.libsonnet b/4.x/_gen/resources/network_security_client_tls_policy.libsonnet new file mode 100644 index 00000000..1896e802 --- /dev/null +++ b/4.x/_gen/resources/network_security_client_tls_policy.libsonnet @@ -0,0 +1,240 @@ +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='google_network_security_client_tls_policy', url='', help='`google_network_security_client_tls_policy` represents the `google-beta_google_network_security_client_tls_policy` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + client_certificate:: { + certificate_provider_instance:: { + '#new':: d.fn(help='\n`google-beta.google_network_security_client_tls_policy.client_certificate.certificate_provider_instance.new` constructs a new object with attributes and blocks configured for the `certificate_provider_instance`\nTerraform sub block.\n\n\n\n**Args**:\n - `plugin_instance` (`string`): Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.\n\n**Returns**:\n - An attribute object that represents the `certificate_provider_instance` sub block.\n', args=[]), + new( + plugin_instance + ):: std.prune(a={ + plugin_instance: plugin_instance, + }), + }, + grpc_endpoint:: { + '#new':: d.fn(help='\n`google-beta.google_network_security_client_tls_policy.client_certificate.grpc_endpoint.new` constructs a new object with attributes and blocks configured for the `grpc_endpoint`\nTerraform sub block.\n\n\n\n**Args**:\n - `target_uri` (`string`): The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".\n\n**Returns**:\n - An attribute object that represents the `grpc_endpoint` sub block.\n', args=[]), + new( + target_uri + ):: std.prune(a={ + target_uri: target_uri, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_security_client_tls_policy.client_certificate.new` constructs a new object with attributes and blocks configured for the `client_certificate`\nTerraform sub block.\n\n\n\n**Args**:\n - `certificate_provider_instance` (`list[obj]`): The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. When `null`, the `certificate_provider_instance` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.client_certificate.certificate_provider_instance.new](#fn-client_certificatecertificate_provider_instancenew) constructor.\n - `grpc_endpoint` (`list[obj]`): gRPC specific configuration to access the gRPC server to obtain the cert and private key. When `null`, the `grpc_endpoint` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.client_certificate.grpc_endpoint.new](#fn-client_certificategrpc_endpointnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `client_certificate` sub block.\n', args=[]), + new( + certificate_provider_instance=null, + grpc_endpoint=null + ):: std.prune(a={ + certificate_provider_instance: certificate_provider_instance, + grpc_endpoint: grpc_endpoint, + }), + }, + '#new':: d.fn(help="\n`google-beta.google_network_security_client_tls_policy.new` injects a new `google-beta_google_network_security_client_tls_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-beta.google_network_security_client_tls_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_security_client_tls_policy` using the reference:\n\n $._ref.google-beta_google_network_security_client_tls_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_security_client_tls_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 - `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`): Set of label tags associated with the ClientTlsPolicy resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location of the client tls policy.\nThe default value is \u0026#39;global\u0026#39;. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the ClientTlsPolicy 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 - `sni` (`string`): Server Name Indication string to present to the server during TLS handshake. E.g: \u0026#34;secure.example.com\u0026#34;. When `null`, the `sni` field will be omitted from the resulting object.\n - `client_certificate` (`list[obj]`): Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. When `null`, the `client_certificate` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.client_certificate.new](#fn-client_certificatenew) constructor.\n - `server_validation_ca` (`list[obj]`): Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. When `null`, the `server_validation_ca` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.server_validation_ca.new](#fn-server_validation_canew) 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-beta.google_network_security_client_tls_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + name, + client_certificate=null, + description=null, + labels=null, + location=null, + project=null, + server_validation_ca=null, + sni=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_network_security_client_tls_policy', + label=resourceLabel, + attrs=self.newAttrs( + client_certificate=client_certificate, + description=description, + labels=labels, + location=location, + name=name, + project=project, + server_validation_ca=server_validation_ca, + sni=sni, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_network_security_client_tls_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_security_client_tls_policy`\nTerraform resource.\n\nUnlike [google-beta.google_network_security_client_tls_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 - `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`): Set of label tags associated with the ClientTlsPolicy resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location of the client tls policy.\nThe default value is 'global'. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Name of the ClientTlsPolicy 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 - `sni` (`string`): Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com". When `null`, the `sni` field will be omitted from the resulting object.\n - `client_certificate` (`list[obj]`): Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. When `null`, the `client_certificate` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.client_certificate.new](#fn-client_certificatenew) constructor.\n - `server_validation_ca` (`list[obj]`): Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. When `null`, the `server_validation_ca` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.server_validation_ca.new](#fn-server_validation_canew) 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-beta.google_network_security_client_tls_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_network_security_client_tls_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + name, + client_certificate=null, + description=null, + labels=null, + location=null, + project=null, + server_validation_ca=null, + sni=null, + timeouts=null + ):: std.prune(a={ + client_certificate: client_certificate, + description: description, + labels: labels, + location: location, + name: name, + project: project, + server_validation_ca: server_validation_ca, + sni: sni, + timeouts: timeouts, + }), + server_validation_ca:: { + certificate_provider_instance:: { + '#new':: d.fn(help='\n`google-beta.google_network_security_client_tls_policy.server_validation_ca.certificate_provider_instance.new` constructs a new object with attributes and blocks configured for the `certificate_provider_instance`\nTerraform sub block.\n\n\n\n**Args**:\n - `plugin_instance` (`string`): Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.\n\n**Returns**:\n - An attribute object that represents the `certificate_provider_instance` sub block.\n', args=[]), + new( + plugin_instance + ):: std.prune(a={ + plugin_instance: plugin_instance, + }), + }, + grpc_endpoint:: { + '#new':: d.fn(help='\n`google-beta.google_network_security_client_tls_policy.server_validation_ca.grpc_endpoint.new` constructs a new object with attributes and blocks configured for the `grpc_endpoint`\nTerraform sub block.\n\n\n\n**Args**:\n - `target_uri` (`string`): The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".\n\n**Returns**:\n - An attribute object that represents the `grpc_endpoint` sub block.\n', args=[]), + new( + target_uri + ):: std.prune(a={ + target_uri: target_uri, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_security_client_tls_policy.server_validation_ca.new` constructs a new object with attributes and blocks configured for the `server_validation_ca`\nTerraform sub block.\n\n\n\n**Args**:\n - `certificate_provider_instance` (`list[obj]`): The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. When `null`, the `certificate_provider_instance` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.server_validation_ca.certificate_provider_instance.new](#fn-server_validation_cacertificate_provider_instancenew) constructor.\n - `grpc_endpoint` (`list[obj]`): gRPC specific configuration to access the gRPC server to obtain the cert and private key. When `null`, the `grpc_endpoint` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.server_validation_ca.grpc_endpoint.new](#fn-server_validation_cagrpc_endpointnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `server_validation_ca` sub block.\n', args=[]), + new( + certificate_provider_instance=null, + grpc_endpoint=null + ):: std.prune(a={ + certificate_provider_instance: certificate_provider_instance, + grpc_endpoint: grpc_endpoint, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_network_security_client_tls_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `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, + }), + }, + '#withClientCertificate':: d.fn(help='`google-beta.list[obj].withClientCertificate` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the client_certificate 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-beta.list[obj].withClientCertificateMixin](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 `client_certificate` field.\n', args=[]), + withClientCertificate(resourceLabel, value): { + resource+: { + google_network_security_client_tls_policy+: { + [resourceLabel]+: { + client_certificate: value, + }, + }, + }, + }, + '#withClientCertificateMixin':: d.fn(help='`google-beta.list[obj].withClientCertificateMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the client_certificate 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-beta.list[obj].withClientCertificate](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 `client_certificate` field.\n', args=[]), + withClientCertificateMixin(resourceLabel, value): { + resource+: { + google_network_security_client_tls_policy+: { + [resourceLabel]+: { + client_certificate+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withDescription':: d.fn(help='`google-beta.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_network_security_client_tls_policy+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google-beta.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_network_security_client_tls_policy+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google-beta.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_network_security_client_tls_policy+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google-beta.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_network_security_client_tls_policy+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_network_security_client_tls_policy+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withServerValidationCa':: d.fn(help='`google-beta.list[obj].withServerValidationCa` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the server_validation_ca 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-beta.list[obj].withServerValidationCaMixin](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 `server_validation_ca` field.\n', args=[]), + withServerValidationCa(resourceLabel, value): { + resource+: { + google_network_security_client_tls_policy+: { + [resourceLabel]+: { + server_validation_ca: value, + }, + }, + }, + }, + '#withServerValidationCaMixin':: d.fn(help='`google-beta.list[obj].withServerValidationCaMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the server_validation_ca 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-beta.list[obj].withServerValidationCa](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 `server_validation_ca` field.\n', args=[]), + withServerValidationCaMixin(resourceLabel, value): { + resource+: { + google_network_security_client_tls_policy+: { + [resourceLabel]+: { + server_validation_ca+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withSni':: d.fn(help='`google-beta.string.withSni` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the sni 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 `sni` field.\n', args=[]), + withSni(resourceLabel, value): { + resource+: { + google_network_security_client_tls_policy+: { + [resourceLabel]+: { + sni: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.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-beta.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_network_security_client_tls_policy+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.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-beta.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_network_security_client_tls_policy+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/network_security_gateway_security_policy_rule.libsonnet b/4.x/_gen/resources/network_security_gateway_security_policy_rule.libsonnet index c697cada..3e340c10 100644 --- a/4.x/_gen/resources/network_security_gateway_security_policy_rule.libsonnet +++ b/4.x/_gen/resources/network_security_gateway_security_policy_rule.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='google_network_security_gateway_security_policy_rule', url='', help='`google_network_security_gateway_security_policy_rule` represents the `google-beta_google_network_security_gateway_security_policy_rule` 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-beta.google_network_security_gateway_security_policy_rule.new` injects a new `google-beta_google_network_security_gateway_security_policy_rule` 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-beta.google_network_security_gateway_security_policy_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_security_gateway_security_policy_rule` using the reference:\n\n $._ref.google-beta_google_network_security_gateway_security_policy_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_security_gateway_security_policy_rule.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 - `application_matcher` (`string`): CEL expression for matching on L7/application level criteria. When `null`, the `application_matcher` field will be omitted from the resulting object.\n - `basic_profile` (`string`): Profile which tells what the primitive action should be. Possible values are: * ALLOW * DENY. Possible values: [\u0026#34;BASIC_PROFILE_UNSPECIFIED\u0026#34;, \u0026#34;ALLOW\u0026#34;, \u0026#34;DENY\u0026#34;]\n - `description` (`string`): Free-text description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `enabled` (`bool`): Whether the rule is enforced.\n - `gateway_security_policy` (`string`): The name of the gatewat security policy this rule belongs to.\n - `location` (`string`): The location of the gateway security policy.\n - `name` (`string`): Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule}\nrule should match the pattern: (^a-z?$).\n - `priority` (`number`): Priority of the rule. Lower number corresponds to higher precedence.\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 - `session_matcher` (`string`): CEL expression for matching on session criteria.\n - `tls_inspection_enabled` (`bool`): Flag to enable TLS inspection of traffic matching on. Can only be true if the \nparent GatewaySecurityPolicy references a TLSInspectionConfig. When `null`, the `tls_inspection_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_gateway_security_policy_rule.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-beta.google_network_security_gateway_security_policy_rule.new` injects a new `google-beta_google_network_security_gateway_security_policy_rule` 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-beta.google_network_security_gateway_security_policy_rule.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_security_gateway_security_policy_rule` using the reference:\n\n $._ref.google-beta_google_network_security_gateway_security_policy_rule.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_security_gateway_security_policy_rule.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 - `application_matcher` (`string`): CEL expression for matching on L7/application level criteria. When `null`, the `application_matcher` field will be omitted from the resulting object.\n - `basic_profile` (`string`): Profile which tells what the primitive action should be. Possible values are: * ALLOW * DENY. Possible values: [\u0026#34;BASIC_PROFILE_UNSPECIFIED\u0026#34;, \u0026#34;ALLOW\u0026#34;, \u0026#34;DENY\u0026#34;]\n - `description` (`string`): Free-text description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `enabled` (`bool`): Whether the rule is enforced.\n - `gateway_security_policy` (`string`): The name of the gatewat security policy this rule belongs to.\n - `location` (`string`): The location of the gateway security policy.\n - `name` (`string`): Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule}\nrule should match the pattern: (^a-z?$).\n - `priority` (`number`): Priority of the rule. Lower number corresponds to higher precedence.\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 - `session_matcher` (`string`): CEL expression for matching on session criteria.\n - `tls_inspection_enabled` (`bool`): Flag to enable TLS inspection of traffic matching on. Can only be true if the\nparent GatewaySecurityPolicy references a TLSInspectionConfig. When `null`, the `tls_inspection_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_gateway_security_policy_rule.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, basic_profile, @@ -37,7 +37,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_network_security_gateway_security_policy_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_security_gateway_security_policy_rule`\nTerraform resource.\n\nUnlike [google-beta.google_network_security_gateway_security_policy_rule.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 - `application_matcher` (`string`): CEL expression for matching on L7/application level criteria. When `null`, the `application_matcher` field will be omitted from the resulting object.\n - `basic_profile` (`string`): Profile which tells what the primitive action should be. Possible values are: * ALLOW * DENY. Possible values: ["BASIC_PROFILE_UNSPECIFIED", "ALLOW", "DENY"]\n - `description` (`string`): Free-text description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `enabled` (`bool`): Whether the rule is enforced.\n - `gateway_security_policy` (`string`): The name of the gatewat security policy this rule belongs to.\n - `location` (`string`): The location of the gateway security policy.\n - `name` (`string`): Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule}\nrule should match the pattern: (^a-z?$).\n - `priority` (`number`): Priority of the rule. Lower number corresponds to higher precedence.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `session_matcher` (`string`): CEL expression for matching on session criteria.\n - `tls_inspection_enabled` (`bool`): Flag to enable TLS inspection of traffic matching on. Can only be true if the \nparent GatewaySecurityPolicy references a TLSInspectionConfig. When `null`, the `tls_inspection_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_gateway_security_policy_rule.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 `google_network_security_gateway_security_policy_rule` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_network_security_gateway_security_policy_rule.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_security_gateway_security_policy_rule`\nTerraform resource.\n\nUnlike [google-beta.google_network_security_gateway_security_policy_rule.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 - `application_matcher` (`string`): CEL expression for matching on L7/application level criteria. When `null`, the `application_matcher` field will be omitted from the resulting object.\n - `basic_profile` (`string`): Profile which tells what the primitive action should be. Possible values are: * ALLOW * DENY. Possible values: ["BASIC_PROFILE_UNSPECIFIED", "ALLOW", "DENY"]\n - `description` (`string`): Free-text description of the resource. When `null`, the `description` field will be omitted from the resulting object.\n - `enabled` (`bool`): Whether the rule is enforced.\n - `gateway_security_policy` (`string`): The name of the gatewat security policy this rule belongs to.\n - `location` (`string`): The location of the gateway security policy.\n - `name` (`string`): Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule}\nrule should match the pattern: (^a-z?$).\n - `priority` (`number`): Priority of the rule. Lower number corresponds to higher precedence.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `session_matcher` (`string`): CEL expression for matching on session criteria.\n - `tls_inspection_enabled` (`bool`): Flag to enable TLS inspection of traffic matching on. Can only be true if the\nparent GatewaySecurityPolicy references a TLSInspectionConfig. When `null`, the `tls_inspection_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_gateway_security_policy_rule.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 `google_network_security_gateway_security_policy_rule` resource into the root Terraform configuration.\n', args=[]), newAttrs( basic_profile, enabled, diff --git a/4.x/_gen/resources/network_services_endpoint_policy.libsonnet b/4.x/_gen/resources/network_services_endpoint_policy.libsonnet new file mode 100644 index 00000000..4f473e42 --- /dev/null +++ b/4.x/_gen/resources/network_services_endpoint_policy.libsonnet @@ -0,0 +1,252 @@ +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='google_network_services_endpoint_policy', url='', help='`google_network_services_endpoint_policy` represents the `google-beta_google_network_services_endpoint_policy` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + endpoint_matcher:: { + metadata_label_matcher:: { + metadata_labels:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_endpoint_policy.endpoint_matcher.metadata_label_matcher.metadata_labels.new` constructs a new object with attributes and blocks configured for the `metadata_labels`\nTerraform sub block.\n\n\n\n**Args**:\n - `label_name` (`string`): Required. Label name presented as key in xDS Node Metadata.\n - `label_value` (`string`): Required. Label value presented as value corresponding to the above key, in xDS Node Metadata.\n\n**Returns**:\n - An attribute object that represents the `metadata_labels` sub block.\n', args=[]), + new( + label_name, + label_value + ):: std.prune(a={ + label_name: label_name, + label_value: label_value, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_services_endpoint_policy.endpoint_matcher.metadata_label_matcher.new` constructs a new object with attributes and blocks configured for the `metadata_label_matcher`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata_label_match_criteria` (`string`): Specifies how matching should be done. Possible values: ["MATCH_ANY", "MATCH_ALL"]\n - `metadata_labels` (`list[obj]`): The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria When `null`, the `metadata_labels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_endpoint_policy.endpoint_matcher.metadata_label_matcher.metadata_labels.new](#fn-endpoint_matcherendpoint_matchermetadata_labelsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `metadata_label_matcher` sub block.\n', args=[]), + new( + metadata_label_match_criteria, + metadata_labels=null + ):: std.prune(a={ + metadata_label_match_criteria: metadata_label_match_criteria, + metadata_labels: metadata_labels, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_services_endpoint_policy.endpoint_matcher.new` constructs a new object with attributes and blocks configured for the `endpoint_matcher`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata_label_matcher` (`list[obj]`): The matcher is based on node metadata presented by xDS clients. When `null`, the `metadata_label_matcher` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_endpoint_policy.endpoint_matcher.metadata_label_matcher.new](#fn-endpoint_matchermetadata_label_matchernew) constructor.\n\n**Returns**:\n - An attribute object that represents the `endpoint_matcher` sub block.\n', args=[]), + new( + metadata_label_matcher=null + ):: std.prune(a={ + metadata_label_matcher: metadata_label_matcher, + }), + }, + '#new':: d.fn(help="\n`google-beta.google_network_services_endpoint_policy.new` injects a new `google-beta_google_network_services_endpoint_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-beta.google_network_services_endpoint_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_services_endpoint_policy` using the reference:\n\n $._ref.google-beta_google_network_services_endpoint_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_services_endpoint_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 - `authorization_policy` (`string`): This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. When `null`, the `authorization_policy` field will be omitted from the resulting object.\n - `client_tls_policy` (`string`): A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. When `null`, the `client_tls_policy` field will be omitted from the resulting object.\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`): Set of label tags associated with the TcpRoute resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the EndpointPolicy 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 - `server_tls_policy` (`string`): A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. When `null`, the `server_tls_policy` field will be omitted from the resulting object.\n - `type` (`string`): The type of endpoint policy. This is primarily used to validate the configuration. Possible values: [\u0026#34;SIDECAR_PROXY\u0026#34;, \u0026#34;GRPC_SERVER\u0026#34;]\n - `endpoint_matcher` (`list[obj]`): Required. A matcher that selects endpoints to which the policies should be applied. When `null`, the `endpoint_matcher` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_endpoint_policy.endpoint_matcher.new](#fn-endpoint_matchernew) 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-beta.google_network_services_endpoint_policy.timeouts.new](#fn-timeoutsnew) constructor.\n - `traffic_port_selector` (`list[obj]`): Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports. When `null`, the `traffic_port_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-beta.google_network_services_endpoint_policy.traffic_port_selector.new](#fn-traffic_port_selectornew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + name, + type, + authorization_policy=null, + client_tls_policy=null, + description=null, + endpoint_matcher=null, + labels=null, + project=null, + server_tls_policy=null, + timeouts=null, + traffic_port_selector=null, + _meta={} + ):: tf.withResource( + type='google_network_services_endpoint_policy', + label=resourceLabel, + attrs=self.newAttrs( + authorization_policy=authorization_policy, + client_tls_policy=client_tls_policy, + description=description, + endpoint_matcher=endpoint_matcher, + labels=labels, + name=name, + project=project, + server_tls_policy=server_tls_policy, + timeouts=timeouts, + traffic_port_selector=traffic_port_selector, + type=type + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_network_services_endpoint_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_endpoint_policy`\nTerraform resource.\n\nUnlike [google-beta.google_network_services_endpoint_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 - `authorization_policy` (`string`): This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. When `null`, the `authorization_policy` field will be omitted from the resulting object.\n - `client_tls_policy` (`string`): A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. When `null`, the `client_tls_policy` field will be omitted from the resulting object.\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`): Set of label tags associated with the TcpRoute resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the EndpointPolicy 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 - `server_tls_policy` (`string`): A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. When `null`, the `server_tls_policy` field will be omitted from the resulting object.\n - `type` (`string`): The type of endpoint policy. This is primarily used to validate the configuration. Possible values: ["SIDECAR_PROXY", "GRPC_SERVER"]\n - `endpoint_matcher` (`list[obj]`): Required. A matcher that selects endpoints to which the policies should be applied. When `null`, the `endpoint_matcher` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_endpoint_policy.endpoint_matcher.new](#fn-endpoint_matchernew) 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-beta.google_network_services_endpoint_policy.timeouts.new](#fn-timeoutsnew) constructor.\n - `traffic_port_selector` (`list[obj]`): Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports. When `null`, the `traffic_port_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-beta.google_network_services_endpoint_policy.traffic_port_selector.new](#fn-traffic_port_selectornew) 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 `google_network_services_endpoint_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + name, + type, + authorization_policy=null, + client_tls_policy=null, + description=null, + endpoint_matcher=null, + labels=null, + project=null, + server_tls_policy=null, + timeouts=null, + traffic_port_selector=null + ):: std.prune(a={ + authorization_policy: authorization_policy, + client_tls_policy: client_tls_policy, + description: description, + endpoint_matcher: endpoint_matcher, + labels: labels, + name: name, + project: project, + server_tls_policy: server_tls_policy, + timeouts: timeouts, + traffic_port_selector: traffic_port_selector, + type: type, + }), + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_endpoint_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `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, + }), + }, + traffic_port_selector:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_endpoint_policy.traffic_port_selector.new` constructs a new object with attributes and blocks configured for the `traffic_port_selector`\nTerraform sub block.\n\n\n\n**Args**:\n - `ports` (`list`): List of ports. Can be port numbers or port range (example, [80-90] specifies all ports from 80 to 90, including 80 and 90) or named ports or * to specify all ports. If the list is empty, all ports are selected.\n\n**Returns**:\n - An attribute object that represents the `traffic_port_selector` sub block.\n', args=[]), + new( + ports + ):: std.prune(a={ + ports: ports, + }), + }, + '#withAuthorizationPolicy':: d.fn(help='`google-beta.string.withAuthorizationPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the authorization_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 `authorization_policy` field.\n', args=[]), + withAuthorizationPolicy(resourceLabel, value): { + resource+: { + google_network_services_endpoint_policy+: { + [resourceLabel]+: { + authorization_policy: value, + }, + }, + }, + }, + '#withClientTlsPolicy':: d.fn(help='`google-beta.string.withClientTlsPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the client_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 `client_tls_policy` field.\n', args=[]), + withClientTlsPolicy(resourceLabel, value): { + resource+: { + google_network_services_endpoint_policy+: { + [resourceLabel]+: { + client_tls_policy: value, + }, + }, + }, + }, + '#withDescription':: d.fn(help='`google-beta.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_network_services_endpoint_policy+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withEndpointMatcher':: d.fn(help='`google-beta.list[obj].withEndpointMatcher` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the endpoint_matcher 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-beta.list[obj].withEndpointMatcherMixin](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 `endpoint_matcher` field.\n', args=[]), + withEndpointMatcher(resourceLabel, value): { + resource+: { + google_network_services_endpoint_policy+: { + [resourceLabel]+: { + endpoint_matcher: value, + }, + }, + }, + }, + '#withEndpointMatcherMixin':: d.fn(help='`google-beta.list[obj].withEndpointMatcherMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the endpoint_matcher 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-beta.list[obj].withEndpointMatcher](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 `endpoint_matcher` field.\n', args=[]), + withEndpointMatcherMixin(resourceLabel, value): { + resource+: { + google_network_services_endpoint_policy+: { + [resourceLabel]+: { + endpoint_matcher+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google-beta.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_network_services_endpoint_policy+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google-beta.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_network_services_endpoint_policy+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_network_services_endpoint_policy+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withServerTlsPolicy':: d.fn(help='`google-beta.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_network_services_endpoint_policy+: { + [resourceLabel]+: { + server_tls_policy: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.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-beta.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_network_services_endpoint_policy+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.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-beta.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_network_services_endpoint_policy+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withTrafficPortSelector':: d.fn(help='`google-beta.list[obj].withTrafficPortSelector` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the traffic_port_selector 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-beta.list[obj].withTrafficPortSelectorMixin](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 `traffic_port_selector` field.\n', args=[]), + withTrafficPortSelector(resourceLabel, value): { + resource+: { + google_network_services_endpoint_policy+: { + [resourceLabel]+: { + traffic_port_selector: value, + }, + }, + }, + }, + '#withTrafficPortSelectorMixin':: d.fn(help='`google-beta.list[obj].withTrafficPortSelectorMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the traffic_port_selector 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-beta.list[obj].withTrafficPortSelector](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 `traffic_port_selector` field.\n', args=[]), + withTrafficPortSelectorMixin(resourceLabel, value): { + resource+: { + google_network_services_endpoint_policy+: { + [resourceLabel]+: { + traffic_port_selector+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withType':: d.fn(help='`google-beta.string.withType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `type` field.\n', args=[]), + withType(resourceLabel, value): { + resource+: { + google_network_services_endpoint_policy+: { + [resourceLabel]+: { + type: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/network_services_gateway.libsonnet b/4.x/_gen/resources/network_services_gateway.libsonnet index 08db9d4c..3fa850b5 100644 --- a/4.x/_gen/resources/network_services_gateway.libsonnet +++ b/4.x/_gen/resources/network_services_gateway.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='google_network_services_gateway', url='', help='`google_network_services_gateway` represents the `google-beta_google_network_services_gateway` 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-beta.google_network_services_gateway.new` injects a new `google-beta_google_network_services_gateway` 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-beta.google_network_services_gateway.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_services_gateway` using the reference:\n\n $._ref.google-beta_google_network_services_gateway.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_services_gateway.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`): Set of label tags associated with the Gateway resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location of the gateway.\nThe default value is \u0026#39;global\u0026#39;. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Short name of the Gateway resource to be created.\n - `ports` (`list`): One or more port numbers (1-65535), on which the Gateway will receive traffic.\nThe proxy binds to the specified ports. Gateways of type \u0026#39;SECURE_WEB_GATEWAY\u0026#39; are \nlimited to 1 port. Gateways of type \u0026#39;OPEN_MESH\u0026#39; listen on 0.0.0.0 and support multiple ports.\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 - `scope` (`string`): Immutable. Scope determines how configuration across multiple Gateway instances are merged.\nThe configuration for multiple Gateway instances with the same scope will be merged as presented as\na single coniguration to the proxy/load balancer. \nMax length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.\n - `server_tls_policy` (`string`): A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated.\nIf empty, TLS termination is disabled. When `null`, the `server_tls_policy` field will be omitted from the resulting object.\n - `type` (`string`): Immutable. The type of the customer-managed gateway. Possible values are: * OPEN_MESH * SECURE_WEB_GATEWAY. Possible values: [\u0026#34;TYPE_UNSPECIFIED\u0026#34;, \u0026#34;OPEN_MESH\u0026#34;, \u0026#34;SECURE_WEB_GATEWAY\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-beta.google_network_services_gateway.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-beta.google_network_services_gateway.new` injects a new `google-beta_google_network_services_gateway` 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-beta.google_network_services_gateway.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_services_gateway` using the reference:\n\n $._ref.google-beta_google_network_services_gateway.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_services_gateway.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`): Set of label tags associated with the Gateway resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location of the gateway.\nThe default value is \u0026#39;global\u0026#39;. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Short name of the Gateway resource to be created.\n - `ports` (`list`): One or more port numbers (1-65535), on which the Gateway will receive traffic.\nThe proxy binds to the specified ports. Gateways of type \u0026#39;SECURE_WEB_GATEWAY\u0026#39; are\nlimited to 1 port. Gateways of type \u0026#39;OPEN_MESH\u0026#39; listen on 0.0.0.0 and support multiple ports.\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 - `scope` (`string`): Immutable. Scope determines how configuration across multiple Gateway instances are merged.\nThe configuration for multiple Gateway instances with the same scope will be merged as presented as\na single coniguration to the proxy/load balancer.\nMax length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.\n - `server_tls_policy` (`string`): A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated.\nIf empty, TLS termination is disabled. When `null`, the `server_tls_policy` field will be omitted from the resulting object.\n - `type` (`string`): Immutable. The type of the customer-managed gateway. Possible values are: * OPEN_MESH * SECURE_WEB_GATEWAY. Possible values: [\u0026#34;TYPE_UNSPECIFIED\u0026#34;, \u0026#34;OPEN_MESH\u0026#34;, \u0026#34;SECURE_WEB_GATEWAY\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-beta.google_network_services_gateway.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -33,7 +33,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_network_services_gateway.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_gateway`\nTerraform resource.\n\nUnlike [google-beta.google_network_services_gateway.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`): Set of label tags associated with the Gateway resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location of the gateway.\nThe default value is 'global'. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Short name of the Gateway resource to be created.\n - `ports` (`list`): One or more port numbers (1-65535), on which the Gateway will receive traffic.\nThe proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are \nlimited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 and support multiple ports.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `scope` (`string`): Immutable. Scope determines how configuration across multiple Gateway instances are merged.\nThe configuration for multiple Gateway instances with the same scope will be merged as presented as\na single coniguration to the proxy/load balancer. \nMax length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.\n - `server_tls_policy` (`string`): A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated.\nIf empty, TLS termination is disabled. When `null`, the `server_tls_policy` field will be omitted from the resulting object.\n - `type` (`string`): Immutable. The type of the customer-managed gateway. Possible values are: * OPEN_MESH * SECURE_WEB_GATEWAY. Possible values: ["TYPE_UNSPECIFIED", "OPEN_MESH", "SECURE_WEB_GATEWAY"]\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-beta.google_network_services_gateway.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 `google_network_services_gateway` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_network_services_gateway.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_gateway`\nTerraform resource.\n\nUnlike [google-beta.google_network_services_gateway.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`): Set of label tags associated with the Gateway resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location of the gateway.\nThe default value is 'global'. When `null`, the `location` field will be omitted from the resulting object.\n - `name` (`string`): Short name of the Gateway resource to be created.\n - `ports` (`list`): One or more port numbers (1-65535), on which the Gateway will receive traffic.\nThe proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are\nlimited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 and support multiple ports.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `scope` (`string`): Immutable. Scope determines how configuration across multiple Gateway instances are merged.\nThe configuration for multiple Gateway instances with the same scope will be merged as presented as\na single coniguration to the proxy/load balancer.\nMax length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.\n - `server_tls_policy` (`string`): A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated.\nIf empty, TLS termination is disabled. When `null`, the `server_tls_policy` field will be omitted from the resulting object.\n - `type` (`string`): Immutable. The type of the customer-managed gateway. Possible values are: * OPEN_MESH * SECURE_WEB_GATEWAY. Possible values: ["TYPE_UNSPECIFIED", "OPEN_MESH", "SECURE_WEB_GATEWAY"]\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-beta.google_network_services_gateway.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 `google_network_services_gateway` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, ports, diff --git a/4.x/_gen/resources/network_services_grpc_route.libsonnet b/4.x/_gen/resources/network_services_grpc_route.libsonnet new file mode 100644 index 00000000..6fe9e9d5 --- /dev/null +++ b/4.x/_gen/resources/network_services_grpc_route.libsonnet @@ -0,0 +1,286 @@ +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='google_network_services_grpc_route', url='', help='`google_network_services_grpc_route` represents the `google-beta_google_network_services_grpc_route` 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-beta.google_network_services_grpc_route.new` injects a new `google-beta_google_network_services_grpc_route` 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-beta.google_network_services_grpc_route.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_services_grpc_route` using the reference:\n\n $._ref.google-beta_google_network_services_grpc_route.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_services_grpc_route.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 - `gateways` (`list`): List of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. When `null`, the `gateways` field will be omitted from the resulting object.\n - `hostnames` (`list`): Required. Service hostnames with an optional port for which this route describes traffic.\n - `labels` (`obj`): Set of label tags associated with the GrpcRoute resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `meshes` (`list`): List of meshes this GrpcRoute is attached to, as one of the routing rules to route the requests served by the mesh. When `null`, the `meshes` field will be omitted from the resulting object.\n - `name` (`string`): Name of the GrpcRoute 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 - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. When `null`, the `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-beta.google_network_services_grpc_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_grpc_route.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, + hostnames, + name, + description=null, + gateways=null, + labels=null, + meshes=null, + project=null, + rules=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_network_services_grpc_route', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + gateways=gateways, + hostnames=hostnames, + labels=labels, + meshes=meshes, + name=name, + project=project, + rules=rules, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_network_services_grpc_route.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_grpc_route`\nTerraform resource.\n\nUnlike [google-beta.google_network_services_grpc_route.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 - `gateways` (`list`): List of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. When `null`, the `gateways` field will be omitted from the resulting object.\n - `hostnames` (`list`): Required. Service hostnames with an optional port for which this route describes traffic.\n - `labels` (`obj`): Set of label tags associated with the GrpcRoute resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `meshes` (`list`): List of meshes this GrpcRoute is attached to, as one of the routing rules to route the requests served by the mesh. When `null`, the `meshes` field will be omitted from the resulting object.\n - `name` (`string`): Name of the GrpcRoute 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 - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. When `null`, the `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-beta.google_network_services_grpc_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_grpc_route.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 `google_network_services_grpc_route` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + hostnames, + name, + description=null, + gateways=null, + labels=null, + meshes=null, + project=null, + rules=null, + timeouts=null + ):: std.prune(a={ + description: description, + gateways: gateways, + hostnames: hostnames, + labels: labels, + meshes: meshes, + name: name, + project: project, + rules: rules, + timeouts: timeouts, + }), + rules:: { + action:: { + destinations:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_grpc_route.rules.action.destinations.new` constructs a new object with attributes and blocks configured for the `destinations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The URL of a BackendService to route traffic to. When `null`, the `service_name` field will be omitted from the resulting object.\n - `weight` (`number`): Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. When `null`, the `weight` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `destinations` sub block.\n', args=[]), + new( + service_name=null, + weight=null + ):: std.prune(a={ + service_name: service_name, + weight: weight, + }), + }, + fault_injection_policy:: { + abort:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.abort.new` constructs a new object with attributes and blocks configured for the `abort`\nTerraform sub block.\n\n\n\n**Args**:\n - `http_status` (`number`): The HTTP status code used to abort the request. When `null`, the `http_status` field will be omitted from the resulting object.\n - `percentage` (`number`): The percentage of traffic which will be aborted. When `null`, the `percentage` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `abort` sub block.\n', args=[]), + new( + http_status=null, + percentage=null + ):: std.prune(a={ + http_status: http_status, + percentage: percentage, + }), + }, + delay:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.delay.new` constructs a new object with attributes and blocks configured for the `delay`\nTerraform sub block.\n\n\n\n**Args**:\n - `fixed_delay` (`string`): Specify a fixed delay before forwarding the request. When `null`, the `fixed_delay` field will be omitted from the resulting object.\n - `percentage` (`number`): The percentage of traffic on which delay will be injected. When `null`, the `percentage` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `delay` sub block.\n', args=[]), + new( + fixed_delay=null, + percentage=null + ):: std.prune(a={ + fixed_delay: fixed_delay, + percentage: percentage, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.new` constructs a new object with attributes and blocks configured for the `fault_injection_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `abort` (`list[obj]`): Specification of how client requests are aborted as part of fault injection before being sent to a destination. When `null`, the `abort` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.abort.new](#fn-rulesrulesactionabortnew) constructor.\n - `delay` (`list[obj]`): Specification of how client requests are delayed as part of fault injection before being sent to a destination. When `null`, the `delay` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.delay.new](#fn-rulesrulesactiondelaynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `fault_injection_policy` sub block.\n', args=[]), + new( + abort=null, + delay=null + ):: std.prune(a={ + abort: abort, + delay: delay, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_services_grpc_route.rules.action.new` constructs a new object with attributes and blocks configured for the `action`\nTerraform sub block.\n\n\n\n**Args**:\n - `timeout` (`string`): Specifies the timeout for selected route. When `null`, the `timeout` field will be omitted from the resulting object.\n - `destinations` (`list[obj]`): The destination to which traffic should be forwarded. When `null`, the `destinations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.action.destinations.new](#fn-rulesrulesdestinationsnew) constructor.\n - `fault_injection_policy` (`list[obj]`): The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. When `null`, the `fault_injection_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-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.new](#fn-rulesrulesfault_injection_policynew) constructor.\n - `retry_policy` (`list[obj]`): Specifies the retry policy associated with this route. When `null`, the `retry_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-beta.google_network_services_grpc_route.rules.action.retry_policy.new](#fn-rulesrulesretry_policynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `action` sub block.\n', args=[]), + new( + destinations=null, + fault_injection_policy=null, + retry_policy=null, + timeout=null + ):: std.prune(a={ + destinations: destinations, + fault_injection_policy: fault_injection_policy, + retry_policy: retry_policy, + timeout: timeout, + }), + retry_policy:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_grpc_route.rules.action.retry_policy.new` constructs a new object with attributes and blocks configured for the `retry_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `num_retries` (`number`): Specifies the allowed number of retries. When `null`, the `num_retries` field will be omitted from the resulting object.\n - `retry_conditions` (`list`): Specifies one or more conditions when this retry policy applies. Possible values: ["connect-failure", "refused-stream", "cancelled", "deadline-exceeded", "resource-exhausted", "unavailable"] When `null`, the `retry_conditions` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `retry_policy` sub block.\n', args=[]), + new( + num_retries=null, + retry_conditions=null + ):: std.prune(a={ + num_retries: num_retries, + retry_conditions: retry_conditions, + }), + }, + }, + matches:: { + headers:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_grpc_route.rules.matches.headers.new` constructs a new object with attributes and blocks configured for the `headers`\nTerraform sub block.\n\n\n\n**Args**:\n - `key` (`string`): Required. The key of the header.\n - `type` (`string`): The type of match. Default value: "EXACT" Possible values: ["TYPE_UNSPECIFIED", "EXACT", "REGULAR_EXPRESSION"] When `null`, the `type` field will be omitted from the resulting object.\n - `value` (`string`): Required. The value of the header.\n\n**Returns**:\n - An attribute object that represents the `headers` sub block.\n', args=[]), + new( + key, + value, + type=null + ):: std.prune(a={ + key: key, + type: type, + value: value, + }), + }, + method:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_grpc_route.rules.matches.method.new` constructs a new object with attributes and blocks configured for the `method`\nTerraform sub block.\n\n\n\n**Args**:\n - `case_sensitive` (`bool`): Specifies that matches are case sensitive. The default value is true. When `null`, the `case_sensitive` field will be omitted from the resulting object.\n - `grpc_method` (`string`): Required. Name of the method to match against.\n - `grpc_service` (`string`): Required. Name of the service to match against.\n\n**Returns**:\n - An attribute object that represents the `method` sub block.\n', args=[]), + new( + grpc_method, + grpc_service, + case_sensitive=null + ):: std.prune(a={ + case_sensitive: case_sensitive, + grpc_method: grpc_method, + grpc_service: grpc_service, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_services_grpc_route.rules.matches.new` constructs a new object with attributes and blocks configured for the `matches`\nTerraform sub block.\n\n\n\n**Args**:\n - `headers` (`list[obj]`): Specifies a list of HTTP request headers to match against. When `null`, the `headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.matches.headers.new](#fn-rulesrulesheadersnew) constructor.\n - `method` (`list[obj]`): A gRPC method to match against. If this field is empty or omitted, will match all methods. When `null`, the `method` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.matches.method.new](#fn-rulesrulesmethodnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `matches` sub block.\n', args=[]), + new( + headers=null, + method=null + ):: std.prune(a={ + headers: headers, + method: method, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_services_grpc_route.rules.new` constructs a new object with attributes and blocks configured for the `rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `action` (`list[obj]`): Required. A detailed rule defining how to route traffic. When `null`, the `action` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.action.new](#fn-rulesactionnew) constructor.\n - `matches` (`list[obj]`): Matches define conditions used for matching the rule against incoming gRPC requests. When `null`, the `matches` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.matches.new](#fn-rulesmatchesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rules` sub block.\n', args=[]), + new( + action=null, + matches=null + ):: std.prune(a={ + action: action, + matches: matches, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_grpc_route.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#withDescription':: d.fn(help='`google-beta.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_network_services_grpc_route+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withGateways':: d.fn(help='`google-beta.list.withGateways` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the gateways 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 `gateways` field.\n', args=[]), + withGateways(resourceLabel, value): { + resource+: { + google_network_services_grpc_route+: { + [resourceLabel]+: { + gateways: value, + }, + }, + }, + }, + '#withHostnames':: d.fn(help='`google-beta.list.withHostnames` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the hostnames 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 `hostnames` field.\n', args=[]), + withHostnames(resourceLabel, value): { + resource+: { + google_network_services_grpc_route+: { + [resourceLabel]+: { + hostnames: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google-beta.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_network_services_grpc_route+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withMeshes':: d.fn(help='`google-beta.list.withMeshes` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the meshes 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 `meshes` field.\n', args=[]), + withMeshes(resourceLabel, value): { + resource+: { + google_network_services_grpc_route+: { + [resourceLabel]+: { + meshes: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google-beta.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_network_services_grpc_route+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_network_services_grpc_route+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRules':: d.fn(help='`google-beta.list[obj].withRules` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the rules 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-beta.list[obj].withRulesMixin](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 `rules` field.\n', args=[]), + withRules(resourceLabel, value): { + resource+: { + google_network_services_grpc_route+: { + [resourceLabel]+: { + rules: value, + }, + }, + }, + }, + '#withRulesMixin':: d.fn(help='`google-beta.list[obj].withRulesMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the rules 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-beta.list[obj].withRules](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 `rules` field.\n', args=[]), + withRulesMixin(resourceLabel, value): { + resource+: { + google_network_services_grpc_route+: { + [resourceLabel]+: { + rules+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.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-beta.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_network_services_grpc_route+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.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-beta.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_network_services_grpc_route+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/network_services_mesh.libsonnet b/4.x/_gen/resources/network_services_mesh.libsonnet index 612ad953..621422ba 100644 --- a/4.x/_gen/resources/network_services_mesh.libsonnet +++ b/4.x/_gen/resources/network_services_mesh.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='google_network_services_mesh', url='', help='`google_network_services_mesh` represents the `google-beta_google_network_services_mesh` 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-beta.google_network_services_mesh.new` injects a new `google-beta_google_network_services_mesh` 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-beta.google_network_services_mesh.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_services_mesh` using the reference:\n\n $._ref.google-beta_google_network_services_mesh.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_services_mesh.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 - `interception_port` (`number`): Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the \nspecified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to \nbe redirected to this port regardless of its actual ip:port destination. If unset, a port \n\u0026#39;15001\u0026#39; is used as the interception port. This will is applicable only for sidecar proxy \ndeployments. When `null`, the `interception_port` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the Mesh resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Short name of the Mesh resource to be created.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_mesh.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-beta.google_network_services_mesh.new` injects a new `google-beta_google_network_services_mesh` 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-beta.google_network_services_mesh.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_services_mesh` using the reference:\n\n $._ref.google-beta_google_network_services_mesh.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_services_mesh.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 - `interception_port` (`number`): Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the\nspecified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to\nbe redirected to this port regardless of its actual ip:port destination. If unset, a port\n\u0026#39;15001\u0026#39; is used as the interception port. This will is applicable only for sidecar proxy\ndeployments. When `null`, the `interception_port` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the Mesh resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Short name of the Mesh resource to be created.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_mesh.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, @@ -25,7 +25,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_network_services_mesh.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_mesh`\nTerraform resource.\n\nUnlike [google-beta.google_network_services_mesh.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 - `interception_port` (`number`): Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the \nspecified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to \nbe redirected to this port regardless of its actual ip:port destination. If unset, a port \n'15001' is used as the interception port. This will is applicable only for sidecar proxy \ndeployments. When `null`, the `interception_port` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the Mesh resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Short name of the Mesh resource to be created.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_mesh.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 `google_network_services_mesh` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_network_services_mesh.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_mesh`\nTerraform resource.\n\nUnlike [google-beta.google_network_services_mesh.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 - `interception_port` (`number`): Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the\nspecified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to\nbe redirected to this port regardless of its actual ip:port destination. If unset, a port\n'15001' is used as the interception port. This will is applicable only for sidecar proxy\ndeployments. When `null`, the `interception_port` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the Mesh resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Short name of the Mesh resource to be created.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_mesh.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 `google_network_services_mesh` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, description=null, diff --git a/4.x/_gen/resources/network_services_service_binding.libsonnet b/4.x/_gen/resources/network_services_service_binding.libsonnet new file mode 100644 index 00000000..ec364e77 --- /dev/null +++ b/4.x/_gen/resources/network_services_service_binding.libsonnet @@ -0,0 +1,124 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='google_network_services_service_binding', url='', help='`google_network_services_service_binding` represents the `google-beta_google_network_services_service_binding` 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-beta.google_network_services_service_binding.new` injects a new `google-beta_google_network_services_service_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-beta.google_network_services_service_binding.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_services_service_binding` using the reference:\n\n $._ref.google-beta_google_network_services_service_binding.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_services_service_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 - `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`): Set of label tags associated with the ServiceBinding resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the ServiceBinding 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 - `service` (`string`): The full Service Directory Service name of the format\nprojects/*/locations/*/namespaces/*/services/*\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-beta.google_network_services_service_binding.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, + service, + description=null, + labels=null, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_network_services_service_binding', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + labels=labels, + name=name, + project=project, + service=service, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_network_services_service_binding.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_service_binding`\nTerraform resource.\n\nUnlike [google-beta.google_network_services_service_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 - `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`): Set of label tags associated with the ServiceBinding resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the ServiceBinding 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 - `service` (`string`): The full Service Directory Service name of the format\nprojects/*/locations/*/namespaces/*/services/*\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-beta.google_network_services_service_binding.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 `google_network_services_service_binding` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + name, + service, + description=null, + labels=null, + project=null, + timeouts=null + ):: std.prune(a={ + description: description, + labels: labels, + name: name, + project: project, + service: service, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_service_binding.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-beta.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_network_services_service_binding+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google-beta.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_network_services_service_binding+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google-beta.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_network_services_service_binding+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_network_services_service_binding+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withService':: d.fn(help='`google-beta.string.withService` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the service 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 `service` field.\n', args=[]), + withService(resourceLabel, value): { + resource+: { + google_network_services_service_binding+: { + [resourceLabel]+: { + service: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.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-beta.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_network_services_service_binding+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.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-beta.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_network_services_service_binding+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/network_services_tcp_route.libsonnet b/4.x/_gen/resources/network_services_tcp_route.libsonnet index 8fe1715d..34e42afa 100644 --- a/4.x/_gen/resources/network_services_tcp_route.libsonnet +++ b/4.x/_gen/resources/network_services_tcp_route.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='google_network_services_tcp_route', url='', help='`google_network_services_tcp_route` represents the `google-beta_google_network_services_tcp_route` 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-beta.google_network_services_tcp_route.new` injects a new `google-beta_google_network_services_tcp_route` 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-beta.google_network_services_tcp_route.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_services_tcp_route` using the reference:\n\n $._ref.google-beta_google_network_services_tcp_route.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_services_tcp_route.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 - `gateways` (`list`): Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway.\nEach gateway reference should match the pattern: projects/*/locations/global/gateways/\u0026lt;gateway_name\u0026gt; When `null`, the `gateways` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the TcpRoute resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `meshes` (`list`): Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh.\nEach mesh reference should match the pattern: projects/*/locations/global/meshes/\u0026lt;mesh_name\u0026gt;\nThe attached Mesh should be of a type SIDECAR When `null`, the `meshes` field will be omitted from the resulting object.\n - `name` (`string`): Name of the TcpRoute 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 - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. \nIf there are multiple rules then the action taken will be the first rule to match. When `null`, the `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-beta.google_network_services_tcp_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_tcp_route.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-beta.google_network_services_tcp_route.new` injects a new `google-beta_google_network_services_tcp_route` 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-beta.google_network_services_tcp_route.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_services_tcp_route` using the reference:\n\n $._ref.google-beta_google_network_services_tcp_route.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_services_tcp_route.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 - `gateways` (`list`): Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway.\nEach gateway reference should match the pattern: projects/*/locations/global/gateways/\u0026lt;gateway_name\u0026gt; When `null`, the `gateways` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the TcpRoute resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `meshes` (`list`): Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh.\nEach mesh reference should match the pattern: projects/*/locations/global/meshes/\u0026lt;mesh_name\u0026gt;\nThe attached Mesh should be of a type SIDECAR When `null`, the `meshes` field will be omitted from the resulting object.\n - `name` (`string`): Name of the TcpRoute 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 - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. At least one RouteRule must be supplied.\nIf there are multiple rules then the action taken will be the first rule to match. When `null`, the `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-beta.google_network_services_tcp_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_tcp_route.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, @@ -29,7 +29,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_network_services_tcp_route.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_tcp_route`\nTerraform resource.\n\nUnlike [google-beta.google_network_services_tcp_route.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 - `gateways` (`list`): Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway.\nEach gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name> When `null`, the `gateways` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the TcpRoute resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `meshes` (`list`): Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh.\nEach mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name>\nThe attached Mesh should be of a type SIDECAR When `null`, the `meshes` field will be omitted from the resulting object.\n - `name` (`string`): Name of the TcpRoute 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 - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. \nIf there are multiple rules then the action taken will be the first rule to match. When `null`, the `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-beta.google_network_services_tcp_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_tcp_route.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 `google_network_services_tcp_route` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_network_services_tcp_route.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_tcp_route`\nTerraform resource.\n\nUnlike [google-beta.google_network_services_tcp_route.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 - `gateways` (`list`): Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway.\nEach gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name> When `null`, the `gateways` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the TcpRoute resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `meshes` (`list`): Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh.\nEach mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name>\nThe attached Mesh should be of a type SIDECAR When `null`, the `meshes` field will be omitted from the resulting object.\n - `name` (`string`): Name of the TcpRoute 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 - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. At least one RouteRule must be supplied.\nIf there are multiple rules then the action taken will be the first rule to match. When `null`, the `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-beta.google_network_services_tcp_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_tcp_route.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 `google_network_services_tcp_route` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, description=null, @@ -71,7 +71,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, matches:: { - '#new':: d.fn(help='\n`google-beta.google_network_services_tcp_route.rules.matches.new` constructs a new object with attributes and blocks configured for the `matches`\nTerraform sub block.\n\n\n\n**Args**:\n - `address` (`string`): Must be specified in the CIDR range format. A CIDR range consists of an IP Address and a prefix length to construct the subnet mask. \nBy default, the prefix length is 32 (i.e. matches a single IP address). Only IPV4 addresses are supported. Examples: "10.0.0.1" - matches against this exact IP address. "10.0.0.0/8" - matches against any IP address within the 10.0.0.0 subnet and 255.255.255.0 mask. "0.0.0.0/0" - matches against any IP address'.\n - `port` (`string`): Specifies the destination port to match against.\n\n**Returns**:\n - An attribute object that represents the `matches` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_network_services_tcp_route.rules.matches.new` constructs a new object with attributes and blocks configured for the `matches`\nTerraform sub block.\n\n\n\n**Args**:\n - `address` (`string`): Must be specified in the CIDR range format. A CIDR range consists of an IP Address and a prefix length to construct the subnet mask.\nBy default, the prefix length is 32 (i.e. matches a single IP address). Only IPV4 addresses are supported. Examples: "10.0.0.1" - matches against this exact IP address. "10.0.0.0/8" - matches against any IP address within the 10.0.0.0 subnet and 255.255.255.0 mask. "0.0.0.0/0" - matches against any IP address'.\n - `port` (`string`): Specifies the destination port to match against.\n\n**Returns**:\n - An attribute object that represents the `matches` sub block.\n', args=[]), new( address, port @@ -80,7 +80,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); port: port, }), }, - '#new':: d.fn(help='\n`google-beta.google_network_services_tcp_route.rules.new` constructs a new object with attributes and blocks configured for the `rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `action` (`list[obj]`): A detailed rule defining how to route traffic. When `null`, the `action` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tcp_route.rules.action.new](#fn-rulesactionnew) constructor.\n - `matches` (`list[obj]`): RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "OR"ed for evaluation. \nIf no routeMatch field is specified, this rule will unconditionally match traffic. When `null`, the `matches` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tcp_route.rules.matches.new](#fn-rulesmatchesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rules` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_network_services_tcp_route.rules.new` constructs a new object with attributes and blocks configured for the `rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `action` (`list[obj]`): A detailed rule defining how to route traffic. When `null`, the `action` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tcp_route.rules.action.new](#fn-rulesactionnew) constructor.\n - `matches` (`list[obj]`): RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "OR"ed for evaluation.\nIf no routeMatch field is specified, this rule will unconditionally match traffic. When `null`, the `matches` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tcp_route.rules.matches.new](#fn-rulesmatchesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rules` sub block.\n', args=[]), new( action=null, matches=null diff --git a/4.x/_gen/resources/network_services_tls_route.libsonnet b/4.x/_gen/resources/network_services_tls_route.libsonnet new file mode 100644 index 00000000..f7a077c6 --- /dev/null +++ b/4.x/_gen/resources/network_services_tls_route.libsonnet @@ -0,0 +1,188 @@ +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='google_network_services_tls_route', url='', help='`google_network_services_tls_route` represents the `google-beta_google_network_services_tls_route` 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-beta.google_network_services_tls_route.new` injects a new `google-beta_google_network_services_tls_route` 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-beta.google_network_services_tls_route.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_network_services_tls_route` using the reference:\n\n $._ref.google-beta_google_network_services_tls_route.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_network_services_tls_route.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 - `gateways` (`list`): Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway.\nEach gateway reference should match the pattern: projects/*/locations/global/gateways/\u0026lt;gateway_name\u0026gt; When `null`, the `gateways` field will be omitted from the resulting object.\n - `meshes` (`list`): Meshes defines a list of meshes this TlsRoute is attached to, as one of the routing rules to route the requests served by the mesh.\nEach mesh reference should match the pattern: projects/*/locations/global/meshes/\u0026lt;mesh_name\u0026gt;\nThe attached Mesh should be of a type SIDECAR When `null`, the `meshes` field will be omitted from the resulting object.\n - `name` (`string`): Name of the TlsRoute 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 - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. When `null`, the `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-beta.google_network_services_tls_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_tls_route.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, + description=null, + gateways=null, + meshes=null, + project=null, + rules=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_network_services_tls_route', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + gateways=gateways, + meshes=meshes, + name=name, + project=project, + rules=rules, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_network_services_tls_route.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_tls_route`\nTerraform resource.\n\nUnlike [google-beta.google_network_services_tls_route.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 - `gateways` (`list`): Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway.\nEach gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name> When `null`, the `gateways` field will be omitted from the resulting object.\n - `meshes` (`list`): Meshes defines a list of meshes this TlsRoute is attached to, as one of the routing rules to route the requests served by the mesh.\nEach mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name>\nThe attached Mesh should be of a type SIDECAR When `null`, the `meshes` field will be omitted from the resulting object.\n - `name` (`string`): Name of the TlsRoute 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 - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. When `null`, the `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-beta.google_network_services_tls_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_tls_route.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 `google_network_services_tls_route` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + name, + description=null, + gateways=null, + meshes=null, + project=null, + rules=null, + timeouts=null + ):: std.prune(a={ + description: description, + gateways: gateways, + meshes: meshes, + name: name, + project: project, + rules: rules, + timeouts: timeouts, + }), + rules:: { + action:: { + destinations:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_tls_route.rules.action.destinations.new` constructs a new object with attributes and blocks configured for the `destinations`\nTerraform sub block.\n\n\n\n**Args**:\n - `service_name` (`string`): The URL of a BackendService to route traffic to. When `null`, the `service_name` field will be omitted from the resulting object.\n - `weight` (`number`): Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. When `null`, the `weight` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `destinations` sub block.\n', args=[]), + new( + service_name=null, + weight=null + ):: std.prune(a={ + service_name: service_name, + weight: weight, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_services_tls_route.rules.action.new` constructs a new object with attributes and blocks configured for the `action`\nTerraform sub block.\n\n\n\n**Args**:\n - `destinations` (`list[obj]`): The destination to which traffic should be forwarded. When `null`, the `destinations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tls_route.rules.action.destinations.new](#fn-rulesrulesdestinationsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `action` sub block.\n', args=[]), + new( + destinations=null + ):: std.prune(a={ + destinations: destinations, + }), + }, + matches:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_tls_route.rules.matches.new` constructs a new object with attributes and blocks configured for the `matches`\nTerraform sub block.\n\n\n\n**Args**:\n - `alpn` (`list`): ALPN (Application-Layer Protocol Negotiation) to match against. Examples: "http/1.1", "h2". At least one of sniHost and alpn is required. Up to 5 alpns across all matches can be set. When `null`, the `alpn` field will be omitted from the resulting object.\n - `sni_host` (`list`): SNI (server name indicator) to match against. SNI will be matched against all wildcard domains, i.e. www.example.com will be first matched against www.example.com, then *.example.com, then *.com.\nPartial wildcards are not supported, and values like *w.example.com are invalid. At least one of sniHost and alpn is required. Up to 5 sni hosts across all matches can be set. When `null`, the `sni_host` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `matches` sub block.\n', args=[]), + new( + alpn=null, + sni_host=null + ):: std.prune(a={ + alpn: alpn, + sni_host: sni_host, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_network_services_tls_route.rules.new` constructs a new object with attributes and blocks configured for the `rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `action` (`list[obj]`): Required. A detailed rule defining how to route traffic. When `null`, the `action` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tls_route.rules.action.new](#fn-rulesactionnew) constructor.\n - `matches` (`list[obj]`): Matches define the predicate used to match requests to a given action. When `null`, the `matches` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tls_route.rules.matches.new](#fn-rulesmatchesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rules` sub block.\n', args=[]), + new( + action=null, + matches=null + ):: std.prune(a={ + action: action, + matches: matches, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_network_services_tls_route.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#withDescription':: d.fn(help='`google-beta.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_network_services_tls_route+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withGateways':: d.fn(help='`google-beta.list.withGateways` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the gateways 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 `gateways` field.\n', args=[]), + withGateways(resourceLabel, value): { + resource+: { + google_network_services_tls_route+: { + [resourceLabel]+: { + gateways: value, + }, + }, + }, + }, + '#withMeshes':: d.fn(help='`google-beta.list.withMeshes` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the meshes 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 `meshes` field.\n', args=[]), + withMeshes(resourceLabel, value): { + resource+: { + google_network_services_tls_route+: { + [resourceLabel]+: { + meshes: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google-beta.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_network_services_tls_route+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_network_services_tls_route+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRules':: d.fn(help='`google-beta.list[obj].withRules` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the rules 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-beta.list[obj].withRulesMixin](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 `rules` field.\n', args=[]), + withRules(resourceLabel, value): { + resource+: { + google_network_services_tls_route+: { + [resourceLabel]+: { + rules: value, + }, + }, + }, + }, + '#withRulesMixin':: d.fn(help='`google-beta.list[obj].withRulesMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the rules 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-beta.list[obj].withRules](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 `rules` field.\n', args=[]), + withRulesMixin(resourceLabel, value): { + resource+: { + google_network_services_tls_route+: { + [resourceLabel]+: { + rules+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.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-beta.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_network_services_tls_route+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.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-beta.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_network_services_tls_route+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/privateca_ca_pool.libsonnet b/4.x/_gen/resources/privateca_ca_pool.libsonnet index 527cbc91..ae5dce85 100644 --- a/4.x/_gen/resources/privateca_ca_pool.libsonnet +++ b/4.x/_gen/resources/privateca_ca_pool.libsonnet @@ -63,7 +63,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, ca_options:: { - '#new':: d.fn(help='\n`google-beta.google_privateca_ca_pool.issuance_policy.baseline_values.ca_options.new` constructs a new object with attributes and blocks configured for the `ca_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `is_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to true. When `null`, the `is_ca` field will be omitted from the resulting object.\n - `max_issuer_path_length` (`number`): Refers to the "path length constraint" in Basic Constraints extension. For a CA certificate, this value describes the depth of\nsubordinate CA certificates that are allowed. If this value is less than 0, the request will fail. When `null`, the `max_issuer_path_length` field will be omitted from the resulting object.\n - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false. \nIf both 'is_ca' and 'non_ca' are unset, the extension will be omitted from the CA certificate. When `null`, the `non_ca` field will be omitted from the resulting object.\n - `zero_max_issuer_path_length` (`bool`): When true, the "path length constraint" in Basic Constraints extension will be set to 0.\nif both 'max_issuer_path_length' and 'zero_max_issuer_path_length' are unset,\nthe max path length will be omitted from the CA certificate. When `null`, the `zero_max_issuer_path_length` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ca_options` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_privateca_ca_pool.issuance_policy.baseline_values.ca_options.new` constructs a new object with attributes and blocks configured for the `ca_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `is_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to true. When `null`, the `is_ca` field will be omitted from the resulting object.\n - `max_issuer_path_length` (`number`): Refers to the "path length constraint" in Basic Constraints extension. For a CA certificate, this value describes the depth of\nsubordinate CA certificates that are allowed. If this value is less than 0, the request will fail. When `null`, the `max_issuer_path_length` field will be omitted from the resulting object.\n - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false.\nIf both 'is_ca' and 'non_ca' are unset, the extension will be omitted from the CA certificate. When `null`, the `non_ca` field will be omitted from the resulting object.\n - `zero_max_issuer_path_length` (`bool`): When true, the "path length constraint" in Basic Constraints extension will be set to 0.\nif both 'max_issuer_path_length' and 'zero_max_issuer_path_length' are unset,\nthe max path length will be omitted from the CA certificate. When `null`, the `zero_max_issuer_path_length` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ca_options` sub block.\n', args=[]), new( is_ca=null, max_issuer_path_length=null, diff --git a/4.x/_gen/resources/privateca_certificate.libsonnet b/4.x/_gen/resources/privateca_certificate.libsonnet index 50bfe35e..e0baa6f0 100644 --- a/4.x/_gen/resources/privateca_certificate.libsonnet +++ b/4.x/_gen/resources/privateca_certificate.libsonnet @@ -91,7 +91,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, ca_options:: { - '#new':: d.fn(help='\n`google-beta.google_privateca_certificate.config.x509_config.ca_options.new` constructs a new object with attributes and blocks configured for the `ca_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `is_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to true. When `null`, the `is_ca` field will be omitted from the resulting object.\n - `max_issuer_path_length` (`number`): Refers to the "path length constraint" in Basic Constraints extension. For a CA certificate, this value describes the depth of\nsubordinate CA certificates that are allowed. If this value is less than 0, the request will fail. When `null`, the `max_issuer_path_length` field will be omitted from the resulting object.\n - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false. \nIf both 'is_ca' and 'non_ca' are unset, the extension will be omitted from the CA certificate. When `null`, the `non_ca` field will be omitted from the resulting object.\n - `zero_max_issuer_path_length` (`bool`): When true, the "path length constraint" in Basic Constraints extension will be set to 0.\nif both 'max_issuer_path_length' and 'zero_max_issuer_path_length' are unset,\nthe max path length will be omitted from the CA certificate. When `null`, the `zero_max_issuer_path_length` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ca_options` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_privateca_certificate.config.x509_config.ca_options.new` constructs a new object with attributes and blocks configured for the `ca_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `is_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to true. When `null`, the `is_ca` field will be omitted from the resulting object.\n - `max_issuer_path_length` (`number`): Refers to the "path length constraint" in Basic Constraints extension. For a CA certificate, this value describes the depth of\nsubordinate CA certificates that are allowed. If this value is less than 0, the request will fail. When `null`, the `max_issuer_path_length` field will be omitted from the resulting object.\n - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false.\nIf both 'is_ca' and 'non_ca' are unset, the extension will be omitted from the CA certificate. When `null`, the `non_ca` field will be omitted from the resulting object.\n - `zero_max_issuer_path_length` (`bool`): When true, the "path length constraint" in Basic Constraints extension will be set to 0.\nif both 'max_issuer_path_length' and 'zero_max_issuer_path_length' are unset,\nthe max path length will be omitted from the CA certificate. When `null`, the `zero_max_issuer_path_length` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ca_options` sub block.\n', args=[]), new( is_ca=null, max_issuer_path_length=null, diff --git a/4.x/_gen/resources/privateca_certificate_authority.libsonnet b/4.x/_gen/resources/privateca_certificate_authority.libsonnet index 82bff99d..49b6219b 100644 --- a/4.x/_gen/resources/privateca_certificate_authority.libsonnet +++ b/4.x/_gen/resources/privateca_certificate_authority.libsonnet @@ -79,7 +79,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, ca_options:: { - '#new':: d.fn(help='\n`google-beta.google_privateca_certificate_authority.config.x509_config.ca_options.new` constructs a new object with attributes and blocks configured for the `ca_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `is_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to true.\n - `max_issuer_path_length` (`number`): Refers to the "path length constraint" in Basic Constraints extension. For a CA certificate, this value describes the depth of\nsubordinate CA certificates that are allowed. If this value is less than 0, the request will fail. Setting the value to 0\nrequires setting 'zero_max_issuer_path_length = true'. When `null`, the `max_issuer_path_length` field will be omitted from the resulting object.\n - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false. \nIf both 'is_ca' and 'non_ca' are unset, the extension will be omitted from the CA certificate. When `null`, the `non_ca` field will be omitted from the resulting object.\n - `zero_max_issuer_path_length` (`bool`): When true, the "path length constraint" in Basic Constraints extension will be set to 0.\nIf both 'max_issuer_path_length' and 'zero_max_issuer_path_length' are unset,\nthe max path length will be omitted from the CA certificate. When `null`, the `zero_max_issuer_path_length` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ca_options` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_privateca_certificate_authority.config.x509_config.ca_options.new` constructs a new object with attributes and blocks configured for the `ca_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `is_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to true.\n - `max_issuer_path_length` (`number`): Refers to the "path length constraint" in Basic Constraints extension. For a CA certificate, this value describes the depth of\nsubordinate CA certificates that are allowed. If this value is less than 0, the request will fail. Setting the value to 0\nrequires setting 'zero_max_issuer_path_length = true'. When `null`, the `max_issuer_path_length` field will be omitted from the resulting object.\n - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false.\nIf both 'is_ca' and 'non_ca' are unset, the extension will be omitted from the CA certificate. When `null`, the `non_ca` field will be omitted from the resulting object.\n - `zero_max_issuer_path_length` (`bool`): When true, the "path length constraint" in Basic Constraints extension will be set to 0.\nIf both 'max_issuer_path_length' and 'zero_max_issuer_path_length' are unset,\nthe max path length will be omitted from the CA certificate. When `null`, the `zero_max_issuer_path_length` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ca_options` sub block.\n', args=[]), new( is_ca, max_issuer_path_length=null, @@ -298,7 +298,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type: type, }), subordinate_config:: { - '#new':: d.fn(help='\n`google-beta.google_privateca_certificate_authority.subordinate_config.new` constructs a new object with attributes and blocks configured for the `subordinate_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `certificate_authority` (`string`): This can refer to a CertificateAuthority that was used to create a\nsubordinate CertificateAuthority. This field is used for information\nand usability purposes only. The resource name is in the format\n'projects/*/locations/*/caPools/*/certificateAuthorities/*'. When `null`, the `certificate_authority` field will be omitted from the resulting object.\n - `pem_issuer_chain` (`list[obj]`): Contains the PEM certificate chain for the issuers of this CertificateAuthority, \nbut not pem certificate for this CA itself. When `null`, the `pem_issuer_chain` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_privateca_certificate_authority.subordinate_config.pem_issuer_chain.new](#fn-subordinate_configpem_issuer_chainnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `subordinate_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_privateca_certificate_authority.subordinate_config.new` constructs a new object with attributes and blocks configured for the `subordinate_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `certificate_authority` (`string`): This can refer to a CertificateAuthority that was used to create a\nsubordinate CertificateAuthority. This field is used for information\nand usability purposes only. The resource name is in the format\n'projects/*/locations/*/caPools/*/certificateAuthorities/*'. When `null`, the `certificate_authority` field will be omitted from the resulting object.\n - `pem_issuer_chain` (`list[obj]`): Contains the PEM certificate chain for the issuers of this CertificateAuthority,\nbut not pem certificate for this CA itself. When `null`, the `pem_issuer_chain` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_privateca_certificate_authority.subordinate_config.pem_issuer_chain.new](#fn-subordinate_configpem_issuer_chainnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `subordinate_config` sub block.\n', args=[]), new( certificate_authority=null, pem_issuer_chain=null diff --git a/4.x/_gen/resources/pubsub_subscription.libsonnet b/4.x/_gen/resources/pubsub_subscription.libsonnet index 1236dc51..b4654904 100644 --- a/4.x/_gen/resources/pubsub_subscription.libsonnet +++ b/4.x/_gen/resources/pubsub_subscription.libsonnet @@ -17,7 +17,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, dead_letter_policy:: { - '#new':: d.fn(help='\n`google-beta.google_pubsub_subscription.dead_letter_policy.new` constructs a new object with attributes and blocks configured for the `dead_letter_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `dead_letter_topic` (`string`): The name of the topic to which dead letter messages should be published.\nFormat is 'projects/{project}/topics/{topic}'.\n\nThe Cloud Pub/Sub service account associated with the enclosing subscription's\nparent project (i.e., \nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have\npermission to Publish() to this topic.\n\nThe operation will fail if the topic does not exist.\nUsers should ensure that there is a subscription attached to this topic\nsince messages published to a topic with no subscriptions are lost. When `null`, the `dead_letter_topic` field will be omitted from the resulting object.\n - `max_delivery_attempts` (`number`): The maximum number of delivery attempts for any message. The value must be\nbetween 5 and 100.\n\nThe number of delivery attempts is defined as 1 + (the sum of number of \nNACKs and number of times the acknowledgement deadline has been exceeded for the message).\n\nA NACK is any call to ModifyAckDeadline with a 0 deadline. Note that\nclient libraries may automatically extend ack_deadlines.\n\nThis field will be honored on a best effort basis.\n\nIf this parameter is 0, a default value of 5 is used. When `null`, the `max_delivery_attempts` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `dead_letter_policy` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_pubsub_subscription.dead_letter_policy.new` constructs a new object with attributes and blocks configured for the `dead_letter_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `dead_letter_topic` (`string`): The name of the topic to which dead letter messages should be published.\nFormat is 'projects/{project}/topics/{topic}'.\n\nThe Cloud Pub/Sub service account associated with the enclosing subscription's\nparent project (i.e.,\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have\npermission to Publish() to this topic.\n\nThe operation will fail if the topic does not exist.\nUsers should ensure that there is a subscription attached to this topic\nsince messages published to a topic with no subscriptions are lost. When `null`, the `dead_letter_topic` field will be omitted from the resulting object.\n - `max_delivery_attempts` (`number`): The maximum number of delivery attempts for any message. The value must be\nbetween 5 and 100.\n\nThe number of delivery attempts is defined as 1 + (the sum of number of\nNACKs and number of times the acknowledgement deadline has been exceeded for the message).\n\nA NACK is any call to ModifyAckDeadline with a 0 deadline. Note that\nclient libraries may automatically extend ack_deadlines.\n\nThis field will be honored on a best effort basis.\n\nIf this parameter is 0, a default value of 5 is used. When `null`, the `max_delivery_attempts` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `dead_letter_policy` sub block.\n', args=[]), new( dead_letter_topic=null, max_delivery_attempts=null @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ttl: ttl, }), }, - '#new':: d.fn(help="\n`google-beta.google_pubsub_subscription.new` injects a new `google-beta_google_pubsub_subscription` 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-beta.google_pubsub_subscription.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_pubsub_subscription` using the reference:\n\n $._ref.google-beta_google_pubsub_subscription.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_pubsub_subscription.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 - `ack_deadline_seconds` (`number`): This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for\nthe ack deadline. To override this value for a given message, call\nsubscriptions.modifyAckDeadline with the corresponding ackId if using\npull. The minimum custom deadline you can specify is 10 seconds. The\nmaximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this parameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this value is also used to set the request timeout\nfor the call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub system\nwill eventually redeliver the message. When `null`, the `ack_deadline_seconds` field will be omitted from the resulting object.\n - `enable_exactly_once_delivery` (`bool`): If \u0026#39;true\u0026#39;, Pub/Sub provides the following guarantees for the delivery\nof a message with a given value of messageId on this Subscriptions\u0026#39;:\n\n- The message sent to a subscriber is guaranteed not to be resent before the message\u0026#39;s acknowledgement deadline expires.\n\n- An acknowledged message will not be resent to a subscriber.\n\nNote that subscribers may still receive multiple copies of a message when \u0026#39;enable_exactly_once_delivery\u0026#39;\nis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct messageId values When `null`, the `enable_exactly_once_delivery` field will be omitted from the resulting object.\n - `enable_message_ordering` (`bool`): If \u0026#39;true\u0026#39;, messages published with the same orderingKey in PubsubMessage will be delivered to\nthe subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they\nmay be delivered in any order. When `null`, the `enable_message_ordering` field will be omitted from the resulting object.\n - `filter` (`string`): The subscription only delivers the messages that match the filter. \nPub/Sub automatically acknowledges the messages that don\u0026#39;t match the filter. You can filter messages\nby their attributes. The maximum length of a filter is 256 bytes. After creating the subscription, \nyou can\u0026#39;t modify the filter. When `null`, the `filter` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Subscription. When `null`, the `labels` field will be omitted from the resulting object.\n - `message_retention_duration` (`string`): How long to retain unacknowledged messages in the subscription\u0026#39;s\nbacklog, from the moment a message is published. If\nretain_acked_messages is true, then this also configures the retention\nof acknowledged messages, and thus configures how far back in time a\nsubscriptions.seek can be done. Defaults to 7 days. Cannot be more\nthan 7 days (\u0026#39;\u0026#34;604800s\u0026#34;\u0026#39;) or less than 10 minutes (\u0026#39;\u0026#34;600s\u0026#34;\u0026#39;).\n\nA duration in seconds with up to nine fractional digits, terminated\nby \u0026#39;s\u0026#39;. Example: \u0026#39;\u0026#34;600.5s\u0026#34;\u0026#39;. When `null`, the `message_retention_duration` field will be omitted from the resulting object.\n - `name` (`string`): Name of the subscription.\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 - `retain_acked_messages` (`bool`): Indicates whether to retain acknowledged messages. If \u0026#39;true\u0026#39;, then\nmessages are not expunged from the subscription\u0026#39;s backlog, even if\nthey are acknowledged, until they fall out of the\nmessageRetentionDuration window. When `null`, the `retain_acked_messages` field will be omitted from the resulting object.\n - `topic` (`string`): A reference to a Topic resource.\n - `bigquery_config` (`list[obj]`): If delivery to BigQuery is used with this subscription, this field is used to configure it.\nEither pushConfig or bigQueryConfig can be set, but not both.\nIf both are empty, then the subscriber will pull and ack messages using API methods. When `null`, the `bigquery_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-beta.google_pubsub_subscription.bigquery_config.new](#fn-bigquery_confignew) constructor.\n - `dead_letter_policy` (`list[obj]`): A policy that specifies the conditions for dead lettering messages in\nthis subscription. If dead_letter_policy is not set, dead lettering\nis disabled.\n\nThe Cloud Pub/Sub service account associated with this subscription\u0026#39;s\nparent project (i.e.,\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have\npermission to Acknowledge() messages on this subscription. When `null`, the `dead_letter_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-beta.google_pubsub_subscription.dead_letter_policy.new](#fn-dead_letter_policynew) constructor.\n - `expiration_policy` (`list[obj]`): A policy that specifies the conditions for this subscription\u0026#39;s expiration.\nA subscription is considered active as long as any connected subscriber\nis successfully consuming messages from the subscription or is issuing\noperations on the subscription. If expirationPolicy is not set, a default\npolicy with ttl of 31 days will be used. If it is set but ttl is \u0026#34;\u0026#34;, the\nresource never expires. The minimum allowed value for expirationPolicy.ttl\nis 1 day. When `null`, the `expiration_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-beta.google_pubsub_subscription.expiration_policy.new](#fn-expiration_policynew) constructor.\n - `push_config` (`list[obj]`): If push delivery is used with this subscription, this field is used to\nconfigure it. An empty pushConfig signifies that the subscriber will\npull and ack messages using API methods. When `null`, the `push_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-beta.google_pubsub_subscription.push_config.new](#fn-push_confignew) constructor.\n - `retry_policy` (`list[obj]`): A policy that specifies how Pub/Sub retries message delivery for this subscription.\n\nIf not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. \nRetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message When `null`, the `retry_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-beta.google_pubsub_subscription.retry_policy.new](#fn-retry_policynew) 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-beta.google_pubsub_subscription.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-beta.google_pubsub_subscription.new` injects a new `google-beta_google_pubsub_subscription` 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-beta.google_pubsub_subscription.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_pubsub_subscription` using the reference:\n\n $._ref.google-beta_google_pubsub_subscription.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_pubsub_subscription.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 - `ack_deadline_seconds` (`number`): This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for\nthe ack deadline. To override this value for a given message, call\nsubscriptions.modifyAckDeadline with the corresponding ackId if using\npull. The minimum custom deadline you can specify is 10 seconds. The\nmaximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this parameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this value is also used to set the request timeout\nfor the call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub system\nwill eventually redeliver the message. When `null`, the `ack_deadline_seconds` field will be omitted from the resulting object.\n - `enable_exactly_once_delivery` (`bool`): If \u0026#39;true\u0026#39;, Pub/Sub provides the following guarantees for the delivery\nof a message with a given value of messageId on this Subscriptions\u0026#39;:\n\n- The message sent to a subscriber is guaranteed not to be resent before the message\u0026#39;s acknowledgement deadline expires.\n\n- An acknowledged message will not be resent to a subscriber.\n\nNote that subscribers may still receive multiple copies of a message when \u0026#39;enable_exactly_once_delivery\u0026#39;\nis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct messageId values When `null`, the `enable_exactly_once_delivery` field will be omitted from the resulting object.\n - `enable_message_ordering` (`bool`): If \u0026#39;true\u0026#39;, messages published with the same orderingKey in PubsubMessage will be delivered to\nthe subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they\nmay be delivered in any order. When `null`, the `enable_message_ordering` field will be omitted from the resulting object.\n - `filter` (`string`): The subscription only delivers the messages that match the filter.\nPub/Sub automatically acknowledges the messages that don\u0026#39;t match the filter. You can filter messages\nby their attributes. The maximum length of a filter is 256 bytes. After creating the subscription,\nyou can\u0026#39;t modify the filter. When `null`, the `filter` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Subscription. When `null`, the `labels` field will be omitted from the resulting object.\n - `message_retention_duration` (`string`): How long to retain unacknowledged messages in the subscription\u0026#39;s\nbacklog, from the moment a message is published. If\nretain_acked_messages is true, then this also configures the retention\nof acknowledged messages, and thus configures how far back in time a\nsubscriptions.seek can be done. Defaults to 7 days. Cannot be more\nthan 7 days (\u0026#39;\u0026#34;604800s\u0026#34;\u0026#39;) or less than 10 minutes (\u0026#39;\u0026#34;600s\u0026#34;\u0026#39;).\n\nA duration in seconds with up to nine fractional digits, terminated\nby \u0026#39;s\u0026#39;. Example: \u0026#39;\u0026#34;600.5s\u0026#34;\u0026#39;. When `null`, the `message_retention_duration` field will be omitted from the resulting object.\n - `name` (`string`): Name of the subscription.\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 - `retain_acked_messages` (`bool`): Indicates whether to retain acknowledged messages. If \u0026#39;true\u0026#39;, then\nmessages are not expunged from the subscription\u0026#39;s backlog, even if\nthey are acknowledged, until they fall out of the\nmessageRetentionDuration window. When `null`, the `retain_acked_messages` field will be omitted from the resulting object.\n - `topic` (`string`): A reference to a Topic resource.\n - `bigquery_config` (`list[obj]`): If delivery to BigQuery is used with this subscription, this field is used to configure it.\nEither pushConfig or bigQueryConfig can be set, but not both.\nIf both are empty, then the subscriber will pull and ack messages using API methods. When `null`, the `bigquery_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-beta.google_pubsub_subscription.bigquery_config.new](#fn-bigquery_confignew) constructor.\n - `dead_letter_policy` (`list[obj]`): A policy that specifies the conditions for dead lettering messages in\nthis subscription. If dead_letter_policy is not set, dead lettering\nis disabled.\n\nThe Cloud Pub/Sub service account associated with this subscription\u0026#39;s\nparent project (i.e.,\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have\npermission to Acknowledge() messages on this subscription. When `null`, the `dead_letter_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-beta.google_pubsub_subscription.dead_letter_policy.new](#fn-dead_letter_policynew) constructor.\n - `expiration_policy` (`list[obj]`): A policy that specifies the conditions for this subscription\u0026#39;s expiration.\nA subscription is considered active as long as any connected subscriber\nis successfully consuming messages from the subscription or is issuing\noperations on the subscription. If expirationPolicy is not set, a default\npolicy with ttl of 31 days will be used. If it is set but ttl is \u0026#34;\u0026#34;, the\nresource never expires. The minimum allowed value for expirationPolicy.ttl\nis 1 day. When `null`, the `expiration_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-beta.google_pubsub_subscription.expiration_policy.new](#fn-expiration_policynew) constructor.\n - `push_config` (`list[obj]`): If push delivery is used with this subscription, this field is used to\nconfigure it. An empty pushConfig signifies that the subscriber will\npull and ack messages using API methods. When `null`, the `push_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-beta.google_pubsub_subscription.push_config.new](#fn-push_confignew) constructor.\n - `retry_policy` (`list[obj]`): A policy that specifies how Pub/Sub retries message delivery for this subscription.\n\nIf not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers.\nRetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message When `null`, the `retry_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-beta.google_pubsub_subscription.retry_policy.new](#fn-retry_policynew) 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-beta.google_pubsub_subscription.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-beta.google_pubsub_subscription.newAttrs` constructs a new object with attributes and blocks configured for the `google_pubsub_subscription`\nTerraform resource.\n\nUnlike [google-beta.google_pubsub_subscription.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 - `ack_deadline_seconds` (`number`): This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for\nthe ack deadline. To override this value for a given message, call\nsubscriptions.modifyAckDeadline with the corresponding ackId if using\npull. The minimum custom deadline you can specify is 10 seconds. The\nmaximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this parameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this value is also used to set the request timeout\nfor the call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub system\nwill eventually redeliver the message. When `null`, the `ack_deadline_seconds` field will be omitted from the resulting object.\n - `enable_exactly_once_delivery` (`bool`): If 'true', Pub/Sub provides the following guarantees for the delivery\nof a message with a given value of messageId on this Subscriptions':\n\n- The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires.\n\n- An acknowledged message will not be resent to a subscriber.\n\nNote that subscribers may still receive multiple copies of a message when 'enable_exactly_once_delivery'\nis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct messageId values When `null`, the `enable_exactly_once_delivery` field will be omitted from the resulting object.\n - `enable_message_ordering` (`bool`): If 'true', messages published with the same orderingKey in PubsubMessage will be delivered to\nthe subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they\nmay be delivered in any order. When `null`, the `enable_message_ordering` field will be omitted from the resulting object.\n - `filter` (`string`): The subscription only delivers the messages that match the filter. \nPub/Sub automatically acknowledges the messages that don't match the filter. You can filter messages\nby their attributes. The maximum length of a filter is 256 bytes. After creating the subscription, \nyou can't modify the filter. When `null`, the `filter` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Subscription. When `null`, the `labels` field will be omitted from the resulting object.\n - `message_retention_duration` (`string`): How long to retain unacknowledged messages in the subscription's\nbacklog, from the moment a message is published. If\nretain_acked_messages is true, then this also configures the retention\nof acknowledged messages, and thus configures how far back in time a\nsubscriptions.seek can be done. Defaults to 7 days. Cannot be more\nthan 7 days ('"604800s"') or less than 10 minutes ('"600s"').\n\nA duration in seconds with up to nine fractional digits, terminated\nby 's'. Example: '"600.5s"'. When `null`, the `message_retention_duration` field will be omitted from the resulting object.\n - `name` (`string`): Name of the subscription.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `retain_acked_messages` (`bool`): Indicates whether to retain acknowledged messages. If 'true', then\nmessages are not expunged from the subscription's backlog, even if\nthey are acknowledged, until they fall out of the\nmessageRetentionDuration window. When `null`, the `retain_acked_messages` field will be omitted from the resulting object.\n - `topic` (`string`): A reference to a Topic resource.\n - `bigquery_config` (`list[obj]`): If delivery to BigQuery is used with this subscription, this field is used to configure it.\nEither pushConfig or bigQueryConfig can be set, but not both.\nIf both are empty, then the subscriber will pull and ack messages using API methods. When `null`, the `bigquery_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-beta.google_pubsub_subscription.bigquery_config.new](#fn-bigquery_confignew) constructor.\n - `dead_letter_policy` (`list[obj]`): A policy that specifies the conditions for dead lettering messages in\nthis subscription. If dead_letter_policy is not set, dead lettering\nis disabled.\n\nThe Cloud Pub/Sub service account associated with this subscription's\nparent project (i.e.,\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have\npermission to Acknowledge() messages on this subscription. When `null`, the `dead_letter_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-beta.google_pubsub_subscription.dead_letter_policy.new](#fn-dead_letter_policynew) constructor.\n - `expiration_policy` (`list[obj]`): A policy that specifies the conditions for this subscription's expiration.\nA subscription is considered active as long as any connected subscriber\nis successfully consuming messages from the subscription or is issuing\noperations on the subscription. If expirationPolicy is not set, a default\npolicy with ttl of 31 days will be used. If it is set but ttl is "", the\nresource never expires. The minimum allowed value for expirationPolicy.ttl\nis 1 day. When `null`, the `expiration_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-beta.google_pubsub_subscription.expiration_policy.new](#fn-expiration_policynew) constructor.\n - `push_config` (`list[obj]`): If push delivery is used with this subscription, this field is used to\nconfigure it. An empty pushConfig signifies that the subscriber will\npull and ack messages using API methods. When `null`, the `push_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-beta.google_pubsub_subscription.push_config.new](#fn-push_confignew) constructor.\n - `retry_policy` (`list[obj]`): A policy that specifies how Pub/Sub retries message delivery for this subscription.\n\nIf not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. \nRetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message When `null`, the `retry_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-beta.google_pubsub_subscription.retry_policy.new](#fn-retry_policynew) 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-beta.google_pubsub_subscription.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 `google_pubsub_subscription` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_pubsub_subscription.newAttrs` constructs a new object with attributes and blocks configured for the `google_pubsub_subscription`\nTerraform resource.\n\nUnlike [google-beta.google_pubsub_subscription.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 - `ack_deadline_seconds` (`number`): This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for\nthe ack deadline. To override this value for a given message, call\nsubscriptions.modifyAckDeadline with the corresponding ackId if using\npull. The minimum custom deadline you can specify is 10 seconds. The\nmaximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this parameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this value is also used to set the request timeout\nfor the call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub system\nwill eventually redeliver the message. When `null`, the `ack_deadline_seconds` field will be omitted from the resulting object.\n - `enable_exactly_once_delivery` (`bool`): If 'true', Pub/Sub provides the following guarantees for the delivery\nof a message with a given value of messageId on this Subscriptions':\n\n- The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires.\n\n- An acknowledged message will not be resent to a subscriber.\n\nNote that subscribers may still receive multiple copies of a message when 'enable_exactly_once_delivery'\nis true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct messageId values When `null`, the `enable_exactly_once_delivery` field will be omitted from the resulting object.\n - `enable_message_ordering` (`bool`): If 'true', messages published with the same orderingKey in PubsubMessage will be delivered to\nthe subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they\nmay be delivered in any order. When `null`, the `enable_message_ordering` field will be omitted from the resulting object.\n - `filter` (`string`): The subscription only delivers the messages that match the filter.\nPub/Sub automatically acknowledges the messages that don't match the filter. You can filter messages\nby their attributes. The maximum length of a filter is 256 bytes. After creating the subscription,\nyou can't modify the filter. When `null`, the `filter` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Subscription. When `null`, the `labels` field will be omitted from the resulting object.\n - `message_retention_duration` (`string`): How long to retain unacknowledged messages in the subscription's\nbacklog, from the moment a message is published. If\nretain_acked_messages is true, then this also configures the retention\nof acknowledged messages, and thus configures how far back in time a\nsubscriptions.seek can be done. Defaults to 7 days. Cannot be more\nthan 7 days ('"604800s"') or less than 10 minutes ('"600s"').\n\nA duration in seconds with up to nine fractional digits, terminated\nby 's'. Example: '"600.5s"'. When `null`, the `message_retention_duration` field will be omitted from the resulting object.\n - `name` (`string`): Name of the subscription.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `retain_acked_messages` (`bool`): Indicates whether to retain acknowledged messages. If 'true', then\nmessages are not expunged from the subscription's backlog, even if\nthey are acknowledged, until they fall out of the\nmessageRetentionDuration window. When `null`, the `retain_acked_messages` field will be omitted from the resulting object.\n - `topic` (`string`): A reference to a Topic resource.\n - `bigquery_config` (`list[obj]`): If delivery to BigQuery is used with this subscription, this field is used to configure it.\nEither pushConfig or bigQueryConfig can be set, but not both.\nIf both are empty, then the subscriber will pull and ack messages using API methods. When `null`, the `bigquery_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-beta.google_pubsub_subscription.bigquery_config.new](#fn-bigquery_confignew) constructor.\n - `dead_letter_policy` (`list[obj]`): A policy that specifies the conditions for dead lettering messages in\nthis subscription. If dead_letter_policy is not set, dead lettering\nis disabled.\n\nThe Cloud Pub/Sub service account associated with this subscription's\nparent project (i.e.,\nservice-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have\npermission to Acknowledge() messages on this subscription. When `null`, the `dead_letter_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-beta.google_pubsub_subscription.dead_letter_policy.new](#fn-dead_letter_policynew) constructor.\n - `expiration_policy` (`list[obj]`): A policy that specifies the conditions for this subscription's expiration.\nA subscription is considered active as long as any connected subscriber\nis successfully consuming messages from the subscription or is issuing\noperations on the subscription. If expirationPolicy is not set, a default\npolicy with ttl of 31 days will be used. If it is set but ttl is "", the\nresource never expires. The minimum allowed value for expirationPolicy.ttl\nis 1 day. When `null`, the `expiration_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-beta.google_pubsub_subscription.expiration_policy.new](#fn-expiration_policynew) constructor.\n - `push_config` (`list[obj]`): If push delivery is used with this subscription, this field is used to\nconfigure it. An empty pushConfig signifies that the subscriber will\npull and ack messages using API methods. When `null`, the `push_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-beta.google_pubsub_subscription.push_config.new](#fn-push_confignew) constructor.\n - `retry_policy` (`list[obj]`): A policy that specifies how Pub/Sub retries message delivery for this subscription.\n\nIf not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers.\nRetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message When `null`, the `retry_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-beta.google_pubsub_subscription.retry_policy.new](#fn-retry_policynew) 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-beta.google_pubsub_subscription.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 `google_pubsub_subscription` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, topic, @@ -136,7 +136,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, retry_policy:: { - '#new':: d.fn(help='\n`google-beta.google_pubsub_subscription.retry_policy.new` constructs a new object with attributes and blocks configured for the `retry_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `maximum_backoff` (`string`): The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. \nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `maximum_backoff` field will be omitted from the resulting object.\n - `minimum_backoff` (`string`): The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `minimum_backoff` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `retry_policy` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_pubsub_subscription.retry_policy.new` constructs a new object with attributes and blocks configured for the `retry_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `maximum_backoff` (`string`): The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `maximum_backoff` field will be omitted from the resulting object.\n - `minimum_backoff` (`string`): The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `minimum_backoff` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `retry_policy` sub block.\n', args=[]), new( maximum_backoff=null, minimum_backoff=null diff --git a/4.x/_gen/resources/sourcerepo_repository.libsonnet b/4.x/_gen/resources/sourcerepo_repository.libsonnet index 590d6b5b..5f9fa3f5 100644 --- a/4.x/_gen/resources/sourcerepo_repository.libsonnet +++ b/4.x/_gen/resources/sourcerepo_repository.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='google_sourcerepo_repository', url='', help='`google_sourcerepo_repository` represents the `google-beta_google_sourcerepo_repository` 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-beta.google_sourcerepo_repository.new` injects a new `google-beta_google_sourcerepo_repository` 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-beta.google_sourcerepo_repository.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_sourcerepo_repository` using the reference:\n\n $._ref.google-beta_google_sourcerepo_repository.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_sourcerepo_repository.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 - `name` (`string`): Resource name of the repository, of the form \u0026#39;{{repo}}\u0026#39;.\nThe repo name may contain slashes. eg, \u0026#39;name/with/slash\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 - `pubsub_configs` (`list[obj]`): How this repository publishes a change in the repository through Cloud Pub/Sub. \nKeyed by the topic names. When `null`, the `pubsub_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sourcerepo_repository.pubsub_configs.new](#fn-pubsub_configsnew) 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-beta.google_sourcerepo_repository.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-beta.google_sourcerepo_repository.new` injects a new `google-beta_google_sourcerepo_repository` 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-beta.google_sourcerepo_repository.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_sourcerepo_repository` using the reference:\n\n $._ref.google-beta_google_sourcerepo_repository.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_sourcerepo_repository.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 - `name` (`string`): Resource name of the repository, of the form \u0026#39;{{repo}}\u0026#39;.\nThe repo name may contain slashes. eg, \u0026#39;name/with/slash\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 - `pubsub_configs` (`list[obj]`): How this repository publishes a change in the repository through Cloud Pub/Sub.\nKeyed by the topic names. When `null`, the `pubsub_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sourcerepo_repository.pubsub_configs.new](#fn-pubsub_configsnew) 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-beta.google_sourcerepo_repository.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, @@ -21,7 +21,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_sourcerepo_repository.newAttrs` constructs a new object with attributes and blocks configured for the `google_sourcerepo_repository`\nTerraform resource.\n\nUnlike [google-beta.google_sourcerepo_repository.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 - `name` (`string`): Resource name of the repository, of the form '{{repo}}'.\nThe repo name may contain slashes. eg, 'name/with/slash'\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `pubsub_configs` (`list[obj]`): How this repository publishes a change in the repository through Cloud Pub/Sub. \nKeyed by the topic names. When `null`, the `pubsub_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sourcerepo_repository.pubsub_configs.new](#fn-pubsub_configsnew) 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-beta.google_sourcerepo_repository.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 `google_sourcerepo_repository` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_sourcerepo_repository.newAttrs` constructs a new object with attributes and blocks configured for the `google_sourcerepo_repository`\nTerraform resource.\n\nUnlike [google-beta.google_sourcerepo_repository.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 - `name` (`string`): Resource name of the repository, of the form '{{repo}}'.\nThe repo name may contain slashes. eg, 'name/with/slash'\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `pubsub_configs` (`list[obj]`): How this repository publishes a change in the repository through Cloud Pub/Sub.\nKeyed by the topic names. When `null`, the `pubsub_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sourcerepo_repository.pubsub_configs.new](#fn-pubsub_configsnew) 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-beta.google_sourcerepo_repository.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 `google_sourcerepo_repository` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, project=null, @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), pubsub_configs:: { - '#new':: d.fn(help='\n`google-beta.google_sourcerepo_repository.pubsub_configs.new` constructs a new object with attributes and blocks configured for the `pubsub_configs`\nTerraform sub block.\n\n\n\n**Args**:\n - `message_format` (`string`): The format of the Cloud Pub/Sub messages. \n- PROTOBUF: The message payload is a serialized protocol buffer of SourceRepoEvent.\n- JSON: The message payload is a JSON string of SourceRepoEvent. Possible values: ["PROTOBUF", "JSON"]\n - `service_account_email` (`string`): Email address of the service account used for publishing Cloud Pub/Sub messages. \nThis service account needs to be in the same project as the PubsubConfig. When added, \nthe caller needs to have iam.serviceAccounts.actAs permission on this service account. \nIf unspecified, it defaults to the compute engine default service account. When `null`, the `service_account_email` field will be omitted from the resulting object.\n - `topic` (`string`): Set the `topic` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `pubsub_configs` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_sourcerepo_repository.pubsub_configs.new` constructs a new object with attributes and blocks configured for the `pubsub_configs`\nTerraform sub block.\n\n\n\n**Args**:\n - `message_format` (`string`): The format of the Cloud Pub/Sub messages.\n- PROTOBUF: The message payload is a serialized protocol buffer of SourceRepoEvent.\n- JSON: The message payload is a JSON string of SourceRepoEvent. Possible values: ["PROTOBUF", "JSON"]\n - `service_account_email` (`string`): Email address of the service account used for publishing Cloud Pub/Sub messages.\nThis service account needs to be in the same project as the PubsubConfig. When added,\nthe caller needs to have iam.serviceAccounts.actAs permission on this service account.\nIf unspecified, it defaults to the compute engine default service account. When `null`, the `service_account_email` field will be omitted from the resulting object.\n - `topic` (`string`): Set the `topic` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `pubsub_configs` sub block.\n', args=[]), new( message_format, topic, diff --git a/4.x/_gen/resources/spanner_instance.libsonnet b/4.x/_gen/resources/spanner_instance.libsonnet index 90312b52..36c64cc0 100644 --- a/4.x/_gen/resources/spanner_instance.libsonnet +++ b/4.x/_gen/resources/spanner_instance.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='google_spanner_instance', url='', help='`google_spanner_instance` represents the `google-beta_google_spanner_instance` 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-beta.google_spanner_instance.new` injects a new `google-beta_google_spanner_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-beta.google_spanner_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_spanner_instance` using the reference:\n\n $._ref.google-beta_google_spanner_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_spanner_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 - `config` (`string`): The name of the instance\u0026#39;s configuration (similar but not\nquite the same as a region) which defines the geographic placement and\nreplication of your databases in this instance. It determines where your data\nis stored. Values are typically of the form \u0026#39;regional-europe-west1\u0026#39; , \u0026#39;us-central\u0026#39; etc.\nIn order to obtain a valid list please consult the\n[Configuration section of the docs](https://cloud.google.com/spanner/docs/instances).\n - `display_name` (`string`): The descriptive name for this instance as it appears in UIs. Must be\nunique per project and between 4 and 30 characters in length.\n - `force_destroy` (`bool`): When deleting a spanner instance, this boolean option will delete all backups of this instance.\nThis must be set to true if you created a backup manually in the console. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `labels` (`obj`): An object containing a list of \u0026#34;key\u0026#34;: 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 - `name` (`string`): A unique identifier for the instance, which cannot be changed after\nthe instance is created. The name must be between 6 and 30 characters\nin length.\n\n\nIf not provided, a random string starting with \u0026#39;tf-\u0026#39; will be selected. When `null`, the `name` field will be omitted from the resulting object.\n - `num_nodes` (`number`): The number of nodes allocated to this instance. Exactly one of either node_count or processing_units\nmust be present in terraform. When `null`, the `num_nodes` field will be omitted from the resulting object.\n - `processing_units` (`number`): The number of processing units allocated to this instance. Exactly one of processing_units \nor node_count must be present in terraform. When `null`, the `processing_units` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_spanner_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-beta.google_spanner_instance.new` injects a new `google-beta_google_spanner_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-beta.google_spanner_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_spanner_instance` using the reference:\n\n $._ref.google-beta_google_spanner_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_spanner_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 - `config` (`string`): The name of the instance\u0026#39;s configuration (similar but not\nquite the same as a region) which defines the geographic placement and\nreplication of your databases in this instance. It determines where your data\nis stored. Values are typically of the form \u0026#39;regional-europe-west1\u0026#39; , \u0026#39;us-central\u0026#39; etc.\nIn order to obtain a valid list please consult the\n[Configuration section of the docs](https://cloud.google.com/spanner/docs/instances).\n - `display_name` (`string`): The descriptive name for this instance as it appears in UIs. Must be\nunique per project and between 4 and 30 characters in length.\n - `force_destroy` (`bool`): When deleting a spanner instance, this boolean option will delete all backups of this instance.\nThis must be set to true if you created a backup manually in the console. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `labels` (`obj`): An object containing a list of \u0026#34;key\u0026#34;: 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 - `name` (`string`): A unique identifier for the instance, which cannot be changed after\nthe instance is created. The name must be between 6 and 30 characters\nin length.\n\n\nIf not provided, a random string starting with \u0026#39;tf-\u0026#39; will be selected. When `null`, the `name` field will be omitted from the resulting object.\n - `num_nodes` (`number`): The number of nodes allocated to this instance. Exactly one of either node_count or processing_units\nmust be present in terraform. When `null`, the `num_nodes` field will be omitted from the resulting object.\n - `processing_units` (`number`): The number of processing units allocated to this instance. Exactly one of processing_units\nor node_count must be present in terraform. When `null`, the `processing_units` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_spanner_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, config, @@ -31,7 +31,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_spanner_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_spanner_instance`\nTerraform resource.\n\nUnlike [google-beta.google_spanner_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 - `config` (`string`): The name of the instance's configuration (similar but not\nquite the same as a region) which defines the geographic placement and\nreplication of your databases in this instance. It determines where your data\nis stored. Values are typically of the form 'regional-europe-west1' , 'us-central' etc.\nIn order to obtain a valid list please consult the\n[Configuration section of the docs](https://cloud.google.com/spanner/docs/instances).\n - `display_name` (`string`): The descriptive name for this instance as it appears in UIs. Must be\nunique per project and between 4 and 30 characters in length.\n - `force_destroy` (`bool`): When deleting a spanner instance, this boolean option will delete all backups of this instance.\nThis must be set to true if you created a backup manually in the console. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `labels` (`obj`): An object containing a 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 - `name` (`string`): A unique identifier for the instance, which cannot be changed after\nthe instance is created. The name must be between 6 and 30 characters\nin length.\n\n\nIf not provided, a random string starting with 'tf-' will be selected. When `null`, the `name` field will be omitted from the resulting object.\n - `num_nodes` (`number`): The number of nodes allocated to this instance. Exactly one of either node_count or processing_units\nmust be present in terraform. When `null`, the `num_nodes` field will be omitted from the resulting object.\n - `processing_units` (`number`): The number of processing units allocated to this instance. Exactly one of processing_units \nor node_count must be present in terraform. When `null`, the `processing_units` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_spanner_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 `google_spanner_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_spanner_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_spanner_instance`\nTerraform resource.\n\nUnlike [google-beta.google_spanner_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 - `config` (`string`): The name of the instance's configuration (similar but not\nquite the same as a region) which defines the geographic placement and\nreplication of your databases in this instance. It determines where your data\nis stored. Values are typically of the form 'regional-europe-west1' , 'us-central' etc.\nIn order to obtain a valid list please consult the\n[Configuration section of the docs](https://cloud.google.com/spanner/docs/instances).\n - `display_name` (`string`): The descriptive name for this instance as it appears in UIs. Must be\nunique per project and between 4 and 30 characters in length.\n - `force_destroy` (`bool`): When deleting a spanner instance, this boolean option will delete all backups of this instance.\nThis must be set to true if you created a backup manually in the console. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `labels` (`obj`): An object containing a 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 - `name` (`string`): A unique identifier for the instance, which cannot be changed after\nthe instance is created. The name must be between 6 and 30 characters\nin length.\n\n\nIf not provided, a random string starting with 'tf-' will be selected. When `null`, the `name` field will be omitted from the resulting object.\n - `num_nodes` (`number`): The number of nodes allocated to this instance. Exactly one of either node_count or processing_units\nmust be present in terraform. When `null`, the `num_nodes` field will be omitted from the resulting object.\n - `processing_units` (`number`): The number of processing units allocated to this instance. Exactly one of processing_units\nor node_count must be present in terraform. When `null`, the `processing_units` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_spanner_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 `google_spanner_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( config, display_name, diff --git a/4.x/_gen/resources/sql_database.libsonnet b/4.x/_gen/resources/sql_database.libsonnet index 2405283c..56c0f3a8 100644 --- a/4.x/_gen/resources/sql_database.libsonnet +++ b/4.x/_gen/resources/sql_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='google_sql_database', url='', help='`google_sql_database` represents the `google-beta_google_sql_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-beta.google_sql_database.new` injects a new `google-beta_google_sql_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-beta.google_sql_database.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_sql_database` using the reference:\n\n $._ref.google-beta_google_sql_database.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_sql_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 - `charset` (`string`): The charset value. See MySQL\u0026#39;s\n[Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html)\nand Postgres\u0026#39; [Character Set Support](https://www.postgresql.org/docs/9.6/static/multibyte.html)\nfor more details and supported values. Postgres databases only support\na value of \u0026#39;UTF8\u0026#39; at creation time. When `null`, the `charset` field will be omitted from the resulting object.\n - `collation` (`string`): The collation value. See MySQL\u0026#39;s\n[Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html)\nand Postgres\u0026#39; [Collation Support](https://www.postgresql.org/docs/9.6/static/collation.html)\nfor more details and supported values. Postgres databases only support\na value of \u0026#39;en_US.UTF8\u0026#39; at creation time. When `null`, the `collation` field will be omitted from the resulting object.\n - `deletion_policy` (`string`): The deletion policy for the database. Setting ABANDON allows the resource \nto be abandoned rather than deleted. This is useful for Postgres, where databases cannot be \ndeleted from the API if there are users other than cloudsqlsuperuser with access. Possible \nvalues are: \u0026#34;ABANDON\u0026#34;, \u0026#34;DELETE\u0026#34;. Defaults to \u0026#34;DELETE\u0026#34;. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `instance` (`string`): The name of the Cloud SQL instance. This does not include the project\nID.\n - `name` (`string`): The name of the database in the Cloud SQL instance.\nThis does not include the project ID or instance name.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sql_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-beta.google_sql_database.new` injects a new `google-beta_google_sql_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-beta.google_sql_database.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_sql_database` using the reference:\n\n $._ref.google-beta_google_sql_database.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_sql_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 - `charset` (`string`): The charset value. See MySQL\u0026#39;s\n[Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html)\nand Postgres\u0026#39; [Character Set Support](https://www.postgresql.org/docs/9.6/static/multibyte.html)\nfor more details and supported values. Postgres databases only support\na value of \u0026#39;UTF8\u0026#39; at creation time. When `null`, the `charset` field will be omitted from the resulting object.\n - `collation` (`string`): The collation value. See MySQL\u0026#39;s\n[Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html)\nand Postgres\u0026#39; [Collation Support](https://www.postgresql.org/docs/9.6/static/collation.html)\nfor more details and supported values. Postgres databases only support\na value of \u0026#39;en_US.UTF8\u0026#39; at creation time. When `null`, the `collation` field will be omitted from the resulting object.\n - `deletion_policy` (`string`): The deletion policy for the database. Setting ABANDON allows the resource\nto be abandoned rather than deleted. This is useful for Postgres, where databases cannot be\ndeleted from the API if there are users other than cloudsqlsuperuser with access. Possible\nvalues are: \u0026#34;ABANDON\u0026#34;, \u0026#34;DELETE\u0026#34;. Defaults to \u0026#34;DELETE\u0026#34;. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `instance` (`string`): The name of the Cloud SQL instance. This does not include the project\nID.\n - `name` (`string`): The name of the database in the Cloud SQL instance.\nThis does not include the project ID or instance name.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sql_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, instance, @@ -27,7 +27,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_sql_database.newAttrs` constructs a new object with attributes and blocks configured for the `google_sql_database`\nTerraform resource.\n\nUnlike [google-beta.google_sql_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 - `charset` (`string`): The charset value. See MySQL's\n[Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html)\nand Postgres' [Character Set Support](https://www.postgresql.org/docs/9.6/static/multibyte.html)\nfor more details and supported values. Postgres databases only support\na value of 'UTF8' at creation time. When `null`, the `charset` field will be omitted from the resulting object.\n - `collation` (`string`): The collation value. See MySQL's\n[Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html)\nand Postgres' [Collation Support](https://www.postgresql.org/docs/9.6/static/collation.html)\nfor more details and supported values. Postgres databases only support\na value of 'en_US.UTF8' at creation time. When `null`, the `collation` field will be omitted from the resulting object.\n - `deletion_policy` (`string`): The deletion policy for the database. Setting ABANDON allows the resource \nto be abandoned rather than deleted. This is useful for Postgres, where databases cannot be \ndeleted from the API if there are users other than cloudsqlsuperuser with access. Possible \nvalues are: "ABANDON", "DELETE". Defaults to "DELETE". When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `instance` (`string`): The name of the Cloud SQL instance. This does not include the project\nID.\n - `name` (`string`): The name of the database in the Cloud SQL instance.\nThis does not include the project ID or instance name.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sql_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 `google_sql_database` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_sql_database.newAttrs` constructs a new object with attributes and blocks configured for the `google_sql_database`\nTerraform resource.\n\nUnlike [google-beta.google_sql_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 - `charset` (`string`): The charset value. See MySQL's\n[Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html)\nand Postgres' [Character Set Support](https://www.postgresql.org/docs/9.6/static/multibyte.html)\nfor more details and supported values. Postgres databases only support\na value of 'UTF8' at creation time. When `null`, the `charset` field will be omitted from the resulting object.\n - `collation` (`string`): The collation value. See MySQL's\n[Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html)\nand Postgres' [Collation Support](https://www.postgresql.org/docs/9.6/static/collation.html)\nfor more details and supported values. Postgres databases only support\na value of 'en_US.UTF8' at creation time. When `null`, the `collation` field will be omitted from the resulting object.\n - `deletion_policy` (`string`): The deletion policy for the database. Setting ABANDON allows the resource\nto be abandoned rather than deleted. This is useful for Postgres, where databases cannot be\ndeleted from the API if there are users other than cloudsqlsuperuser with access. Possible\nvalues are: "ABANDON", "DELETE". Defaults to "DELETE". When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `instance` (`string`): The name of the Cloud SQL instance. This does not include the project\nID.\n - `name` (`string`): The name of the database in the Cloud SQL instance.\nThis does not include the project ID or instance name.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sql_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 `google_sql_database` resource into the root Terraform configuration.\n', args=[]), newAttrs( instance, name, diff --git a/4.x/_gen/resources/sql_source_representation_instance.libsonnet b/4.x/_gen/resources/sql_source_representation_instance.libsonnet index 0a2822db..75302d72 100644 --- a/4.x/_gen/resources/sql_source_representation_instance.libsonnet +++ b/4.x/_gen/resources/sql_source_representation_instance.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='google_sql_source_representation_instance', url='', help='`google_sql_source_representation_instance` represents the `google-beta_google_sql_source_representation_instance` 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-beta.google_sql_source_representation_instance.new` injects a new `google-beta_google_sql_source_representation_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-beta.google_sql_source_representation_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_sql_source_representation_instance` using the reference:\n\n $._ref.google-beta_google_sql_source_representation_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_sql_source_representation_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 - `ca_certificate` (`string`): The CA certificate on the external server. Include only if SSL/TLS is used on the external server. When `null`, the `ca_certificate` field will be omitted from the resulting object.\n - `client_certificate` (`string`): The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_certificate` field will be omitted from the resulting object.\n - `client_key` (`string`): The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_key` field will be omitted from the resulting object.\n - `database_version` (`string`): The MySQL version running on your source database server. Possible values: [\u0026#34;MYSQL_5_5\u0026#34;, \u0026#34;MYSQL_5_6\u0026#34;, \u0026#34;MYSQL_5_7\u0026#34;, \u0026#34;MYSQL_8_0\u0026#34;]\n - `dump_file_path` (`string`): A file in the bucket that contains the data from the external server. When `null`, the `dump_file_path` field will be omitted from the resulting object.\n - `host` (`string`): The externally accessible IPv4 address for the source database server.\n - `name` (`string`): The name of the source representation instance. Use any valid Cloud SQL instance name.\n - `password` (`string`): The password for the replication user account. When `null`, the `password` field will be omitted from the resulting object.\n - `port` (`number`): The externally accessible port for the source database server.\nDefaults to 3306. When `null`, the `port` 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 - `region` (`string`): The Region in which the created instance should reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `username` (`string`): The replication user account on the external server. When `null`, the `username` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sql_source_representation_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-beta.google_sql_source_representation_instance.new` injects a new `google-beta_google_sql_source_representation_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-beta.google_sql_source_representation_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_sql_source_representation_instance` using the reference:\n\n $._ref.google-beta_google_sql_source_representation_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_sql_source_representation_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 - `ca_certificate` (`string`): The CA certificate on the external server. Include only if SSL/TLS is used on the external server. When `null`, the `ca_certificate` field will be omitted from the resulting object.\n - `client_certificate` (`string`): The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_certificate` field will be omitted from the resulting object.\n - `client_key` (`string`): The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_key` field will be omitted from the resulting object.\n - `database_version` (`string`): The MySQL version running on your source database server. Possible values: [\u0026#34;MYSQL_5_6\u0026#34;, \u0026#34;MYSQL_5_7\u0026#34;, \u0026#34;MYSQL_8_0\u0026#34;, \u0026#34;POSTGRES_9_6\u0026#34;, \u0026#34;POSTGRES_10\u0026#34;, \u0026#34;POSTGRES_11\u0026#34;, \u0026#34;POSTGRES_12\u0026#34;, \u0026#34;POSTGRES_13\u0026#34;, \u0026#34;POSTGRES_14\u0026#34;]\n - `dump_file_path` (`string`): A file in the bucket that contains the data from the external server. When `null`, the `dump_file_path` field will be omitted from the resulting object.\n - `host` (`string`): The externally accessible IPv4 address for the source database server.\n - `name` (`string`): The name of the source representation instance. Use any valid Cloud SQL instance name.\n - `password` (`string`): The password for the replication user account. When `null`, the `password` field will be omitted from the resulting object.\n - `port` (`number`): The externally accessible port for the source database server.\nDefaults to 3306. When `null`, the `port` 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 - `region` (`string`): The Region in which the created instance should reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `username` (`string`): The replication user account on the external server. When `null`, the `username` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sql_source_representation_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, database_version, @@ -39,7 +39,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_sql_source_representation_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_sql_source_representation_instance`\nTerraform resource.\n\nUnlike [google-beta.google_sql_source_representation_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 - `ca_certificate` (`string`): The CA certificate on the external server. Include only if SSL/TLS is used on the external server. When `null`, the `ca_certificate` field will be omitted from the resulting object.\n - `client_certificate` (`string`): The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_certificate` field will be omitted from the resulting object.\n - `client_key` (`string`): The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_key` field will be omitted from the resulting object.\n - `database_version` (`string`): The MySQL version running on your source database server. Possible values: ["MYSQL_5_5", "MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0"]\n - `dump_file_path` (`string`): A file in the bucket that contains the data from the external server. When `null`, the `dump_file_path` field will be omitted from the resulting object.\n - `host` (`string`): The externally accessible IPv4 address for the source database server.\n - `name` (`string`): The name of the source representation instance. Use any valid Cloud SQL instance name.\n - `password` (`string`): The password for the replication user account. When `null`, the `password` field will be omitted from the resulting object.\n - `port` (`number`): The externally accessible port for the source database server.\nDefaults to 3306. When `null`, the `port` 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 - `region` (`string`): The Region in which the created instance should reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `username` (`string`): The replication user account on the external server. When `null`, the `username` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sql_source_representation_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 `google_sql_source_representation_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_sql_source_representation_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_sql_source_representation_instance`\nTerraform resource.\n\nUnlike [google-beta.google_sql_source_representation_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 - `ca_certificate` (`string`): The CA certificate on the external server. Include only if SSL/TLS is used on the external server. When `null`, the `ca_certificate` field will be omitted from the resulting object.\n - `client_certificate` (`string`): The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_certificate` field will be omitted from the resulting object.\n - `client_key` (`string`): The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_key` field will be omitted from the resulting object.\n - `database_version` (`string`): The MySQL version running on your source database server. Possible values: ["MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0", "POSTGRES_9_6", "POSTGRES_10", "POSTGRES_11", "POSTGRES_12", "POSTGRES_13", "POSTGRES_14"]\n - `dump_file_path` (`string`): A file in the bucket that contains the data from the external server. When `null`, the `dump_file_path` field will be omitted from the resulting object.\n - `host` (`string`): The externally accessible IPv4 address for the source database server.\n - `name` (`string`): The name of the source representation instance. Use any valid Cloud SQL instance name.\n - `password` (`string`): The password for the replication user account. When `null`, the `password` field will be omitted from the resulting object.\n - `port` (`number`): The externally accessible port for the source database server.\nDefaults to 3306. When `null`, the `port` 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 - `region` (`string`): The Region in which the created instance should reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `username` (`string`): The replication user account on the external server. When `null`, the `username` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sql_source_representation_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 `google_sql_source_representation_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( database_version, host, diff --git a/4.x/_gen/resources/vertex_ai_endpoint.libsonnet b/4.x/_gen/resources/vertex_ai_endpoint.libsonnet index 66f399c6..6b78b9b6 100644 --- a/4.x/_gen/resources/vertex_ai_endpoint.libsonnet +++ b/4.x/_gen/resources/vertex_ai_endpoint.libsonnet @@ -10,7 +10,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); kms_key_name: kms_key_name, }), }, - '#new':: d.fn(help="\n`google-beta.google_vertex_ai_endpoint.new` injects a new `google-beta_google_vertex_ai_endpoint` 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-beta.google_vertex_ai_endpoint.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_vertex_ai_endpoint` using the reference:\n\n $._ref.google-beta_google_vertex_ai_endpoint.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_vertex_ai_endpoint.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`): The description of the Endpoint. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n - `labels` (`obj`): The labels with user-defined metadata to organize your Endpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The resource name of the Endpoint. The name must be numeric with no leading zeros and can be at most 10 digits.\n - `network` (`string`): The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): \u0026#39;projects/{project}/global/networks/{network}\u0026#39;. Where \u0026#39;{project}\u0026#39; is a project number, as in \u0026#39;12345\u0026#39;, and \u0026#39;{network}\u0026#39; is network name. 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 - `encryption_spec` (`list[obj]`): Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key. When `null`, the `encryption_spec` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_vertex_ai_endpoint.encryption_spec.new](#fn-encryption_specnew) 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-beta.google_vertex_ai_endpoint.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-beta.google_vertex_ai_endpoint.new` injects a new `google-beta_google_vertex_ai_endpoint` 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-beta.google_vertex_ai_endpoint.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_vertex_ai_endpoint` using the reference:\n\n $._ref.google-beta_google_vertex_ai_endpoint.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_vertex_ai_endpoint.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`): The description of the Endpoint. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n - `labels` (`obj`): The labels with user-defined metadata to organize your Endpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The resource name of the Endpoint. The name must be numeric with no leading zeros and can be at most 10 digits.\n - `network` (`string`): The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): \u0026#39;projects/{project}/global/networks/{network}\u0026#39;. Where \u0026#39;{project}\u0026#39; is a project number, as in \u0026#39;12345\u0026#39;, and \u0026#39;{network}\u0026#39; is network name. 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 - `region` (`string`): The region for the resource When `null`, the `region` field will be omitted from the resulting object.\n - `encryption_spec` (`list[obj]`): Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key. When `null`, the `encryption_spec` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_vertex_ai_endpoint.encryption_spec.new](#fn-encryption_specnew) 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-beta.google_vertex_ai_endpoint.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, @@ -21,6 +21,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); labels=null, network=null, project=null, + region=null, timeouts=null, _meta={} ):: tf.withResource( @@ -35,11 +36,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); name=name, network=network, project=project, + region=region, timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_vertex_ai_endpoint.newAttrs` constructs a new object with attributes and blocks configured for the `google_vertex_ai_endpoint`\nTerraform resource.\n\nUnlike [google-beta.google_vertex_ai_endpoint.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`): The description of the Endpoint. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n - `labels` (`obj`): The labels with user-defined metadata to organize your Endpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The resource name of the Endpoint. The name must be numeric with no leading zeros and can be at most 10 digits.\n - `network` (`string`): The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): 'projects/{project}/global/networks/{network}'. Where '{project}' is a project number, as in '12345', and '{network}' is network name. 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 - `encryption_spec` (`list[obj]`): Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key. When `null`, the `encryption_spec` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_vertex_ai_endpoint.encryption_spec.new](#fn-encryption_specnew) 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-beta.google_vertex_ai_endpoint.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 `google_vertex_ai_endpoint` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_vertex_ai_endpoint.newAttrs` constructs a new object with attributes and blocks configured for the `google_vertex_ai_endpoint`\nTerraform resource.\n\nUnlike [google-beta.google_vertex_ai_endpoint.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`): The description of the Endpoint. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n - `labels` (`obj`): The labels with user-defined metadata to organize your Endpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The resource name of the Endpoint. The name must be numeric with no leading zeros and can be at most 10 digits.\n - `network` (`string`): The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): 'projects/{project}/global/networks/{network}'. Where '{project}' is a project number, as in '12345', and '{network}' is network name. 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 - `region` (`string`): The region for the resource When `null`, the `region` field will be omitted from the resulting object.\n - `encryption_spec` (`list[obj]`): Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key. When `null`, the `encryption_spec` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_vertex_ai_endpoint.encryption_spec.new](#fn-encryption_specnew) 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-beta.google_vertex_ai_endpoint.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 `google_vertex_ai_endpoint` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, location, @@ -49,6 +51,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); labels=null, network=null, project=null, + region=null, timeouts=null ):: std.prune(a={ description: description, @@ -59,6 +62,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); name: name, network: network, project: project, + region: region, timeouts: timeouts, }), timeouts:: { @@ -163,6 +167,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withRegion':: d.fn(help='`google-beta.string.withRegion` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the region field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `region` field.\n', args=[]), + withRegion(resourceLabel, value): { + resource+: { + google_vertex_ai_endpoint+: { + [resourceLabel]+: { + region: value, + }, + }, + }, + }, '#withTimeouts':: d.fn(help='`google-beta.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-beta.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/vertex_ai_index.libsonnet b/4.x/_gen/resources/vertex_ai_index.libsonnet index bcb66400..c3c52ccf 100644 --- a/4.x/_gen/resources/vertex_ai_index.libsonnet +++ b/4.x/_gen/resources/vertex_ai_index.libsonnet @@ -30,7 +30,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google-beta.google_vertex_ai_index.metadata.config.new` constructs a new object with attributes and blocks configured for the `config`\nTerraform sub block.\n\n\n\n**Args**:\n - `approximate_neighbors_count` (`number`): The default number of neighbors to find via approximate search before exact reordering is\nperformed. Exact reordering is a procedure where results returned by an\napproximate search algorithm are reordered via a more expensive distance computation.\nRequired if tree-AH algorithm is used. When `null`, the `approximate_neighbors_count` field will be omitted from the resulting object.\n - `dimensions` (`number`): The number of dimensions of the input vectors.\n - `distance_measure_type` (`string`): The distance measure used in nearest neighbor search. The value must be one of the followings:\n* SQUARED_L2_DISTANCE: Euclidean (L_2) Distance\n* L1_DISTANCE: Manhattan (L_1) Distance\n* COSINE_DISTANCE: Cosine Distance. Defined as 1 - cosine similarity.\n* DOT_PRODUCT_DISTANCE: Dot Product Distance. Defined as a negative of the dot product When `null`, the `distance_measure_type` field will be omitted from the resulting object.\n - `feature_norm_type` (`string`): Type of normalization to be carried out on each vector. The value must be one of the followings: \n* UNIT_L2_NORM: Unit L2 normalization type\n* NONE: No normalization type is specified. When `null`, the `feature_norm_type` field will be omitted from the resulting object.\n - `algorithm_config` (`list[obj]`): The configuration with regard to the algorithms used for efficient search. When `null`, the `algorithm_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-beta.google_vertex_ai_index.metadata.config.algorithm_config.new](#fn-metadatametadataalgorithm_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_vertex_ai_index.metadata.config.new` constructs a new object with attributes and blocks configured for the `config`\nTerraform sub block.\n\n\n\n**Args**:\n - `approximate_neighbors_count` (`number`): The default number of neighbors to find via approximate search before exact reordering is\nperformed. Exact reordering is a procedure where results returned by an\napproximate search algorithm are reordered via a more expensive distance computation.\nRequired if tree-AH algorithm is used. When `null`, the `approximate_neighbors_count` field will be omitted from the resulting object.\n - `dimensions` (`number`): The number of dimensions of the input vectors.\n - `distance_measure_type` (`string`): The distance measure used in nearest neighbor search. The value must be one of the followings:\n* SQUARED_L2_DISTANCE: Euclidean (L_2) Distance\n* L1_DISTANCE: Manhattan (L_1) Distance\n* COSINE_DISTANCE: Cosine Distance. Defined as 1 - cosine similarity.\n* DOT_PRODUCT_DISTANCE: Dot Product Distance. Defined as a negative of the dot product When `null`, the `distance_measure_type` field will be omitted from the resulting object.\n - `feature_norm_type` (`string`): Type of normalization to be carried out on each vector. The value must be one of the followings:\n* UNIT_L2_NORM: Unit L2 normalization type\n* NONE: No normalization type is specified. When `null`, the `feature_norm_type` field will be omitted from the resulting object.\n - `algorithm_config` (`list[obj]`): The configuration with regard to the algorithms used for efficient search. When `null`, the `algorithm_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-beta.google_vertex_ai_index.metadata.config.algorithm_config.new](#fn-metadatametadataalgorithm_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `config` sub block.\n', args=[]), new( dimensions, algorithm_config=null, diff --git a/4.x/_gen/resources/workflows_workflow.libsonnet b/4.x/_gen/resources/workflows_workflow.libsonnet index 249ab731..43753cd1 100644 --- a/4.x/_gen/resources/workflows_workflow.libsonnet +++ b/4.x/_gen/resources/workflows_workflow.libsonnet @@ -2,9 +2,10 @@ 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='google_workflows_workflow', url='', help='`google_workflows_workflow` represents the `google-beta_google_workflows_workflow` 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-beta.google_workflows_workflow.new` injects a new `google-beta_google_workflows_workflow` 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-beta.google_workflows_workflow.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workflows_workflow` using the reference:\n\n $._ref.google-beta_google_workflows_workflow.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workflows_workflow.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): Description of the workflow provided by the user. Must be at most 1000 unicode characters long. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Workflow. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Workflow. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` 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 - `region` (`string`): The region of the workflow. When `null`, the `region` field will be omitted from the resulting object.\n - `service_account` (`string`): Name of the service account associated with the latest workflow version. This service\naccount represents the identity of the workflow and determines what permissions the workflow has.\n\nFormat: projects/{project}/serviceAccounts/{account}. When `null`, the `service_account` field will be omitted from the resulting object.\n - `source_contents` (`string`): Workflow code to be executed. The size limit is 32KB. When `null`, the `source_contents` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workflows_workflow.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-beta.google_workflows_workflow.new` injects a new `google-beta_google_workflows_workflow` 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-beta.google_workflows_workflow.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workflows_workflow` using the reference:\n\n $._ref.google-beta_google_workflows_workflow.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workflows_workflow.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 - `crypto_key_name` (`string`): The KMS key used to encrypt workflow and execution data.\n\nFormat: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} When `null`, the `crypto_key_name` field will be omitted from the resulting object.\n - `description` (`string`): Description of the workflow provided by the user. Must be at most 1000 unicode characters long. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Workflow. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Workflow. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` 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 - `region` (`string`): The region of the workflow. When `null`, the `region` field will be omitted from the resulting object.\n - `service_account` (`string`): Name of the service account associated with the latest workflow version. This service\naccount represents the identity of the workflow and determines what permissions the workflow has.\nFormat: projects/{project}/serviceAccounts/{account} or {account}.\nUsing - as a wildcard for the {project} or not providing one at all will infer the project from the account.\nThe {account} value can be the email address or the unique_id of the service account.\nIf not provided, workflow will use the project\u0026#39;s default service account.\nModifying this field for an existing workflow results in a new workflow revision. When `null`, the `service_account` field will be omitted from the resulting object.\n - `source_contents` (`string`): Workflow code to be executed. The size limit is 32KB. When `null`, the `source_contents` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workflows_workflow.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, + crypto_key_name=null, description=null, labels=null, name=null, @@ -19,6 +20,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='google_workflows_workflow', label=resourceLabel, attrs=self.newAttrs( + crypto_key_name=crypto_key_name, description=description, labels=labels, name=name, @@ -31,8 +33,9 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_workflows_workflow.newAttrs` constructs a new object with attributes and blocks configured for the `google_workflows_workflow`\nTerraform resource.\n\nUnlike [google-beta.google_workflows_workflow.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): Description of the workflow provided by the user. Must be at most 1000 unicode characters long. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Workflow. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Workflow. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` 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 - `region` (`string`): The region of the workflow. When `null`, the `region` field will be omitted from the resulting object.\n - `service_account` (`string`): Name of the service account associated with the latest workflow version. This service\naccount represents the identity of the workflow and determines what permissions the workflow has.\n\nFormat: projects/{project}/serviceAccounts/{account}. When `null`, the `service_account` field will be omitted from the resulting object.\n - `source_contents` (`string`): Workflow code to be executed. The size limit is 32KB. When `null`, the `source_contents` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workflows_workflow.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 `google_workflows_workflow` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_workflows_workflow.newAttrs` constructs a new object with attributes and blocks configured for the `google_workflows_workflow`\nTerraform resource.\n\nUnlike [google-beta.google_workflows_workflow.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 - `crypto_key_name` (`string`): The KMS key used to encrypt workflow and execution data.\n\nFormat: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} When `null`, the `crypto_key_name` field will be omitted from the resulting object.\n - `description` (`string`): Description of the workflow provided by the user. Must be at most 1000 unicode characters long. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Workflow. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the Workflow. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` 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 - `region` (`string`): The region of the workflow. When `null`, the `region` field will be omitted from the resulting object.\n - `service_account` (`string`): Name of the service account associated with the latest workflow version. This service\naccount represents the identity of the workflow and determines what permissions the workflow has.\nFormat: projects/{project}/serviceAccounts/{account} or {account}.\nUsing - as a wildcard for the {project} or not providing one at all will infer the project from the account.\nThe {account} value can be the email address or the unique_id of the service account.\nIf not provided, workflow will use the project's default service account.\nModifying this field for an existing workflow results in a new workflow revision. When `null`, the `service_account` field will be omitted from the resulting object.\n - `source_contents` (`string`): Workflow code to be executed. The size limit is 32KB. When `null`, the `source_contents` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workflows_workflow.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 `google_workflows_workflow` resource into the root Terraform configuration.\n', args=[]), newAttrs( + crypto_key_name=null, description=null, labels=null, name=null, @@ -43,6 +46,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); source_contents=null, timeouts=null ):: std.prune(a={ + crypto_key_name: crypto_key_name, description: description, labels: labels, name: name, @@ -65,6 +69,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withCryptoKeyName':: d.fn(help='`google-beta.string.withCryptoKeyName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the crypto_key_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 `crypto_key_name` field.\n', args=[]), + withCryptoKeyName(resourceLabel, value): { + resource+: { + google_workflows_workflow+: { + [resourceLabel]+: { + crypto_key_name: value, + }, + }, + }, + }, '#withDescription':: d.fn(help='`google-beta.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+: { diff --git a/4.x/_gen/resources/workstations_workstation.libsonnet b/4.x/_gen/resources/workstations_workstation.libsonnet index d3afdfab..8a5d2aaa 100644 --- a/4.x/_gen/resources/workstations_workstation.libsonnet +++ b/4.x/_gen/resources/workstations_workstation.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='google_workstations_workstation', url='', help='`google_workstations_workstation` represents the `google-beta_google_workstations_workstation` 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-beta.google_workstations_workstation.new` injects a new `google-beta_google_workstations_workstation` 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-beta.google_workstations_workstation.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation` using the reference:\n\n $._ref.google-beta_google_workstations_workstation.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation.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`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation cluster config should reside.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `workstation_cluster_id` (`string`): The name of the workstation cluster.\n - `workstation_config_id` (`string`): The ID of the workstation cluster config.\n - `workstation_id` (`string`): ID to use for the workstation.\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-beta.google_workstations_workstation.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-beta.google_workstations_workstation.new` injects a new `google-beta_google_workstations_workstation` 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-beta.google_workstations_workstation.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation` using the reference:\n\n $._ref.google-beta_google_workstations_workstation.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation.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`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation parent resources reside.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `workstation_cluster_id` (`string`): The ID of the parent workstation cluster.\n - `workstation_config_id` (`string`): The ID of the parent workstation cluster config.\n - `workstation_id` (`string`): ID to use for the workstation.\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-beta.google_workstations_workstation.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, @@ -31,7 +31,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation.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`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation cluster config should reside.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `workstation_cluster_id` (`string`): The name of the workstation cluster.\n - `workstation_config_id` (`string`): The ID of the workstation cluster config.\n - `workstation_id` (`string`): ID to use for the workstation.\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-beta.google_workstations_workstation.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 `google_workstations_workstation` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation.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`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation parent resources reside.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `workstation_cluster_id` (`string`): The ID of the parent workstation cluster.\n - `workstation_config_id` (`string`): The ID of the parent workstation cluster config.\n - `workstation_id` (`string`): ID to use for the workstation.\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-beta.google_workstations_workstation.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 `google_workstations_workstation` resource into the root Terraform configuration.\n', args=[]), newAttrs( location, workstation_cluster_id, diff --git a/4.x/_gen/resources/workstations_workstation_cluster.libsonnet b/4.x/_gen/resources/workstations_workstation_cluster.libsonnet index 3367bb54..86d3254c 100644 --- a/4.x/_gen/resources/workstations_workstation_cluster.libsonnet +++ b/4.x/_gen/resources/workstations_workstation_cluster.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='google_workstations_workstation_cluster', url='', help='`google_workstations_workstation_cluster` represents the `google-beta_google_workstations_workstation_cluster` 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-beta.google_workstations_workstation_cluster.new` injects a new `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_cluster` using the reference:\n\n $._ref.google-beta_google_workstations_workstation_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `annotations` (`obj`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation cluster should reside. When `null`, the `location` field will be omitted from the resulting object.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. \nIt is specified in the following form: \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 - `subnetwork` (`string`): Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. \nMust be part of the subnetwork specified for this cluster.\n - `workstation_cluster_id` (`string`): The ID of the workstation cluster.\n - `private_cluster_config` (`list[obj]`): Configuration for private cluster. 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-beta.google_workstations_workstation_cluster.private_cluster_config.new](#fn-private_cluster_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-beta.google_workstations_workstation_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_workstations_workstation_cluster.new` injects a new `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_cluster` using the reference:\n\n $._ref.google-beta_google_workstations_workstation_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `annotations` (`obj`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation cluster should reside. When `null`, the `location` field will be omitted from the resulting object.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed.\nIt is specified in the following form: \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 - `subnetwork` (`string`): Name of the Compute Engine subnetwork in which instances associated with this cluster will be created.\nMust be part of the subnetwork specified for this cluster.\n - `workstation_cluster_id` (`string`): ID to use for the workstation cluster.\n - `private_cluster_config` (`list[obj]`): Configuration for private cluster. 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-beta.google_workstations_workstation_cluster.private_cluster_config.new](#fn-private_cluster_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-beta.google_workstations_workstation_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, network, @@ -33,7 +33,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_cluster`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `annotations` (`obj`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation cluster should reside. When `null`, the `location` field will be omitted from the resulting object.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. \nIt is specified in the following form: "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 - `subnetwork` (`string`): Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. \nMust be part of the subnetwork specified for this cluster.\n - `workstation_cluster_id` (`string`): The ID of the workstation cluster.\n - `private_cluster_config` (`list[obj]`): Configuration for private cluster. 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-beta.google_workstations_workstation_cluster.private_cluster_config.new](#fn-private_cluster_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-beta.google_workstations_workstation_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 `google_workstations_workstation_cluster` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_cluster`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `annotations` (`obj`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation cluster should reside. When `null`, the `location` field will be omitted from the resulting object.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed.\nIt is specified in the following form: "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 - `subnetwork` (`string`): Name of the Compute Engine subnetwork in which instances associated with this cluster will be created.\nMust be part of the subnetwork specified for this cluster.\n - `workstation_cluster_id` (`string`): ID to use for the workstation cluster.\n - `private_cluster_config` (`list[obj]`): Configuration for private cluster. 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-beta.google_workstations_workstation_cluster.private_cluster_config.new](#fn-private_cluster_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-beta.google_workstations_workstation_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 `google_workstations_workstation_cluster` resource into the root Terraform configuration.\n', args=[]), newAttrs( network, subnetwork, diff --git a/4.x/_gen/resources/workstations_workstation_config.libsonnet b/4.x/_gen/resources/workstations_workstation_config.libsonnet index 8dfe2f66..1425601d 100644 --- a/4.x/_gen/resources/workstations_workstation_config.libsonnet +++ b/4.x/_gen/resources/workstations_workstation_config.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_workstations_workstation_config', url='', help='`google_workstations_workstation_config` represents the `google-beta_google_workstations_workstation_config` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), container:: { - '#new':: d.fn(help='\n`google-beta.google_workstations_workstation_config.container.new` constructs a new object with attributes and blocks configured for the `container`\nTerraform sub block.\n\n\n\n**Args**:\n - `args` (`list`): Arguments passed to the entrypoint. When `null`, the `args` field will be omitted from the resulting object.\n - `command` (`list`): If set, overrides the default ENTRYPOINT specified by the image. When `null`, the `command` field will be omitted from the resulting object.\n - `env` (`obj`): Environment variables passed to the container.\nThe elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". When `null`, the `env` field will be omitted from the resulting object.\n - `image` (`string`): Docker image defining the container. This image must be accessible by the config"s service account. When `null`, the `image` field will be omitted from the resulting object.\n - `run_as_user` (`number`): If set, overrides the USER specified in the image with the given uid. When `null`, the `run_as_user` field will be omitted from the resulting object.\n - `working_dir` (`string`): If set, overrides the default DIR specified by the image. When `null`, the `working_dir` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `container` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_workstations_workstation_config.container.new` constructs a new object with attributes and blocks configured for the `container`\nTerraform sub block.\n\n\n\n**Args**:\n - `args` (`list`): Arguments passed to the entrypoint. When `null`, the `args` field will be omitted from the resulting object.\n - `command` (`list`): If set, overrides the default ENTRYPOINT specified by the image. When `null`, the `command` field will be omitted from the resulting object.\n - `env` (`obj`): Environment variables passed to the container.\nThe elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". When `null`, the `env` field will be omitted from the resulting object.\n - `image` (`string`): Docker image defining the container. This image must be accessible by the config's service account. When `null`, the `image` field will be omitted from the resulting object.\n - `run_as_user` (`number`): If set, overrides the USER specified in the image with the given uid. When `null`, the `run_as_user` field will be omitted from the resulting object.\n - `working_dir` (`string`): If set, overrides the default DIR specified by the image. When `null`, the `working_dir` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `container` sub block.\n', args=[]), new( args=null, command=null, @@ -73,14 +73,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`google-beta.google_workstations_workstation_config.host.new` constructs a new object with attributes and blocks configured for the `host`\nTerraform sub block.\n\n\n\n**Args**:\n - `gce_instance` (`list[obj]`): Specifies a Compute Engine instance as the host. When `null`, the `gce_instance` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.gce_instance.new](#fn-hostgce_instancenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `host` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_workstations_workstation_config.host.new` constructs a new object with attributes and blocks configured for the `host`\nTerraform sub block.\n\n\n\n**Args**:\n - `gce_instance` (`list[obj]`): A runtime using a Compute Engine instance. When `null`, the `gce_instance` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.gce_instance.new](#fn-hostgce_instancenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `host` sub block.\n', args=[]), new( gce_instance=null ):: std.prune(a={ gce_instance: gce_instance, }), }, - '#new':: d.fn(help="\n`google-beta.google_workstations_workstation_config.new` injects a new `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_config` using the reference:\n\n $._ref.google-beta_google_workstations_workstation_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation_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 - `annotations` (`obj`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation cluster config should reside.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `workstation_cluster_id` (`string`): The name of the workstation cluster.\n - `workstation_config_id` (`string`): The ID of the workstation cluster config.\n - `container` (`list[obj]`): Container that will be run for each workstation using this configuration when that workstation is started. When `null`, the `container` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.container.new](#fn-containernew) constructor.\n - `encryption_key` (`list[obj]`): Encrypts resources of this workstation configuration using a customer-managed encryption key.\n\nIf specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata.\nIf the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost.\nIf the encryption key is revoked, the workstation session will automatically be stopped within 7 hours. When `null`, the `encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.encryption_key.new](#fn-encryption_keynew) constructor.\n - `host` (`list[obj]`): Runtime host for a workstation. When `null`, the `host` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.new](#fn-hostnew) constructor.\n - `persistent_directories` (`list[obj]`): Directories to persist across workstation sessions. When `null`, the `persistent_directories` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.persistent_directories.new](#fn-persistent_directoriesnew) 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-beta.google_workstations_workstation_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-beta.google_workstations_workstation_config.new` injects a new `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_config` using the reference:\n\n $._ref.google-beta_google_workstations_workstation_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation_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 - `annotations` (`obj`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation cluster config should reside.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `workstation_cluster_id` (`string`): The ID of the parent workstation cluster.\n - `workstation_config_id` (`string`): The ID to be assigned to the workstation cluster config.\n - `container` (`list[obj]`): Container that will be run for each workstation using this configuration when that workstation is started. When `null`, the `container` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.container.new](#fn-containernew) constructor.\n - `encryption_key` (`list[obj]`): Encrypts resources of this workstation configuration using a customer-managed encryption key.\n\nIf specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata.\nIf the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost.\nIf the encryption key is revoked, the workstation session will automatically be stopped within 7 hours. When `null`, the `encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.encryption_key.new](#fn-encryption_keynew) constructor.\n - `host` (`list[obj]`): Runtime host for a workstation. When `null`, the `host` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.new](#fn-hostnew) constructor.\n - `persistent_directories` (`list[obj]`): Directories to persist across workstation sessions. When `null`, the `persistent_directories` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.persistent_directories.new](#fn-persistent_directoriesnew) 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-beta.google_workstations_workstation_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, location, @@ -115,7 +115,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation_config.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_config`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation_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 - `annotations` (`obj`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation cluster config should reside.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `workstation_cluster_id` (`string`): The name of the workstation cluster.\n - `workstation_config_id` (`string`): The ID of the workstation cluster config.\n - `container` (`list[obj]`): Container that will be run for each workstation using this configuration when that workstation is started. When `null`, the `container` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.container.new](#fn-containernew) constructor.\n - `encryption_key` (`list[obj]`): Encrypts resources of this workstation configuration using a customer-managed encryption key.\n\nIf specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata.\nIf the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost.\nIf the encryption key is revoked, the workstation session will automatically be stopped within 7 hours. When `null`, the `encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.encryption_key.new](#fn-encryption_keynew) constructor.\n - `host` (`list[obj]`): Runtime host for a workstation. When `null`, the `host` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.new](#fn-hostnew) constructor.\n - `persistent_directories` (`list[obj]`): Directories to persist across workstation sessions. When `null`, the `persistent_directories` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.persistent_directories.new](#fn-persistent_directoriesnew) 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-beta.google_workstations_workstation_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 `google_workstations_workstation_config` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation_config.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_config`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation_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 - `annotations` (`obj`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the workstation cluster config should reside.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `workstation_cluster_id` (`string`): The ID of the parent workstation cluster.\n - `workstation_config_id` (`string`): The ID to be assigned to the workstation cluster config.\n - `container` (`list[obj]`): Container that will be run for each workstation using this configuration when that workstation is started. When `null`, the `container` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.container.new](#fn-containernew) constructor.\n - `encryption_key` (`list[obj]`): Encrypts resources of this workstation configuration using a customer-managed encryption key.\n\nIf specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata.\nIf the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost.\nIf the encryption key is revoked, the workstation session will automatically be stopped within 7 hours. When `null`, the `encryption_key` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.encryption_key.new](#fn-encryption_keynew) constructor.\n - `host` (`list[obj]`): Runtime host for a workstation. When `null`, the `host` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.new](#fn-hostnew) constructor.\n - `persistent_directories` (`list[obj]`): Directories to persist across workstation sessions. When `null`, the `persistent_directories` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.persistent_directories.new](#fn-persistent_directoriesnew) 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-beta.google_workstations_workstation_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 `google_workstations_workstation_config` resource into the root Terraform configuration.\n', args=[]), newAttrs( location, workstation_cluster_id, @@ -145,7 +145,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), persistent_directories:: { gce_pd:: { - '#new':: d.fn(help='\n`google-beta.google_workstations_workstation_config.persistent_directories.gce_pd.new` constructs a new object with attributes and blocks configured for the `gce_pd`\nTerraform sub block.\n\n\n\n**Args**:\n - `disk_type` (`string`): Type of the disk to use. When `null`, the `disk_type` field will be omitted from the resulting object.\n - `fs_type` (`string`): Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if sourceSnapshot is set. When `null`, the `fs_type` field will be omitted from the resulting object.\n - `reclaim_policy` (`string`): What should happen to the disk after the workstation is deleted. Defaults to DELETE. Possible values: ["RECLAIM_POLICY_UNSPECIFIED", "DELETE", "RETAIN"] When `null`, the `reclaim_policy` field will be omitted from the resulting object.\n - `size_gb` (`number`): Size of the disk in GB. Must be empty if sourceSnapshot is set. When `null`, the `size_gb` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `gce_pd` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_workstations_workstation_config.persistent_directories.gce_pd.new` constructs a new object with attributes and blocks configured for the `gce_pd`\nTerraform sub block.\n\n\n\n**Args**:\n - `disk_type` (`string`): Type of the disk to use. When `null`, the `disk_type` field will be omitted from the resulting object.\n - `fs_type` (`string`): Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if sourceSnapshot is set. When `null`, the `fs_type` field will be omitted from the resulting object.\n - `reclaim_policy` (`string`): What should happen to the disk after the workstation is deleted. Defaults to DELETE. Possible values: ["DELETE", "RETAIN"] When `null`, the `reclaim_policy` field will be omitted from the resulting object.\n - `size_gb` (`number`): Size of the disk in GB. Must be empty if sourceSnapshot is set. When `null`, the `size_gb` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `gce_pd` sub block.\n', args=[]), new( disk_type=null, fs_type=null, diff --git a/4.x/_gen/resources/workstations_workstation_config_iam_binding.libsonnet b/4.x/_gen/resources/workstations_workstation_config_iam_binding.libsonnet new file mode 100644 index 00000000..5acfb332 --- /dev/null +++ b/4.x/_gen/resources/workstations_workstation_config_iam_binding.libsonnet @@ -0,0 +1,140 @@ +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='google_workstations_workstation_config_iam_binding', url='', help='`google_workstations_workstation_config_iam_binding` represents the `google-beta_google_workstations_workstation_config_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-beta.google_workstations_workstation_config_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-beta.google_workstations_workstation_config_iam_binding.new` injects a new `google-beta_google_workstations_workstation_config_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-beta.google_workstations_workstation_config_iam_binding.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_config_iam_binding` using the reference:\n\n $._ref.google-beta_google_workstations_workstation_config_iam_binding.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation_config_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` 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-beta.google_workstations_workstation_config_iam_binding.condition.new](#fn-conditionnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + members, + role, + workstation_cluster_id, + workstation_config_id, + condition=null, + location=null, + project=null, + _meta={} + ):: tf.withResource( + type='google_workstations_workstation_config_iam_binding', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + location=location, + members=members, + project=project, + role=role, + workstation_cluster_id=workstation_cluster_id, + workstation_config_id=workstation_config_id + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation_config_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_config_iam_binding`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation_config_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` 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-beta.google_workstations_workstation_config_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 `google_workstations_workstation_config_iam_binding` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + members, + role, + workstation_cluster_id, + workstation_config_id, + condition=null, + location=null, + project=null + ):: std.prune(a={ + condition: condition, + location: location, + members: members, + project: project, + role: role, + workstation_cluster_id: workstation_cluster_id, + workstation_config_id: workstation_config_id, + }), + '#withCondition':: d.fn(help='`google-beta.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-beta.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_workstations_workstation_config_iam_binding+: { + [resourceLabel]+: { + condition: value, + }, + }, + }, + }, + '#withConditionMixin':: d.fn(help='`google-beta.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-beta.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_workstations_workstation_config_iam_binding+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google-beta.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_workstations_workstation_config_iam_binding+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withMembers':: d.fn(help='`google-beta.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_workstations_workstation_config_iam_binding+: { + [resourceLabel]+: { + members: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_workstations_workstation_config_iam_binding+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google-beta.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_workstations_workstation_config_iam_binding+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, + '#withWorkstationClusterId':: d.fn(help='`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_cluster_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 `workstation_cluster_id` field.\n', args=[]), + withWorkstationClusterId(resourceLabel, value): { + resource+: { + google_workstations_workstation_config_iam_binding+: { + [resourceLabel]+: { + workstation_cluster_id: value, + }, + }, + }, + }, + '#withWorkstationConfigId':: d.fn(help='`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_config_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `workstation_config_id` field.\n', args=[]), + withWorkstationConfigId(resourceLabel, value): { + resource+: { + google_workstations_workstation_config_iam_binding+: { + [resourceLabel]+: { + workstation_config_id: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/workstations_workstation_config_iam_member.libsonnet b/4.x/_gen/resources/workstations_workstation_config_iam_member.libsonnet new file mode 100644 index 00000000..c46e117e --- /dev/null +++ b/4.x/_gen/resources/workstations_workstation_config_iam_member.libsonnet @@ -0,0 +1,140 @@ +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='google_workstations_workstation_config_iam_member', url='', help='`google_workstations_workstation_config_iam_member` represents the `google-beta_google_workstations_workstation_config_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-beta.google_workstations_workstation_config_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-beta.google_workstations_workstation_config_iam_member.new` injects a new `google-beta_google_workstations_workstation_config_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-beta.google_workstations_workstation_config_iam_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_config_iam_member` using the reference:\n\n $._ref.google-beta_google_workstations_workstation_config_iam_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation_config_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` 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-beta.google_workstations_workstation_config_iam_member.condition.new](#fn-conditionnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + member, + role, + workstation_cluster_id, + workstation_config_id, + condition=null, + location=null, + project=null, + _meta={} + ):: tf.withResource( + type='google_workstations_workstation_config_iam_member', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + location=location, + member=member, + project=project, + role=role, + workstation_cluster_id=workstation_cluster_id, + workstation_config_id=workstation_config_id + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation_config_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_config_iam_member`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation_config_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` 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-beta.google_workstations_workstation_config_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 `google_workstations_workstation_config_iam_member` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + member, + role, + workstation_cluster_id, + workstation_config_id, + condition=null, + location=null, + project=null + ):: std.prune(a={ + condition: condition, + location: location, + member: member, + project: project, + role: role, + workstation_cluster_id: workstation_cluster_id, + workstation_config_id: workstation_config_id, + }), + '#withCondition':: d.fn(help='`google-beta.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-beta.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_workstations_workstation_config_iam_member+: { + [resourceLabel]+: { + condition: value, + }, + }, + }, + }, + '#withConditionMixin':: d.fn(help='`google-beta.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-beta.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_workstations_workstation_config_iam_member+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google-beta.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_workstations_workstation_config_iam_member+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withMember':: d.fn(help='`google-beta.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_workstations_workstation_config_iam_member+: { + [resourceLabel]+: { + member: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_workstations_workstation_config_iam_member+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google-beta.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_workstations_workstation_config_iam_member+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, + '#withWorkstationClusterId':: d.fn(help='`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_cluster_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 `workstation_cluster_id` field.\n', args=[]), + withWorkstationClusterId(resourceLabel, value): { + resource+: { + google_workstations_workstation_config_iam_member+: { + [resourceLabel]+: { + workstation_cluster_id: value, + }, + }, + }, + }, + '#withWorkstationConfigId':: d.fn(help='`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_config_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `workstation_config_id` field.\n', args=[]), + withWorkstationConfigId(resourceLabel, value): { + resource+: { + google_workstations_workstation_config_iam_member+: { + [resourceLabel]+: { + workstation_config_id: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/workstations_workstation_config_iam_policy.libsonnet b/4.x/_gen/resources/workstations_workstation_config_iam_policy.libsonnet new file mode 100644 index 00000000..58570e0a --- /dev/null +++ b/4.x/_gen/resources/workstations_workstation_config_iam_policy.libsonnet @@ -0,0 +1,90 @@ +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='google_workstations_workstation_config_iam_policy', url='', help='`google_workstations_workstation_config_iam_policy` represents the `google-beta_google_workstations_workstation_config_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-beta.google_workstations_workstation_config_iam_policy.new` injects a new `google-beta_google_workstations_workstation_config_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-beta.google_workstations_workstation_config_iam_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_config_iam_policy` using the reference:\n\n $._ref.google-beta_google_workstations_workstation_config_iam_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation_config_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting resource block.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + policy_data, + workstation_cluster_id, + workstation_config_id, + location=null, + project=null, + _meta={} + ):: tf.withResource( + type='google_workstations_workstation_config_iam_policy', + label=resourceLabel, + attrs=self.newAttrs( + location=location, + policy_data=policy_data, + project=project, + workstation_cluster_id=workstation_cluster_id, + workstation_config_id=workstation_config_id + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation_config_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_config_iam_policy`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation_config_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_workstations_workstation_config_iam_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + policy_data, + workstation_cluster_id, + workstation_config_id, + location=null, + project=null + ):: std.prune(a={ + location: location, + policy_data: policy_data, + project: project, + workstation_cluster_id: workstation_cluster_id, + workstation_config_id: workstation_config_id, + }), + '#withLocation':: d.fn(help='`google-beta.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_workstations_workstation_config_iam_policy+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withPolicyData':: d.fn(help='`google-beta.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_workstations_workstation_config_iam_policy+: { + [resourceLabel]+: { + policy_data: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_workstations_workstation_config_iam_policy+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withWorkstationClusterId':: d.fn(help='`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_cluster_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 `workstation_cluster_id` field.\n', args=[]), + withWorkstationClusterId(resourceLabel, value): { + resource+: { + google_workstations_workstation_config_iam_policy+: { + [resourceLabel]+: { + workstation_cluster_id: value, + }, + }, + }, + }, + '#withWorkstationConfigId':: d.fn(help='`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_config_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `workstation_config_id` field.\n', args=[]), + withWorkstationConfigId(resourceLabel, value): { + resource+: { + google_workstations_workstation_config_iam_policy+: { + [resourceLabel]+: { + workstation_config_id: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/workstations_workstation_iam_binding.libsonnet b/4.x/_gen/resources/workstations_workstation_iam_binding.libsonnet new file mode 100644 index 00000000..bb615a7e --- /dev/null +++ b/4.x/_gen/resources/workstations_workstation_iam_binding.libsonnet @@ -0,0 +1,154 @@ +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='google_workstations_workstation_iam_binding', url='', help='`google_workstations_workstation_iam_binding` represents the `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_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-beta.google_workstations_workstation_iam_binding.new` injects a new `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_iam_binding.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_iam_binding` using the reference:\n\n $._ref.google-beta_google_workstations_workstation_iam_binding.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting resource block.\n - `workstation_id` (`string`): Set the `workstation_id` 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-beta.google_workstations_workstation_iam_binding.condition.new](#fn-conditionnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + members, + role, + workstation_cluster_id, + workstation_config_id, + workstation_id, + condition=null, + location=null, + project=null, + _meta={} + ):: tf.withResource( + type='google_workstations_workstation_iam_binding', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + location=location, + members=members, + project=project, + role=role, + workstation_cluster_id=workstation_cluster_id, + workstation_config_id=workstation_config_id, + workstation_id=workstation_id + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_iam_binding`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting object.\n - `workstation_id` (`string`): Set the `workstation_id` 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-beta.google_workstations_workstation_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 `google_workstations_workstation_iam_binding` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + members, + role, + workstation_cluster_id, + workstation_config_id, + workstation_id, + condition=null, + location=null, + project=null + ):: std.prune(a={ + condition: condition, + location: location, + members: members, + project: project, + role: role, + workstation_cluster_id: workstation_cluster_id, + workstation_config_id: workstation_config_id, + workstation_id: workstation_id, + }), + '#withCondition':: d.fn(help='`google-beta.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-beta.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_workstations_workstation_iam_binding+: { + [resourceLabel]+: { + condition: value, + }, + }, + }, + }, + '#withConditionMixin':: d.fn(help='`google-beta.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-beta.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_workstations_workstation_iam_binding+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google-beta.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_workstations_workstation_iam_binding+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withMembers':: d.fn(help='`google-beta.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_workstations_workstation_iam_binding+: { + [resourceLabel]+: { + members: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_workstations_workstation_iam_binding+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google-beta.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_workstations_workstation_iam_binding+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, + '#withWorkstationClusterId':: d.fn(help='`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_cluster_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 `workstation_cluster_id` field.\n', args=[]), + withWorkstationClusterId(resourceLabel, value): { + resource+: { + google_workstations_workstation_iam_binding+: { + [resourceLabel]+: { + workstation_cluster_id: value, + }, + }, + }, + }, + '#withWorkstationConfigId':: d.fn(help='`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_config_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `workstation_config_id` field.\n', args=[]), + withWorkstationConfigId(resourceLabel, value): { + resource+: { + google_workstations_workstation_iam_binding+: { + [resourceLabel]+: { + workstation_config_id: value, + }, + }, + }, + }, + '#withWorkstationId':: d.fn(help='`google-beta.string.withWorkstationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_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 `workstation_id` field.\n', args=[]), + withWorkstationId(resourceLabel, value): { + resource+: { + google_workstations_workstation_iam_binding+: { + [resourceLabel]+: { + workstation_id: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/workstations_workstation_iam_member.libsonnet b/4.x/_gen/resources/workstations_workstation_iam_member.libsonnet new file mode 100644 index 00000000..a333c4cf --- /dev/null +++ b/4.x/_gen/resources/workstations_workstation_iam_member.libsonnet @@ -0,0 +1,154 @@ +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='google_workstations_workstation_iam_member', url='', help='`google_workstations_workstation_iam_member` represents the `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_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-beta.google_workstations_workstation_iam_member.new` injects a new `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_iam_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_iam_member` using the reference:\n\n $._ref.google-beta_google_workstations_workstation_iam_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting resource block.\n - `workstation_id` (`string`): Set the `workstation_id` 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-beta.google_workstations_workstation_iam_member.condition.new](#fn-conditionnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + member, + role, + workstation_cluster_id, + workstation_config_id, + workstation_id, + condition=null, + location=null, + project=null, + _meta={} + ):: tf.withResource( + type='google_workstations_workstation_iam_member', + label=resourceLabel, + attrs=self.newAttrs( + condition=condition, + location=location, + member=member, + project=project, + role=role, + workstation_cluster_id=workstation_cluster_id, + workstation_config_id=workstation_config_id, + workstation_id=workstation_id + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_iam_member`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting object.\n - `workstation_id` (`string`): Set the `workstation_id` 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-beta.google_workstations_workstation_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 `google_workstations_workstation_iam_member` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + member, + role, + workstation_cluster_id, + workstation_config_id, + workstation_id, + condition=null, + location=null, + project=null + ):: std.prune(a={ + condition: condition, + location: location, + member: member, + project: project, + role: role, + workstation_cluster_id: workstation_cluster_id, + workstation_config_id: workstation_config_id, + workstation_id: workstation_id, + }), + '#withCondition':: d.fn(help='`google-beta.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-beta.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_workstations_workstation_iam_member+: { + [resourceLabel]+: { + condition: value, + }, + }, + }, + }, + '#withConditionMixin':: d.fn(help='`google-beta.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-beta.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_workstations_workstation_iam_member+: { + [resourceLabel]+: { + condition+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google-beta.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_workstations_workstation_iam_member+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withMember':: d.fn(help='`google-beta.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_workstations_workstation_iam_member+: { + [resourceLabel]+: { + member: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_workstations_workstation_iam_member+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google-beta.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_workstations_workstation_iam_member+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, + '#withWorkstationClusterId':: d.fn(help='`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_cluster_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 `workstation_cluster_id` field.\n', args=[]), + withWorkstationClusterId(resourceLabel, value): { + resource+: { + google_workstations_workstation_iam_member+: { + [resourceLabel]+: { + workstation_cluster_id: value, + }, + }, + }, + }, + '#withWorkstationConfigId':: d.fn(help='`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_config_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `workstation_config_id` field.\n', args=[]), + withWorkstationConfigId(resourceLabel, value): { + resource+: { + google_workstations_workstation_iam_member+: { + [resourceLabel]+: { + workstation_config_id: value, + }, + }, + }, + }, + '#withWorkstationId':: d.fn(help='`google-beta.string.withWorkstationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_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 `workstation_id` field.\n', args=[]), + withWorkstationId(resourceLabel, value): { + resource+: { + google_workstations_workstation_iam_member+: { + [resourceLabel]+: { + workstation_id: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/workstations_workstation_iam_policy.libsonnet b/4.x/_gen/resources/workstations_workstation_iam_policy.libsonnet new file mode 100644 index 00000000..c075e807 --- /dev/null +++ b/4.x/_gen/resources/workstations_workstation_iam_policy.libsonnet @@ -0,0 +1,104 @@ +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='google_workstations_workstation_iam_policy', url='', help='`google_workstations_workstation_iam_policy` represents the `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_iam_policy.new` injects a new `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_iam_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_iam_policy` using the reference:\n\n $._ref.google-beta_google_workstations_workstation_iam_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_workstations_workstation_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting resource block.\n - `workstation_id` (`string`): Set the `workstation_id` field on the resulting resource block.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + policy_data, + workstation_cluster_id, + workstation_config_id, + workstation_id, + location=null, + project=null, + _meta={} + ):: tf.withResource( + type='google_workstations_workstation_iam_policy', + label=resourceLabel, + attrs=self.newAttrs( + location=location, + policy_data=policy_data, + project=project, + workstation_cluster_id=workstation_cluster_id, + workstation_config_id=workstation_config_id, + workstation_id=workstation_id + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_workstations_workstation_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_iam_policy`\nTerraform resource.\n\nUnlike [google-beta.google_workstations_workstation_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 - `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 - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object.\n - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting object.\n - `workstation_id` (`string`): Set the `workstation_id` field on the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_workstations_workstation_iam_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + policy_data, + workstation_cluster_id, + workstation_config_id, + workstation_id, + location=null, + project=null + ):: std.prune(a={ + location: location, + policy_data: policy_data, + project: project, + workstation_cluster_id: workstation_cluster_id, + workstation_config_id: workstation_config_id, + workstation_id: workstation_id, + }), + '#withLocation':: d.fn(help='`google-beta.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_workstations_workstation_iam_policy+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withPolicyData':: d.fn(help='`google-beta.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_workstations_workstation_iam_policy+: { + [resourceLabel]+: { + policy_data: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.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_workstations_workstation_iam_policy+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withWorkstationClusterId':: d.fn(help='`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_cluster_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 `workstation_cluster_id` field.\n', args=[]), + withWorkstationClusterId(resourceLabel, value): { + resource+: { + google_workstations_workstation_iam_policy+: { + [resourceLabel]+: { + workstation_cluster_id: value, + }, + }, + }, + }, + '#withWorkstationConfigId':: d.fn(help='`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_config_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `workstation_config_id` field.\n', args=[]), + withWorkstationConfigId(resourceLabel, value): { + resource+: { + google_workstations_workstation_iam_policy+: { + [resourceLabel]+: { + workstation_config_id: value, + }, + }, + }, + }, + '#withWorkstationId':: d.fn(help='`google-beta.string.withWorkstationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the workstation_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 `workstation_id` field.\n', args=[]), + withWorkstationId(resourceLabel, value): { + resource+: { + google_workstations_workstation_iam_policy+: { + [resourceLabel]+: { + workstation_id: value, + }, + }, + }, + }, +} diff --git a/docs/4.x/README.md b/docs/4.x/README.md index 2773e9ac..114afc84 100644 --- a/docs/4.x/README.md +++ b/docs/4.x/README.md @@ -20,6 +20,7 @@ project. * [google_access_context_manager_access_policy_iam_member](google_access_context_manager_access_policy_iam_member.md) * [google_access_context_manager_access_policy_iam_policy](google_access_context_manager_access_policy_iam_policy.md) * [google_access_context_manager_authorized_orgs_desc](google_access_context_manager_authorized_orgs_desc.md) +* [google_access_context_manager_egress_policy](google_access_context_manager_egress_policy.md) * [google_access_context_manager_gcp_user_access_binding](google_access_context_manager_gcp_user_access_binding.md) * [google_access_context_manager_ingress_policy](google_access_context_manager_ingress_policy.md) * [google_access_context_manager_service_perimeter](google_access_context_manager_service_perimeter.md) @@ -349,6 +350,7 @@ project. * [google_data_loss_prevention_inspect_template](google_data_loss_prevention_inspect_template.md) * [google_data_loss_prevention_job_trigger](google_data_loss_prevention_job_trigger.md) * [google_data_loss_prevention_stored_info_type](google_data_loss_prevention_stored_info_type.md) +* [google_database_migration_service_connection_profile](google_database_migration_service_connection_profile.md) * [google_dataflow_flex_template_job](google_dataflow_flex_template_job.md) * [google_dataflow_job](google_dataflow_job.md) * [google_dataform_repository](google_dataform_repository.md) @@ -464,6 +466,8 @@ project. * [google_gke_hub_membership_iam_binding](google_gke_hub_membership_iam_binding.md) * [google_gke_hub_membership_iam_member](google_gke_hub_membership_iam_member.md) * [google_gke_hub_membership_iam_policy](google_gke_hub_membership_iam_policy.md) +* [google_gkeonprem_vmware_cluster](google_gkeonprem_vmware_cluster.md) +* [google_gkeonprem_vmware_node_pool](google_gkeonprem_vmware_node_pool.md) * [google_healthcare_consent_store](google_healthcare_consent_store.md) * [google_healthcare_consent_store_iam_binding](google_healthcare_consent_store_iam_binding.md) * [google_healthcare_consent_store_iam_member](google_healthcare_consent_store_iam_member.md) @@ -566,16 +570,23 @@ project. * [google_network_connectivity_hub](google_network_connectivity_hub.md) * [google_network_connectivity_spoke](google_network_connectivity_spoke.md) * [google_network_management_connectivity_test](google_network_management_connectivity_test.md) +* [google_network_security_address_group](google_network_security_address_group.md) +* [google_network_security_authorization_policy](google_network_security_authorization_policy.md) +* [google_network_security_client_tls_policy](google_network_security_client_tls_policy.md) * [google_network_security_gateway_security_policy](google_network_security_gateway_security_policy.md) * [google_network_security_gateway_security_policy_rule](google_network_security_gateway_security_policy_rule.md) * [google_network_security_url_lists](google_network_security_url_lists.md) * [google_network_services_edge_cache_keyset](google_network_services_edge_cache_keyset.md) * [google_network_services_edge_cache_origin](google_network_services_edge_cache_origin.md) * [google_network_services_edge_cache_service](google_network_services_edge_cache_service.md) +* [google_network_services_endpoint_policy](google_network_services_endpoint_policy.md) * [google_network_services_gateway](google_network_services_gateway.md) +* [google_network_services_grpc_route](google_network_services_grpc_route.md) * [google_network_services_http_route](google_network_services_http_route.md) * [google_network_services_mesh](google_network_services_mesh.md) +* [google_network_services_service_binding](google_network_services_service_binding.md) * [google_network_services_tcp_route](google_network_services_tcp_route.md) +* [google_network_services_tls_route](google_network_services_tls_route.md) * [google_notebooks_environment](google_notebooks_environment.md) * [google_notebooks_instance](google_notebooks_instance.md) * [google_notebooks_instance_iam_binding](google_notebooks_instance_iam_binding.md) @@ -732,4 +743,10 @@ project. * [google_workstations_workstation](google_workstations_workstation.md) * [google_workstations_workstation_cluster](google_workstations_workstation_cluster.md) * [google_workstations_workstation_config](google_workstations_workstation_config.md) +* [google_workstations_workstation_config_iam_binding](google_workstations_workstation_config_iam_binding.md) +* [google_workstations_workstation_config_iam_member](google_workstations_workstation_config_iam_member.md) +* [google_workstations_workstation_config_iam_policy](google_workstations_workstation_config_iam_policy.md) +* [google_workstations_workstation_iam_binding](google_workstations_workstation_iam_binding.md) +* [google_workstations_workstation_iam_member](google_workstations_workstation_iam_member.md) +* [google_workstations_workstation_iam_policy](google_workstations_workstation_iam_policy.md) * [provider](provider.md) \ No newline at end of file diff --git a/docs/4.x/data/google_alloydb_locations.md b/docs/4.x/data/google_alloydb_locations.md new file mode 100644 index 00000000..2a913986 --- /dev/null +++ b/docs/4.x/data/google_alloydb_locations.md @@ -0,0 +1,92 @@ +--- +permalink: /data/google_alloydb_locations/ +--- + +# data.google_alloydb_locations + +`google_alloydb_locations` represents the `google-beta_google_alloydb_locations` 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 withProject()`](#fn-withproject) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.data.google_alloydb_locations.new` injects a new `data_google-beta_google_alloydb_locations` 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-beta.data.google_alloydb_locations.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.data.google_alloydb_locations` using the reference: + + $._ref.data_google-beta_google_alloydb_locations.some_id.get('id') + +This is the same as directly entering `"${ data_google-beta_google_alloydb_locations.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. + - `project` (`string`): Project ID of the project. 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-beta.data.google_alloydb_locations.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_locations` +Terraform data source. + +Unlike [google-beta.data.google_alloydb_locations.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**: + - `project` (`string`): Project ID of the project. 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 `google_alloydb_locations` data source into the root Terraform configuration. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.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/google_alloydb_supported_database_flags.md b/docs/4.x/data/google_alloydb_supported_database_flags.md new file mode 100644 index 00000000..05acf2ac --- /dev/null +++ b/docs/4.x/data/google_alloydb_supported_database_flags.md @@ -0,0 +1,111 @@ +--- +permalink: /data/google_alloydb_supported_database_flags/ +--- + +# data.google_alloydb_supported_database_flags + +`google_alloydb_supported_database_flags` represents the `google-beta_google_alloydb_supported_database_flags` 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 withProject()`](#fn-withproject) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.data.google_alloydb_supported_database_flags.new` injects a new `data_google-beta_google_alloydb_supported_database_flags` 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-beta.data.google_alloydb_supported_database_flags.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.data.google_alloydb_supported_database_flags` using the reference: + + $._ref.data_google-beta_google_alloydb_supported_database_flags.some_id.get('id') + +This is the same as directly entering `"${ data_google-beta_google_alloydb_supported_database_flags.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`): The canonical id for the location. For example: "us-east1". + - `project` (`string`): Project ID of the project. 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-beta.data.google_alloydb_supported_database_flags.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_supported_database_flags` +Terraform data source. + +Unlike [google-beta.data.google_alloydb_supported_database_flags.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`): The canonical id for the location. For example: "us-east1". + - `project` (`string`): Project ID of the project. 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 `google_alloydb_supported_database_flags` data source into the root Terraform configuration. + + +### fn withLocation + +```ts +withLocation() +``` + +`google-beta.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 withProject + +```ts +withProject() +``` + +`google-beta.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/google_compute_forwarding_rule.md b/docs/4.x/data/google_compute_forwarding_rule.md index ad5d62ad..84a7acad 100644 --- a/docs/4.x/data/google_compute_forwarding_rule.md +++ b/docs/4.x/data/google_compute_forwarding_rule.md @@ -48,9 +48,23 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object. - - `region` (`string`): The location of this resource. When `null`, the `region` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource; provided by the client when the resource is created. +The name must be 1-63 characters long, and comply with +[RFC1035](https://www.ietf.org/rfc/rfc1035.txt). + +Specifically, the name must be 1-63 characters long and match the regular +expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first +character must be a lowercase letter, and all following characters must +be a dash, lowercase letter, or digit, except the last character, which +cannot be a dash. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, the forwarding rule name must be a 1-20 characters string with +lowercase letters and numbers and must start with a letter. + - `project` (`string`): Set the `project` field on the resulting data source block. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): A reference to the region where the regional forwarding rule resides. + +This field is not applicable to global forwarding rules. When `null`, the `region` field will be omitted from the resulting object. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -74,9 +88,23 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object. - - `region` (`string`): The location of this resource. When `null`, the `region` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource; provided by the client when the resource is created. +The name must be 1-63 characters long, and comply with +[RFC1035](https://www.ietf.org/rfc/rfc1035.txt). + +Specifically, the name must be 1-63 characters long and match the regular +expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first +character must be a lowercase letter, and all following characters must +be a dash, lowercase letter, or digit, except the last character, which +cannot be a dash. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, the forwarding rule name must be a 1-20 characters string with +lowercase letters and numbers and must start with a letter. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): A reference to the region where the regional forwarding rule resides. + +This field is not applicable to global forwarding rules. When `null`, the `region` 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 `google_compute_forwarding_rule` data source into the root Terraform configuration. diff --git a/docs/4.x/data/google_compute_global_forwarding_rule.md b/docs/4.x/data/google_compute_global_forwarding_rule.md index e66521cd..3d8f9bb6 100644 --- a/docs/4.x/data/google_compute_global_forwarding_rule.md +++ b/docs/4.x/data/google_compute_global_forwarding_rule.md @@ -47,8 +47,20 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource; provided by the client when the resource is created. +The name must be 1-63 characters long, and comply with +[RFC1035](https://www.ietf.org/rfc/rfc1035.txt). + +Specifically, the name must be 1-63 characters long and match the regular +expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first +character must be a lowercase letter, and all following characters must +be a dash, lowercase letter, or digit, except the last character, which +cannot be a dash. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, the forwarding rule name must be a 1-20 characters string with +lowercase letters and numbers and must start with a letter. + - `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. @@ -72,8 +84,20 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource; provided by the client when the resource is created. +The name must be 1-63 characters long, and comply with +[RFC1035](https://www.ietf.org/rfc/rfc1035.txt). + +Specifically, the name must be 1-63 characters long and match the regular +expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first +character must be a lowercase letter, and all following characters must +be a dash, lowercase letter, or digit, except the last character, which +cannot be a dash. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, the forwarding rule name must be a 1-20 characters string with +lowercase letters and numbers and must start with a letter. + - `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 `google_compute_global_forwarding_rule` data source into the root Terraform configuration. diff --git a/docs/4.x/data/google_dns_keys.md b/docs/4.x/data/google_dns_keys.md index debe3548..3a970513 100644 --- a/docs/4.x/data/google_dns_keys.md +++ b/docs/4.x/data/google_dns_keys.md @@ -15,20 +15,8 @@ This package contains functions and utilities for setting up the data source usi * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) -* [`fn withKeySigningKeys()`](#fn-withkeysigningkeys) -* [`fn withKeySigningKeysMixin()`](#fn-withkeysigningkeysmixin) * [`fn withManagedZone()`](#fn-withmanagedzone) * [`fn withProject()`](#fn-withproject) -* [`fn withZoneSigningKeys()`](#fn-withzonesigningkeys) -* [`fn withZoneSigningKeysMixin()`](#fn-withzonesigningkeysmixin) -* [`obj key_signing_keys`](#obj-key_signing_keys) - * [`fn new()`](#fn-key_signing_keysnew) - * [`obj key_signing_keys.digests`](#obj-key_signing_keysdigests) - * [`fn new()`](#fn-key_signing_keysdigestsnew) -* [`obj zone_signing_keys`](#obj-zone_signing_keys) - * [`fn new()`](#fn-zone_signing_keysnew) - * [`obj zone_signing_keys.digests`](#obj-zone_signing_keysdigests) - * [`fn new()`](#fn-zone_signing_keysdigestsnew) ## Fields @@ -61,8 +49,6 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `dataSrcLabel` (`string`): The name label of the block. - `managed_zone` (`string`): The Name of the zone. - `project` (`string`): The ID of the project for the Google Cloud. When `null`, the `project` field will be omitted from the resulting object. - - `key_signing_keys` (`list[obj]`): A list of Key-signing key (KSK) records. When `null`, the `key_signing_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.data.google_dns_keys.key_signing_keys.new](#fn-key_signing_keysnew) constructor. - - `zone_signing_keys` (`list[obj]`): A list of Zone-signing key (ZSK) records. When `null`, the `zone_signing_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.data.google_dns_keys.zone_signing_keys.new](#fn-zone_signing_keysnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -88,50 +74,11 @@ injecting into a complete block. **Args**: - `managed_zone` (`string`): The Name of the zone. - `project` (`string`): The ID of the project for the Google Cloud. When `null`, the `project` field will be omitted from the resulting object. - - `key_signing_keys` (`list[obj]`): A list of Key-signing key (KSK) records. When `null`, the `key_signing_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.data.google_dns_keys.key_signing_keys.new](#fn-key_signing_keysnew) constructor. - - `zone_signing_keys` (`list[obj]`): A list of Zone-signing key (ZSK) records. When `null`, the `zone_signing_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.data.google_dns_keys.zone_signing_keys.new](#fn-zone_signing_keysnew) constructor. **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 `google_dns_keys` data source into the root Terraform configuration. -### fn withKeySigningKeys - -```ts -withKeySigningKeys() -``` - -`google-beta.list[obj].withKeySigningKeys` constructs a mixin object that can be merged into the `list[obj]` -Terraform data source block to set or update the key_signing_keys 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-beta.list[obj].withKeySigningKeysMixin](TODO) function. - - -**Args**: - - `dataSrcLabel` (`string`): The name label of the block to update. - - `value` (`list[obj]`): The value to set for the `key_signing_keys` field. - - -### fn withKeySigningKeysMixin - -```ts -withKeySigningKeysMixin() -``` - -`google-beta.list[obj].withKeySigningKeysMixin` constructs a mixin object that can be merged into the `list[obj]` -Terraform data source block to set or update the key_signing_keys 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-beta.list[obj].withKeySigningKeys](TODO) -function. - - -**Args**: - - `dataSrcLabel` (`string`): The name label of the block to update. - - `value` (`list[obj]`): The value to set for the `key_signing_keys` field. - - ### fn withManagedZone ```ts @@ -162,126 +109,3 @@ 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. - - -### fn withZoneSigningKeys - -```ts -withZoneSigningKeys() -``` - -`google-beta.list[obj].withZoneSigningKeys` constructs a mixin object that can be merged into the `list[obj]` -Terraform data source block to set or update the zone_signing_keys 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-beta.list[obj].withZoneSigningKeysMixin](TODO) function. - - -**Args**: - - `dataSrcLabel` (`string`): The name label of the block to update. - - `value` (`list[obj]`): The value to set for the `zone_signing_keys` field. - - -### fn withZoneSigningKeysMixin - -```ts -withZoneSigningKeysMixin() -``` - -`google-beta.list[obj].withZoneSigningKeysMixin` constructs a mixin object that can be merged into the `list[obj]` -Terraform data source block to set or update the zone_signing_keys 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-beta.list[obj].withZoneSigningKeys](TODO) -function. - - -**Args**: - - `dataSrcLabel` (`string`): The name label of the block to update. - - `value` (`list[obj]`): The value to set for the `zone_signing_keys` field. - - -## obj key_signing_keys - - - -### fn key_signing_keys.new - -```ts -new() -``` - - -`google-beta.google_dns_keys.key_signing_keys.new` constructs a new object with attributes and blocks configured for the `key_signing_keys` -Terraform sub block. - - - -**Args**: - - `digests` (`list[obj]`): A list of cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. When `null`, the `digests` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dns_keys.key_signing_keys.digests.new](#fn-key_signing_keysdigestsnew) constructor. - -**Returns**: - - An attribute object that represents the `key_signing_keys` sub block. - - -## obj key_signing_keys.digests - - - -### fn key_signing_keys.digests.new - -```ts -new() -``` - - -`google-beta.google_dns_keys.key_signing_keys.digests.new` constructs a new object with attributes and blocks configured for the `digests` -Terraform sub block. - - - -**Returns**: - - An attribute object that represents the `digests` sub block. - - -## obj zone_signing_keys - - - -### fn zone_signing_keys.new - -```ts -new() -``` - - -`google-beta.google_dns_keys.zone_signing_keys.new` constructs a new object with attributes and blocks configured for the `zone_signing_keys` -Terraform sub block. - - - -**Args**: - - `digests` (`list[obj]`): A list of cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. When `null`, the `digests` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dns_keys.zone_signing_keys.digests.new](#fn-zone_signing_keysdigestsnew) constructor. - -**Returns**: - - An attribute object that represents the `zone_signing_keys` sub block. - - -## obj zone_signing_keys.digests - - - -### fn zone_signing_keys.digests.new - -```ts -new() -``` - - -`google-beta.google_dns_keys.zone_signing_keys.digests.new` constructs a new object with attributes and blocks configured for the `digests` -Terraform sub block. - - - -**Returns**: - - An attribute object that represents the `digests` sub block. diff --git a/docs/4.x/data/google_sql_tiers.md b/docs/4.x/data/google_sql_tiers.md new file mode 100644 index 00000000..0118fea6 --- /dev/null +++ b/docs/4.x/data/google_sql_tiers.md @@ -0,0 +1,92 @@ +--- +permalink: /data/google_sql_tiers/ +--- + +# data.google_sql_tiers + +`google_sql_tiers` represents the `google-beta_google_sql_tiers` 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 withProject()`](#fn-withproject) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.data.google_sql_tiers.new` injects a new `data_google-beta_google_sql_tiers` 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-beta.data.google_sql_tiers.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.data.google_sql_tiers` using the reference: + + $._ref.data_google-beta_google_sql_tiers.some_id.get('id') + +This is the same as directly entering `"${ data_google-beta_google_sql_tiers.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. + - `project` (`string`): Project ID of the project for which to list tiers. 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-beta.data.google_sql_tiers.newAttrs` constructs a new object with attributes and blocks configured for the `google_sql_tiers` +Terraform data source. + +Unlike [google-beta.data.google_sql_tiers.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**: + - `project` (`string`): Project ID of the project for which to list tiers. 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 `google_sql_tiers` data source into the root Terraform configuration. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.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 925ed41e..6a6909bd 100644 --- a/docs/4.x/data/index.md +++ b/docs/4.x/data/index.md @@ -10,6 +10,8 @@ permalink: /data/ * [google_access_approval_organization_service_account](google_access_approval_organization_service_account.md) * [google_access_approval_project_service_account](google_access_approval_project_service_account.md) * [google_active_folder](google_active_folder.md) +* [google_alloydb_locations](google_alloydb_locations.md) +* [google_alloydb_supported_database_flags](google_alloydb_supported_database_flags.md) * [google_app_engine_default_service_account](google_app_engine_default_service_account.md) * [google_artifact_registry_repository](google_artifact_registry_repository.md) * [google_beyondcorp_app_connection](google_beyondcorp_app_connection.md) @@ -138,6 +140,7 @@ permalink: /data/ * [google_sql_database_instance](google_sql_database_instance.md) * [google_sql_database_instances](google_sql_database_instances.md) * [google_sql_databases](google_sql_databases.md) +* [google_sql_tiers](google_sql_tiers.md) * [google_storage_bucket](google_storage_bucket.md) * [google_storage_bucket_object](google_storage_bucket_object.md) * [google_storage_bucket_object_content](google_storage_bucket_object_content.md) diff --git a/docs/4.x/google_access_context_manager_access_level.md b/docs/4.x/google_access_context_manager_access_level.md index 01e269c5..dac3c479 100644 --- a/docs/4.x/google_access_context_manager_access_level.md +++ b/docs/4.x/google_access_context_manager_access_level.md @@ -77,7 +77,7 @@ Format: accessPolicies/{policy_id}/accessLevels/{short_name} Format: accessPolicies/{policy_id} - `title` (`string`): Human readable title. Must be unique within the Policy. - `basic` (`list[obj]`): A set of predefined conditions for the access level and a combining function. When `null`, the `basic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.basic.new](#fn-basicnew) constructor. - - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. + - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec. When `null`, the `custom` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.custom.new](#fn-customnew) 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-beta.google_access_context_manager_access_level.timeouts.new](#fn-timeoutsnew) constructor. @@ -111,7 +111,7 @@ Format: accessPolicies/{policy_id}/accessLevels/{short_name} Format: accessPolicies/{policy_id} - `title` (`string`): Human readable title. Must be unique within the Policy. - `basic` (`list[obj]`): A set of predefined conditions for the access level and a combining function. When `null`, the `basic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.basic.new](#fn-basicnew) constructor. - - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. + - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec. When `null`, the `custom` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.custom.new](#fn-customnew) 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-beta.google_access_context_manager_access_level.timeouts.new](#fn-timeoutsnew) constructor. @@ -452,7 +452,7 @@ Terraform sub block. **Args**: - `expr` (`list[obj]`): Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. -This page details the objects and attributes that are used to the build the CEL expressions for +This page details the objects and attributes that are used to the build the CEL expressions for custom access levels - https://cloud.google.com/access-context-manager/docs/custom-access-level-spec. When `null`, the `expr` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_level.custom.expr.new](#fn-customexprnew) constructor. **Returns**: diff --git a/docs/4.x/google_access_context_manager_access_levels.md b/docs/4.x/google_access_context_manager_access_levels.md index 18dc28db..631b4269 100644 --- a/docs/4.x/google_access_context_manager_access_levels.md +++ b/docs/4.x/google_access_context_manager_access_levels.md @@ -214,7 +214,7 @@ with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/accessLevels/{short_name} - `title` (`string`): Human readable title. Must be unique within the Policy. - `basic` (`list[obj]`): A set of predefined conditions for the access level and a combining function. When `null`, the `basic` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_levels.access_levels.basic.new](#fn-access_levelsbasicnew) constructor. - - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. + - `custom` (`list[obj]`): Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec. When `null`, the `custom` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_levels.access_levels.custom.new](#fn-access_levelscustomnew) constructor. **Returns**: @@ -379,7 +379,7 @@ Terraform sub block. **Args**: - `expr` (`list[obj]`): Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. -This page details the objects and attributes that are used to the build the CEL expressions for +This page details the objects and attributes that are used to the build the CEL expressions for custom access levels - https://cloud.google.com/access-context-manager/docs/custom-access-level-spec. When `null`, the `expr` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_access_levels.access_levels.custom.expr.new](#fn-access_levelsaccess_levelsexprnew) constructor. **Returns**: diff --git a/docs/4.x/google_access_context_manager_egress_policy.md b/docs/4.x/google_access_context_manager_egress_policy.md new file mode 100644 index 00000000..7b0d54bf --- /dev/null +++ b/docs/4.x/google_access_context_manager_egress_policy.md @@ -0,0 +1,177 @@ +--- +permalink: /google_access_context_manager_egress_policy/ +--- + +# google_access_context_manager_egress_policy + +`google_access_context_manager_egress_policy` represents the `google-beta_google_access_context_manager_egress_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 withEgressPolicyName()`](#fn-withegresspolicyname) +* [`fn withResource()`](#fn-withresource) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_access_context_manager_egress_policy.new` injects a new `google-beta_google_access_context_manager_egress_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-beta.google_access_context_manager_egress_policy.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_access_context_manager_egress_policy` using the reference: + + $._ref.google-beta_google_access_context_manager_egress_policy.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_access_context_manager_egress_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. + - `egress_policy_name` (`string`): The name of the Service Perimeter to add this resource to. + - `resource` (`string`): A GCP resource that is inside of the service perimeter. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_egress_policy.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_access_context_manager_egress_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_access_context_manager_egress_policy` +Terraform resource. + +Unlike [google-beta.google_access_context_manager_egress_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**: + - `egress_policy_name` (`string`): The name of the Service Perimeter to add this resource to. + - `resource` (`string`): A GCP resource that is inside of the service perimeter. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_egress_policy.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_access_context_manager_egress_policy` resource into the root Terraform configuration. + + +### fn withEgressPolicyName + +```ts +withEgressPolicyName() +``` + +`google-beta.string.withEgressPolicyName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the egress_policy_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `egress_policy_name` field. + + +### fn withResource + +```ts +withResource() +``` + +`google-beta.string.withResource` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the resource field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `resource` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.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-beta.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-beta.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-beta.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_access_context_manager_egress_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/google_access_context_manager_service_perimeter.md b/docs/4.x/google_access_context_manager_service_perimeter.md index ed78013e..461818c6 100644 --- a/docs/4.x/google_access_context_manager_service_perimeter.md +++ b/docs/4.x/google_access_context_manager_service_perimeter.md @@ -462,9 +462,9 @@ restrictions. Must contain a list of services. For example, if 'storage.googleapis.com' is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. When `null`, the `restricted_services` field will be omitted from the resulting object. - - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may + - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. -Access is granted if any EgressPolicy grants it. Must be empty for +Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.new](#fn-specegress_policiesnew) constructor. - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may have multiple 'IngressPolicies', each of which is evaluated @@ -495,7 +495,7 @@ Terraform sub block. **Args**: - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_from.new](#fn-specspecegress_fromnew) constructor. - - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that + - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that cause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.new](#fn-specspecegress_tonew) constructor. **Returns**: @@ -519,11 +519,11 @@ Terraform sub block. **Args**: - - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. -Should be in the format of email address. The email address should + - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. +Should be in the format of email address. The email address should represent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object. - - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the -perimeter. If left unspecified, then members of 'identities' field will + - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the +perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object. **Returns**: @@ -550,12 +550,12 @@ Terraform sub block. - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object. - - `resources` (`list`): A list of resources, currently only projects in the form -'projects/<projectnumber>', that match this to stanza. A request matches -if it contains a resource in this list. If * is specified for resources, -then this 'EgressTo' rule will authorize access to all resources outside + - `resources` (`list`): A list of resources, currently only projects in the form +'projects/<projectnumber>', that match this to stanza. A request matches +if it contains a resource in this list. If * is specified for resources, +then this 'EgressTo' rule will authorize access to all resources outside the perimeter. When `null`, the `resources` field will be omitted from the resulting object. - - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches + - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches if it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.operations.new](#fn-specspecegress_policiesoperationsnew) constructor. **Returns**: @@ -579,12 +579,12 @@ Terraform sub block. **Args**: - - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or -'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName + - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or +'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName field set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object. - - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong -to the service specified by 'serviceName' field. A single MethodSelector -entry with '*' specified for the 'method' field will allow all methods + - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong +to the service specified by 'serviceName' field. A single MethodSelector +entry with '*' specified for the 'method' field will allow all methods AND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.egress_policies.egress_to.operations.method_selectors.new](#fn-specspecegress_policiesegress_tomethod_selectorsnew) constructor. **Returns**: @@ -608,10 +608,10 @@ Terraform sub block. **Args**: - - `method` (`string`): Value for 'method' should be a valid method name for the corresponding -'serviceName' in 'ApiOperation'. If '*' used as value for method, + - `method` (`string`): Value for 'method' should be a valid method name for the corresponding +'serviceName' in 'ApiOperation'. If '*' used as value for method, then ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object. - - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the + - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object. **Returns**: @@ -662,10 +662,10 @@ Terraform sub block. **Args**: - `identities` (`list`): A list of identities that are allowed access through this ingress policy. -Should be in the format of email address. The email address should represent +Should be in the format of email address. The email address should represent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object. - - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the -perimeter. If left unspecified, then members of 'identities' field will be + - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the +perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object. - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_from.sources.new](#fn-specspecingress_policiessourcesnew) constructor. @@ -690,19 +690,19 @@ Terraform sub block. **Args**: - - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the -'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed + - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the +'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed must be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent -'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, -resources within the perimeter can only be accessed via Google Cloud calls -with request origins within the perimeter. -Example 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' +'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, +resources within the perimeter can only be accessed via Google Cloud calls +with request origins within the perimeter. +Example 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' If * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object. - - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. -Requests from these resources will be allowed to access perimeter data. -Currently only projects are allowed. Format 'projects/{project_number}' -The project may be in any Google Cloud organization, not just the -organization that the perimeter is defined in. '*' is not allowed, the case + - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. +Requests from these resources will be allowed to access perimeter data. +Currently only projects are allowed. Format 'projects/{project_number}' +The project may be in any Google Cloud organization, not just the +organization that the perimeter is defined in. '*' is not allowed, the case of allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object. **Returns**: @@ -726,15 +726,15 @@ Terraform sub block. **Args**: - - `resources` (`list`): A list of resources, currently only projects in the form + - `resources` (`list`): A list of resources, currently only projects in the form 'projects/<projectnumber>', protected by this 'ServicePerimeter' that are allowed to be accessed by sources defined in the corresponding 'IngressFrom'. A request matches if it contains a resource in this list. If '*' is specified for resources, -then this 'IngressTo' rule will authorize access to all +then this 'IngressTo' rule will authorize access to all resources inside the perimeter, provided that the request also matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object. - - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' + - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' are allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.operations.new](#fn-specspecingress_policiesoperationsnew) constructor. **Returns**: @@ -758,12 +758,12 @@ Terraform sub block. **Args**: - - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or -'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' + - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or +'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' field set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object. - - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to -the service specified by serviceName field. A single 'MethodSelector' entry -with '*' specified for the method field will allow all methods AND + - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to +the service specified by serviceName field. A single 'MethodSelector' entry +with '*' specified for the method field will allow all methods AND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.spec.ingress_policies.ingress_to.operations.method_selectors.new](#fn-specspecingress_policiesingress_tomethod_selectorsnew) constructor. **Returns**: @@ -787,10 +787,10 @@ Terraform sub block. **Args**: - - `method` (`string`): Value for method should be a valid method name for the corresponding -serviceName in 'ApiOperation'. If '*' used as value for 'method', then + - `method` (`string`): Value for method should be a valid method name for the corresponding +serviceName in 'ApiOperation'. If '*' used as value for 'method', then ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object. - - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the + - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object. **Returns**: @@ -858,9 +858,9 @@ restrictions. Must contain a list of services. For example, if 'storage.googleapis.com' is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. When `null`, the `restricted_services` field will be omitted from the resulting object. - - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may + - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. -Access is granted if any EgressPolicy grants it. Must be empty for +Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.new](#fn-statusegress_policiesnew) constructor. - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may have multiple 'IngressPolicies', each of which is evaluated @@ -891,7 +891,7 @@ Terraform sub block. **Args**: - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_from.new](#fn-statusstatusegress_fromnew) constructor. - - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that + - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that cause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.new](#fn-statusstatusegress_tonew) constructor. **Returns**: @@ -915,11 +915,11 @@ Terraform sub block. **Args**: - - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. -Should be in the format of email address. The email address should + - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. +Should be in the format of email address. The email address should represent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object. - - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the -perimeter. If left unspecified, then members of 'identities' field will + - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the +perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object. **Returns**: @@ -946,12 +946,12 @@ Terraform sub block. - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object. - - `resources` (`list`): A list of resources, currently only projects in the form -'projects/<projectnumber>', that match this to stanza. A request matches -if it contains a resource in this list. If * is specified for resources, -then this 'EgressTo' rule will authorize access to all resources outside + - `resources` (`list`): A list of resources, currently only projects in the form +'projects/<projectnumber>', that match this to stanza. A request matches +if it contains a resource in this list. If * is specified for resources, +then this 'EgressTo' rule will authorize access to all resources outside the perimeter. When `null`, the `resources` field will be omitted from the resulting object. - - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches + - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches if it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.operations.new](#fn-statusstatusegress_policiesoperationsnew) constructor. **Returns**: @@ -975,12 +975,12 @@ Terraform sub block. **Args**: - - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or -'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName + - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or +'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName field set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object. - - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong -to the service specified by 'serviceName' field. A single MethodSelector -entry with '*' specified for the 'method' field will allow all methods + - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong +to the service specified by 'serviceName' field. A single MethodSelector +entry with '*' specified for the 'method' field will allow all methods AND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.egress_policies.egress_to.operations.method_selectors.new](#fn-statusstatusegress_policiesegress_tomethod_selectorsnew) constructor. **Returns**: @@ -1004,10 +1004,10 @@ Terraform sub block. **Args**: - - `method` (`string`): Value for 'method' should be a valid method name for the corresponding -'serviceName' in 'ApiOperation'. If '*' used as value for method, + - `method` (`string`): Value for 'method' should be a valid method name for the corresponding +'serviceName' in 'ApiOperation'. If '*' used as value for method, then ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object. - - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the + - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object. **Returns**: @@ -1058,10 +1058,10 @@ Terraform sub block. **Args**: - `identities` (`list`): A list of identities that are allowed access through this ingress policy. -Should be in the format of email address. The email address should represent +Should be in the format of email address. The email address should represent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object. - - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the -perimeter. If left unspecified, then members of 'identities' field will be + - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the +perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object. - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_from.sources.new](#fn-statusstatusingress_policiessourcesnew) constructor. @@ -1086,19 +1086,19 @@ Terraform sub block. **Args**: - - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the -'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed + - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the +'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed must be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent -'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, -resources within the perimeter can only be accessed via Google Cloud calls -with request origins within the perimeter. -Example 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' +'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, +resources within the perimeter can only be accessed via Google Cloud calls +with request origins within the perimeter. +Example 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' If * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object. - - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. -Requests from these resources will be allowed to access perimeter data. -Currently only projects are allowed. Format 'projects/{project_number}' -The project may be in any Google Cloud organization, not just the -organization that the perimeter is defined in. '*' is not allowed, the case + - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. +Requests from these resources will be allowed to access perimeter data. +Currently only projects are allowed. Format 'projects/{project_number}' +The project may be in any Google Cloud organization, not just the +organization that the perimeter is defined in. '*' is not allowed, the case of allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object. **Returns**: @@ -1122,15 +1122,15 @@ Terraform sub block. **Args**: - - `resources` (`list`): A list of resources, currently only projects in the form + - `resources` (`list`): A list of resources, currently only projects in the form 'projects/<projectnumber>', protected by this 'ServicePerimeter' that are allowed to be accessed by sources defined in the corresponding 'IngressFrom'. A request matches if it contains a resource in this list. If '*' is specified for resources, -then this 'IngressTo' rule will authorize access to all +then this 'IngressTo' rule will authorize access to all resources inside the perimeter, provided that the request also matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object. - - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' + - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' are allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.operations.new](#fn-statusstatusingress_policiesoperationsnew) constructor. **Returns**: @@ -1154,12 +1154,12 @@ Terraform sub block. **Args**: - - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or -'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' + - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or +'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' field set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object. - - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to -the service specified by serviceName field. A single 'MethodSelector' entry -with '*' specified for the method field will allow all methods AND + - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to +the service specified by serviceName field. A single 'MethodSelector' entry +with '*' specified for the method field will allow all methods AND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeter.status.ingress_policies.ingress_to.operations.method_selectors.new](#fn-statusstatusingress_policiesingress_tomethod_selectorsnew) constructor. **Returns**: @@ -1183,10 +1183,10 @@ Terraform sub block. **Args**: - - `method` (`string`): Value for method should be a valid method name for the corresponding -serviceName in 'ApiOperation'. If '*' used as value for 'method', then + - `method` (`string`): Value for method should be a valid method name for the corresponding +serviceName in 'ApiOperation'. If '*' used as value for 'method', then ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object. - - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the + - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object. **Returns**: diff --git a/docs/4.x/google_access_context_manager_service_perimeters.md b/docs/4.x/google_access_context_manager_service_perimeters.md index 8fe2a1ab..ea1297d7 100644 --- a/docs/4.x/google_access_context_manager_service_perimeters.md +++ b/docs/4.x/google_access_context_manager_service_perimeters.md @@ -326,9 +326,9 @@ restrictions. Must contain a list of services. For example, if 'storage.googleapis.com' is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. When `null`, the `restricted_services` field will be omitted from the resulting object. - - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may + - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. -Access is granted if any EgressPolicy grants it. Must be empty for +Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.new](#fn-service_perimetersservice_perimetersegress_policiesnew) constructor. - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may have multiple 'IngressPolicies', each of which is evaluated @@ -359,7 +359,7 @@ Terraform sub block. **Args**: - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_from.new](#fn-service_perimetersservice_perimetersspecegress_fromnew) constructor. - - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that + - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that cause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.new](#fn-service_perimetersservice_perimetersspecegress_tonew) constructor. **Returns**: @@ -383,11 +383,11 @@ Terraform sub block. **Args**: - - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. -Should be in the format of email address. The email address should + - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. +Should be in the format of email address. The email address should represent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object. - - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the -perimeter. If left unspecified, then members of 'identities' field will + - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the +perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object. **Returns**: @@ -414,12 +414,12 @@ Terraform sub block. - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object. - - `resources` (`list`): A list of resources, currently only projects in the form -'projects/<projectnumber>', that match this to stanza. A request matches -if it contains a resource in this list. If * is specified for resources, -then this 'EgressTo' rule will authorize access to all resources outside + - `resources` (`list`): A list of resources, currently only projects in the form +'projects/<projectnumber>', that match this to stanza. A request matches +if it contains a resource in this list. If * is specified for resources, +then this 'EgressTo' rule will authorize access to all resources outside the perimeter. When `null`, the `resources` field will be omitted from the resulting object. - - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches + - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches if it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.operations.new](#fn-service_perimetersservice_perimetersspecegress_policiesoperationsnew) constructor. **Returns**: @@ -443,12 +443,12 @@ Terraform sub block. **Args**: - - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or -'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName + - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or +'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName field set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object. - - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong -to the service specified by 'serviceName' field. A single MethodSelector -entry with '*' specified for the 'method' field will allow all methods + - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong +to the service specified by 'serviceName' field. A single MethodSelector +entry with '*' specified for the 'method' field will allow all methods AND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.egress_policies.egress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersspecegress_policiesegress_tomethod_selectorsnew) constructor. **Returns**: @@ -472,10 +472,10 @@ Terraform sub block. **Args**: - - `method` (`string`): Value for 'method' should be a valid method name for the corresponding -'serviceName' in 'ApiOperation'. If '*' used as value for method, + - `method` (`string`): Value for 'method' should be a valid method name for the corresponding +'serviceName' in 'ApiOperation'. If '*' used as value for method, then ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object. - - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the + - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object. **Returns**: @@ -526,10 +526,10 @@ Terraform sub block. **Args**: - `identities` (`list`): A list of identities that are allowed access through this ingress policy. -Should be in the format of email address. The email address should represent +Should be in the format of email address. The email address should represent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object. - - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the -perimeter. If left unspecified, then members of 'identities' field will be + - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the +perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object. - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_from.sources.new](#fn-service_perimetersservice_perimetersspecingress_policiessourcesnew) constructor. @@ -554,19 +554,19 @@ Terraform sub block. **Args**: - - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the -'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed + - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the +'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed must be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent -'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, -resources within the perimeter can only be accessed via Google Cloud calls -with request origins within the perimeter. -Example 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' +'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, +resources within the perimeter can only be accessed via Google Cloud calls +with request origins within the perimeter. +Example 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' If * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object. - - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. -Requests from these resources will be allowed to access perimeter data. -Currently only projects are allowed. Format 'projects/{project_number}' -The project may be in any Google Cloud organization, not just the -organization that the perimeter is defined in. '*' is not allowed, the case + - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. +Requests from these resources will be allowed to access perimeter data. +Currently only projects are allowed. Format 'projects/{project_number}' +The project may be in any Google Cloud organization, not just the +organization that the perimeter is defined in. '*' is not allowed, the case of allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object. **Returns**: @@ -590,15 +590,15 @@ Terraform sub block. **Args**: - - `resources` (`list`): A list of resources, currently only projects in the form + - `resources` (`list`): A list of resources, currently only projects in the form 'projects/<projectnumber>', protected by this 'ServicePerimeter' that are allowed to be accessed by sources defined in the corresponding 'IngressFrom'. A request matches if it contains a resource in this list. If '*' is specified for resources, -then this 'IngressTo' rule will authorize access to all +then this 'IngressTo' rule will authorize access to all resources inside the perimeter, provided that the request also matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object. - - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' + - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' are allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.operations.new](#fn-service_perimetersservice_perimetersspecingress_policiesoperationsnew) constructor. **Returns**: @@ -622,12 +622,12 @@ Terraform sub block. **Args**: - - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or -'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' + - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or +'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' field set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object. - - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to -the service specified by serviceName field. A single 'MethodSelector' entry -with '*' specified for the method field will allow all methods AND + - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to +the service specified by serviceName field. A single 'MethodSelector' entry +with '*' specified for the method field will allow all methods AND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.spec.ingress_policies.ingress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersspecingress_policiesingress_tomethod_selectorsnew) constructor. **Returns**: @@ -651,10 +651,10 @@ Terraform sub block. **Args**: - - `method` (`string`): Value for method should be a valid method name for the corresponding -serviceName in 'ApiOperation'. If '*' used as value for 'method', then + - `method` (`string`): Value for method should be a valid method name for the corresponding +serviceName in 'ApiOperation'. If '*' used as value for 'method', then ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object. - - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the + - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object. **Returns**: @@ -722,9 +722,9 @@ restrictions. Must contain a list of services. For example, if 'storage.googleapis.com' is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. When `null`, the `restricted_services` field will be omitted from the resulting object. - - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may + - `egress_policies` (`list[obj]`): List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. -Access is granted if any EgressPolicy grants it. Must be empty for +Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. When `null`, the `egress_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.new](#fn-service_perimetersservice_perimetersegress_policiesnew) constructor. - `ingress_policies` (`list[obj]`): List of 'IngressPolicies' to apply to the perimeter. A perimeter may have multiple 'IngressPolicies', each of which is evaluated @@ -755,7 +755,7 @@ Terraform sub block. **Args**: - `egress_from` (`list[obj]`): Defines conditions on the source of a request causing this 'EgressPolicy' to apply. When `null`, the `egress_from` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_from.new](#fn-service_perimetersservice_perimetersstatusegress_fromnew) constructor. - - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that + - `egress_to` (`list[obj]`): Defines the conditions on the 'ApiOperation' and destination resources that cause this 'EgressPolicy' to apply. When `null`, the `egress_to` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.new](#fn-service_perimetersservice_perimetersstatusegress_tonew) constructor. **Returns**: @@ -779,11 +779,11 @@ Terraform sub block. **Args**: - - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. -Should be in the format of email address. The email address should + - `identities` (`list`): A list of identities that are allowed access through this 'EgressPolicy'. +Should be in the format of email address. The email address should represent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object. - - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the -perimeter. If left unspecified, then members of 'identities' field will + - `identity_type` (`string`): Specifies the type of identities that are allowed access to outside the +perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object. **Returns**: @@ -810,12 +810,12 @@ Terraform sub block. - `external_resources` (`list`): A list of external resources that are allowed to be accessed. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed. When `null`, the `external_resources` field will be omitted from the resulting object. - - `resources` (`list`): A list of resources, currently only projects in the form -'projects/<projectnumber>', that match this to stanza. A request matches -if it contains a resource in this list. If * is specified for resources, -then this 'EgressTo' rule will authorize access to all resources outside + - `resources` (`list`): A list of resources, currently only projects in the form +'projects/<projectnumber>', that match this to stanza. A request matches +if it contains a resource in this list. If * is specified for resources, +then this 'EgressTo' rule will authorize access to all resources outside the perimeter. When `null`, the `resources` field will be omitted from the resulting object. - - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches + - `operations` (`list[obj]`): A list of 'ApiOperations' that this egress rule applies to. A request matches if it contains an operation/service in this list. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.operations.new](#fn-service_perimetersservice_perimetersstatusegress_policiesoperationsnew) constructor. **Returns**: @@ -839,12 +839,12 @@ Terraform sub block. **Args**: - - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or -'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName + - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or +'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName field set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object. - - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong -to the service specified by 'serviceName' field. A single MethodSelector -entry with '*' specified for the 'method' field will allow all methods + - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong +to the service specified by 'serviceName' field. A single MethodSelector +entry with '*' specified for the 'method' field will allow all methods AND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.egress_policies.egress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersstatusegress_policiesegress_tomethod_selectorsnew) constructor. **Returns**: @@ -868,10 +868,10 @@ Terraform sub block. **Args**: - - `method` (`string`): Value for 'method' should be a valid method name for the corresponding -'serviceName' in 'ApiOperation'. If '*' used as value for method, + - `method` (`string`): Value for 'method' should be a valid method name for the corresponding +'serviceName' in 'ApiOperation'. If '*' used as value for method, then ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object. - - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the + - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object. **Returns**: @@ -922,10 +922,10 @@ Terraform sub block. **Args**: - `identities` (`list`): A list of identities that are allowed access through this ingress policy. -Should be in the format of email address. The email address should represent +Should be in the format of email address. The email address should represent individual user or service account only. When `null`, the `identities` field will be omitted from the resulting object. - - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the -perimeter. If left unspecified, then members of 'identities' field will be + - `identity_type` (`string`): Specifies the type of identities that are allowed access from outside the +perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"] When `null`, the `identity_type` field will be omitted from the resulting object. - `sources` (`list[obj]`): Sources that this 'IngressPolicy' authorizes access from. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_from.sources.new](#fn-service_perimetersservice_perimetersstatusingress_policiessourcesnew) constructor. @@ -950,19 +950,19 @@ Terraform sub block. **Args**: - - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the -'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed + - `access_level` (`string`): An 'AccessLevel' resource name that allow resources within the +'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed must be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent -'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, -resources within the perimeter can only be accessed via Google Cloud calls -with request origins within the perimeter. -Example 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' +'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, +resources within the perimeter can only be accessed via Google Cloud calls +with request origins within the perimeter. +Example 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' If * is specified, then all IngressSources will be allowed. When `null`, the `access_level` field will be omitted from the resulting object. - - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. -Requests from these resources will be allowed to access perimeter data. -Currently only projects are allowed. Format 'projects/{project_number}' -The project may be in any Google Cloud organization, not just the -organization that the perimeter is defined in. '*' is not allowed, the case + - `resource` (`string`): A Google Cloud resource that is allowed to ingress the perimeter. +Requests from these resources will be allowed to access perimeter data. +Currently only projects are allowed. Format 'projects/{project_number}' +The project may be in any Google Cloud organization, not just the +organization that the perimeter is defined in. '*' is not allowed, the case of allowing all Google Cloud resources only is not supported. When `null`, the `resource` field will be omitted from the resulting object. **Returns**: @@ -986,15 +986,15 @@ Terraform sub block. **Args**: - - `resources` (`list`): A list of resources, currently only projects in the form + - `resources` (`list`): A list of resources, currently only projects in the form 'projects/<projectnumber>', protected by this 'ServicePerimeter' that are allowed to be accessed by sources defined in the corresponding 'IngressFrom'. A request matches if it contains a resource in this list. If '*' is specified for resources, -then this 'IngressTo' rule will authorize access to all +then this 'IngressTo' rule will authorize access to all resources inside the perimeter, provided that the request also matches the 'operations' field. When `null`, the `resources` field will be omitted from the resulting object. - - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' + - `operations` (`list[obj]`): A list of 'ApiOperations' the sources specified in corresponding 'IngressFrom' are allowed to perform in this 'ServicePerimeter'. When `null`, the `operations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.operations.new](#fn-service_perimetersservice_perimetersstatusingress_policiesoperationsnew) constructor. **Returns**: @@ -1018,12 +1018,12 @@ Terraform sub block. **Args**: - - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or -'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' + - `service_name` (`string`): The name of the API whose methods or permissions the 'IngressPolicy' or +'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' field set to '*' will allow all methods AND permissions for all services. When `null`, the `service_name` field will be omitted from the resulting object. - - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to -the service specified by serviceName field. A single 'MethodSelector' entry -with '*' specified for the method field will allow all methods AND + - `method_selectors` (`list[obj]`): API methods or permissions to allow. Method or permission must belong to +the service specified by serviceName field. A single 'MethodSelector' entry +with '*' specified for the method field will allow all methods AND permissions for the service specified in 'serviceName'. When `null`, the `method_selectors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_access_context_manager_service_perimeters.service_perimeters.status.ingress_policies.ingress_to.operations.method_selectors.new](#fn-service_perimetersservice_perimetersstatusingress_policiesingress_tomethod_selectorsnew) constructor. **Returns**: @@ -1047,10 +1047,10 @@ Terraform sub block. **Args**: - - `method` (`string`): Value for method should be a valid method name for the corresponding -serviceName in 'ApiOperation'. If '*' used as value for 'method', then + - `method` (`string`): Value for method should be a valid method name for the corresponding +serviceName in 'ApiOperation'. If '*' used as value for 'method', then ALL methods and permissions are allowed. When `null`, the `method` field will be omitted from the resulting object. - - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the + - `permission` (`string`): Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'. When `null`, the `permission` field will be omitted from the resulting object. **Returns**: diff --git a/docs/4.x/google_active_directory_domain.md b/docs/4.x/google_active_directory_domain.md index f387a2c6..d98d11e1 100644 --- a/docs/4.x/google_active_directory_domain.md +++ b/docs/4.x/google_active_directory_domain.md @@ -56,17 +56,17 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `admin` (`string`): The name of delegated administrator account used to perform Active Directory operations. + - `admin` (`string`): The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used. When `null`, the `admin` field will be omitted from the resulting object. - `authorized_networks` (`list`): The full names of the Google Compute Engine networks the domain instance is connected to. The domain is only available on networks listed in authorizedNetworks. If CIDR subnets overlap between networks, domain creation will fail. When `null`, the `authorized_networks` field will be omitted from the resulting object. - - `domain_name` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, + - `domain_name` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, https://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains. - `labels` (`obj`): Resource labels that can contain user-provided metadata When `null`, the `labels` field will be omitted from the resulting object. - - `locations` (`list`): Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/] + - `locations` (`list`): Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/] e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - - `reserved_ip_range` (`string`): The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. + - `reserved_ip_range` (`string`): The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. Ranges must be unique and non-overlapping with existing subnets in authorizedNetworks - `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-beta.google_active_directory_domain.timeouts.new](#fn-timeoutsnew) constructor. @@ -92,17 +92,17 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `admin` (`string`): The name of delegated administrator account used to perform Active Directory operations. + - `admin` (`string`): The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used. When `null`, the `admin` field will be omitted from the resulting object. - `authorized_networks` (`list`): The full names of the Google Compute Engine networks the domain instance is connected to. The domain is only available on networks listed in authorizedNetworks. If CIDR subnets overlap between networks, domain creation will fail. When `null`, the `authorized_networks` field will be omitted from the resulting object. - - `domain_name` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, + - `domain_name` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, https://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains. - `labels` (`obj`): Resource labels that can contain user-provided metadata When `null`, the `labels` field will be omitted from the resulting object. - - `locations` (`list`): Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/] + - `locations` (`list`): Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/] e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - - `reserved_ip_range` (`string`): The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. + - `reserved_ip_range` (`string`): The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. Ranges must be unique and non-overlapping with existing subnets in authorizedNetworks - `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-beta.google_active_directory_domain.timeouts.new](#fn-timeoutsnew) constructor. diff --git a/docs/4.x/google_active_directory_domain_trust.md b/docs/4.x/google_active_directory_domain_trust.md index 973746e3..964269a2 100644 --- a/docs/4.x/google_active_directory_domain_trust.md +++ b/docs/4.x/google_active_directory_domain_trust.md @@ -57,7 +57,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `domain` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, + - `domain` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, https://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `selective_authentication` (`bool`): Whether the trusted side has forest/domain wide access or selective access to an approved set of resources. When `null`, the `selective_authentication` field will be omitted from the resulting object. @@ -90,7 +90,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `domain` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, + - `domain` (`string`): The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions, https://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `selective_authentication` (`bool`): Whether the trusted side has forest/domain wide access or selective access to an approved set of resources. When `null`, the `selective_authentication` field will be omitted from the resulting object. diff --git a/docs/4.x/google_alloydb_backup.md b/docs/4.x/google_alloydb_backup.md index f2c0215b..c5705687 100644 --- a/docs/4.x/google_alloydb_backup.md +++ b/docs/4.x/google_alloydb_backup.md @@ -18,11 +18,15 @@ This package contains functions and utilities for setting up the resource using * [`fn withBackupId()`](#fn-withbackupid) * [`fn withClusterName()`](#fn-withclustername) * [`fn withDescription()`](#fn-withdescription) +* [`fn withEncryptionConfig()`](#fn-withencryptionconfig) +* [`fn withEncryptionConfigMixin()`](#fn-withencryptionconfigmixin) * [`fn withLabels()`](#fn-withlabels) * [`fn withLocation()`](#fn-withlocation) * [`fn withProject()`](#fn-withproject) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj encryption_config`](#obj-encryption_config) + * [`fn new()`](#fn-encryption_confignew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) @@ -61,6 +65,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object. - `location` (`string`): The location where the alloydb backup should reside. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `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-beta.google_alloydb_backup.encryption_config.new](#fn-encryption_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-beta.google_alloydb_backup.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -91,6 +96,7 @@ injecting into a complete block. - `labels` (`obj`): User-defined labels for the alloydb backup. When `null`, the `labels` field will be omitted from the resulting object. - `location` (`string`): The location where the alloydb backup should reside. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `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-beta.google_alloydb_backup.encryption_config.new](#fn-encryption_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-beta.google_alloydb_backup.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -145,6 +151,43 @@ Terraform resource block to set or update the description field. - `value` (`string`): The value to set for the `description` field. +### fn withEncryptionConfig + +```ts +withEncryptionConfig() +``` + +`google-beta.list[obj].withEncryptionConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the encryption_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-beta.list[obj].withEncryptionConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `encryption_config` field. + + +### fn withEncryptionConfigMixin + +```ts +withEncryptionConfigMixin() +``` + +`google-beta.list[obj].withEncryptionConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the encryption_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-beta.list[obj].withEncryptionConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `encryption_config` field. + + ### fn withLabels ```ts @@ -229,6 +272,29 @@ function. - `value` (`obj`): The value to set for the `timeouts` field. +## obj encryption_config + + + +### fn encryption_config.new + +```ts +new() +``` + + +`google-beta.google_alloydb_backup.encryption_config.new` constructs a new object with attributes and blocks configured for the `encryption_config` +Terraform sub block. + + + +**Args**: + - `kms_key_name` (`string`): The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]. When `null`, the `kms_key_name` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `encryption_config` sub block. + + ## obj timeouts diff --git a/docs/4.x/google_alloydb_cluster.md b/docs/4.x/google_alloydb_cluster.md index 9899d187..9cf03d9a 100644 --- a/docs/4.x/google_alloydb_cluster.md +++ b/docs/4.x/google_alloydb_cluster.md @@ -19,6 +19,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withAutomatedBackupPolicyMixin()`](#fn-withautomatedbackuppolicymixin) * [`fn withClusterId()`](#fn-withclusterid) * [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withEncryptionConfig()`](#fn-withencryptionconfig) +* [`fn withEncryptionConfigMixin()`](#fn-withencryptionconfigmixin) * [`fn withInitialUser()`](#fn-withinitialuser) * [`fn withInitialUserMixin()`](#fn-withinitialusermixin) * [`fn withLabels()`](#fn-withlabels) @@ -29,6 +31,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj automated_backup_policy`](#obj-automated_backup_policy) * [`fn new()`](#fn-automated_backup_policynew) + * [`obj automated_backup_policy.encryption_config`](#obj-automated_backup_policyencryption_config) + * [`fn new()`](#fn-automated_backup_policyencryption_confignew) * [`obj automated_backup_policy.quantity_based_retention`](#obj-automated_backup_policyquantity_based_retention) * [`fn new()`](#fn-automated_backup_policyquantity_based_retentionnew) * [`obj automated_backup_policy.time_based_retention`](#obj-automated_backup_policytime_based_retention) @@ -37,6 +41,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-automated_backup_policyweekly_schedulenew) * [`obj automated_backup_policy.weekly_schedule.start_times`](#obj-automated_backup_policyweekly_schedulestart_times) * [`fn new()`](#fn-automated_backup_policyweekly_schedulestart_timesnew) +* [`obj encryption_config`](#obj-encryption_config) + * [`fn new()`](#fn-encryption_confignew) * [`obj initial_user`](#obj-initial_user) * [`fn new()`](#fn-initial_usernew) * [`obj timeouts`](#obj-timeouts) @@ -82,6 +88,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) 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-beta.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-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) 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-beta.google_alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor. @@ -118,6 +125,7 @@ injecting into a complete block. - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. If no policy is provided then the default policy will be used. The default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) 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-beta.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-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) 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-beta.google_alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor. @@ -194,6 +202,43 @@ Terraform resource block to set or update the display_name field. - `value` (`string`): The value to set for the `display_name` field. +### fn withEncryptionConfig + +```ts +withEncryptionConfig() +``` + +`google-beta.list[obj].withEncryptionConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the encryption_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-beta.list[obj].withEncryptionConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `encryption_config` field. + + +### fn withEncryptionConfigMixin + +```ts +withEncryptionConfigMixin() +``` + +`google-beta.list[obj].withEncryptionConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the encryption_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-beta.list[obj].withEncryptionConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `encryption_config` field. + + ### fn withInitialUser ```ts @@ -356,14 +401,38 @@ A duration in seconds with up to nine fractional digits, terminated by 's - `enabled` (`bool`): Whether automated backups are enabled. When `null`, the `enabled` field will be omitted from the resulting object. - `labels` (`obj`): Labels to apply to backups created using this configuration. When `null`, the `labels` field will be omitted from the resulting object. - `location` (`string`): The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. When `null`, the `location` field will be omitted from the resulting object. - - `quantity_based_retention` (`list[obj]`): Quantity-based Backup retention policy to retain recent backups. When `null`, the `quantity_based_retention` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.quantity_based_retention.new](#fn-automated_backup_policyquantity_based_retentionnew) constructor. - - `time_based_retention` (`list[obj]`): Time-based Backup retention policy. When `null`, the `time_based_retention` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.time_based_retention.new](#fn-automated_backup_policytime_based_retentionnew) 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-beta.google_alloydb_cluster.automated_backup_policy.encryption_config.new](#fn-automated_backup_policyencryption_confignew) constructor. + - `quantity_based_retention` (`list[obj]`): Quantity-based Backup retention policy to retain recent backups. Conflicts with 'time_based_retention', both can't be set together. When `null`, the `quantity_based_retention` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.quantity_based_retention.new](#fn-automated_backup_policyquantity_based_retentionnew) constructor. + - `time_based_retention` (`list[obj]`): Time-based Backup retention policy. Conflicts with 'quantity_based_retention', both can't be set together. When `null`, the `time_based_retention` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.time_based_retention.new](#fn-automated_backup_policytime_based_retentionnew) constructor. - `weekly_schedule` (`list[obj]`): Weekly schedule for the Backup. When `null`, the `weekly_schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.weekly_schedule.new](#fn-automated_backup_policyweekly_schedulenew) constructor. **Returns**: - An attribute object that represents the `automated_backup_policy` sub block. +## obj automated_backup_policy.encryption_config + + + +### fn automated_backup_policy.encryption_config.new + +```ts +new() +``` + + +`google-beta.google_alloydb_cluster.automated_backup_policy.encryption_config.new` constructs a new object with attributes and blocks configured for the `encryption_config` +Terraform sub block. + + + +**Args**: + - `kms_key_name` (`string`): The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]. When `null`, the `kms_key_name` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `encryption_config` sub block. + + ## obj automated_backup_policy.quantity_based_retention @@ -453,14 +522,37 @@ Terraform sub block. **Args**: - `hours` (`number`): Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. When `null`, the `hours` field will be omitted from the resulting object. - - `minutes` (`number`): Minutes of hour of day. Must be from 0 to 59. When `null`, the `minutes` field will be omitted from the resulting object. - - `nanos` (`number`): Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. When `null`, the `nanos` field will be omitted from the resulting object. - - `seconds` (`number`): Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. When `null`, the `seconds` field will be omitted from the resulting object. + - `minutes` (`number`): Minutes of hour of day. Currently, only the value 0 is supported. When `null`, the `minutes` field will be omitted from the resulting object. + - `nanos` (`number`): Fractions of seconds in nanoseconds. Currently, only the value 0 is supported. When `null`, the `nanos` field will be omitted from the resulting object. + - `seconds` (`number`): Seconds of minutes of the time. Currently, only the value 0 is supported. When `null`, the `seconds` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `start_times` sub block. +## obj encryption_config + + + +### fn encryption_config.new + +```ts +new() +``` + + +`google-beta.google_alloydb_cluster.encryption_config.new` constructs a new object with attributes and blocks configured for the `encryption_config` +Terraform sub block. + + + +**Args**: + - `kms_key_name` (`string`): The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]. When `null`, the `kms_key_name` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `encryption_config` sub block. + + ## obj initial_user diff --git a/docs/4.x/google_apigee_keystores_aliases_self_signed_cert.md b/docs/4.x/google_apigee_keystores_aliases_self_signed_cert.md index 1f1bfda2..351fe91a 100644 --- a/docs/4.x/google_apigee_keystores_aliases_self_signed_cert.md +++ b/docs/4.x/google_apigee_keystores_aliases_self_signed_cert.md @@ -64,8 +64,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `alias` (`string`): Alias for the key/certificate pair. Values must match the regular expression [\w\s-.]{1,255}. -This must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either + - `alias` (`string`): Alias for the key/certificate pair. Values must match the regular expression [\w\s-.]{1,255}. +This must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either this parameter or the JSON body. - `cert_validity_in_days` (`number`): Validity duration of certificate, in days. Accepts positive non-zero value. Defaults to 365. When `null`, the `cert_validity_in_days` field will be omitted from the resulting object. - `environment` (`string`): The Apigee environment name @@ -99,8 +99,8 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `alias` (`string`): Alias for the key/certificate pair. Values must match the regular expression [\w\s-.]{1,255}. -This must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either + - `alias` (`string`): Alias for the key/certificate pair. Values must match the regular expression [\w\s-.]{1,255}. +This must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either this parameter or the JSON body. - `cert_validity_in_days` (`number`): Validity duration of certificate, in days. Accepts positive non-zero value. Defaults to 365. When `null`, the `cert_validity_in_days` field will be omitted from the resulting object. - `environment` (`string`): The Apigee environment name diff --git a/docs/4.x/google_billing_budget.md b/docs/4.x/google_billing_budget.md index b876cd4d..a57f7694 100644 --- a/docs/4.x/google_billing_budget.md +++ b/docs/4.x/google_billing_budget.md @@ -517,7 +517,7 @@ Terraform sub block. **Args**: - - `end_date` (`list[obj]`): Optional. The end date of the time period. Budgets with elapsed end date won't be processed. + - `end_date` (`list[obj]`): Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the startDate. When `null`, the `end_date` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_billing_budget.budget_filter.custom_period.end_date.new](#fn-budget_filterbudget_filterend_datenew) constructor. - `start_date` (`list[obj]`): A start date is required. The start date must be after January 1, 2017. When `null`, the `start_date` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_billing_budget.budget_filter.custom_period.start_date.new](#fn-budget_filterbudget_filterstart_datenew) constructor. diff --git a/docs/4.x/google_certificate_manager_certificate.md b/docs/4.x/google_certificate_manager_certificate.md index 9bc8b1f2..032b7530 100644 --- a/docs/4.x/google_certificate_manager_certificate.md +++ b/docs/4.x/google_certificate_manager_certificate.md @@ -17,6 +17,7 @@ This package contains functions and utilities for setting up the resource using * [`fn newAttrs()`](#fn-newattrs) * [`fn withDescription()`](#fn-withdescription) * [`fn withLabels()`](#fn-withlabels) +* [`fn withLocation()`](#fn-withlocation) * [`fn withManaged()`](#fn-withmanaged) * [`fn withManagedMixin()`](#fn-withmanagedmixin) * [`fn withName()`](#fn-withname) @@ -64,6 +65,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `description` (`string`): A human-readable description of the resource. When `null`, the `description` field will be omitted from the resulting object. - `labels` (`obj`): Set of label tags associated with the Certificate resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The Certificate Manager location. If not specified, "global" is used. When `null`, the `location` field will be omitted from the resulting object. - `name` (`string`): A user-defined name of the certificate. Certificate names must be unique The name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter, and all following characters must be a dash, underscore, letter or digit. @@ -108,6 +110,7 @@ injecting into a complete block. **Args**: - `description` (`string`): A human-readable description of the resource. When `null`, the `description` field will be omitted from the resulting object. - `labels` (`obj`): Set of label tags associated with the Certificate resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The Certificate Manager location. If not specified, "global" is used. When `null`, the `location` field will be omitted from the resulting object. - `name` (`string`): A user-defined name of the certificate. Certificate names must be unique The name must be 1-64 characters long, and match the regular expression [a-zA-Z][a-zA-Z0-9_-]* which means the first character must be a letter, and all following characters must be a dash, underscore, letter or digit. @@ -164,6 +167,22 @@ Terraform resource block to set or update the labels field. - `value` (`obj`): The value to set for the `labels` field. +### fn withLocation + +```ts +withLocation() +``` + +`google-beta.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 withManaged ```ts diff --git a/docs/4.x/google_certificate_manager_certificate_map_entry.md b/docs/4.x/google_certificate_manager_certificate_map_entry.md index c5faf30c..5da8d28e 100644 --- a/docs/4.x/google_certificate_manager_certificate_map_entry.md +++ b/docs/4.x/google_certificate_manager_certificate_map_entry.md @@ -69,8 +69,8 @@ An object containing 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. - `map` (`string`): A map entry that is inputted into the cetrificate map - `matcher` (`string`): A predefined matcher for particular cases, other than SNI selection When `null`, the `matcher` field will be omitted from the resulting object. - - `name` (`string`): A user-defined name of the Certificate Map Entry. Certificate Map Entry -names must be unique globally and match pattern + - `name` (`string`): A user-defined name of the Certificate Map Entry. Certificate Map Entry +names must be unique globally and match pattern 'projects/*/locations/*/certificateMaps/*/certificateMapEntries/*' - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate_map_entry.timeouts.new](#fn-timeoutsnew) constructor. @@ -109,8 +109,8 @@ An object containing 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. - `map` (`string`): A map entry that is inputted into the cetrificate map - `matcher` (`string`): A predefined matcher for particular cases, other than SNI selection When `null`, the `matcher` field will be omitted from the resulting object. - - `name` (`string`): A user-defined name of the Certificate Map Entry. Certificate Map Entry -names must be unique globally and match pattern + - `name` (`string`): A user-defined name of the Certificate Map Entry. Certificate Map Entry +names must be unique globally and match pattern 'projects/*/locations/*/certificateMaps/*/certificateMapEntries/*' - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_certificate_map_entry.timeouts.new](#fn-timeoutsnew) constructor. diff --git a/docs/4.x/google_cloud_asset_folder_feed.md b/docs/4.x/google_cloud_asset_folder_feed.md index 426ba4f8..72c60224 100644 --- a/docs/4.x/google_cloud_asset_folder_feed.md +++ b/docs/4.x/google_cloud_asset_folder_feed.md @@ -65,7 +65,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of + - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of assetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object. @@ -75,7 +75,7 @@ the feed. For example: "compute.googleapis.com/Disk" See https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all supported asset types. When `null`, the `asset_types` field will be omitted from the resulting object. - `billing_project` (`string`): The project whose identity will be used when sending messages to the -destination pubsub topic. It also specifies the project for API +destination pubsub topic. It also specifies the project for API enablement check, quota, and billing. - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object. - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent. @@ -110,7 +110,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of + - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of assetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object. @@ -120,7 +120,7 @@ the feed. For example: "compute.googleapis.com/Disk" See https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all supported asset types. When `null`, the `asset_types` field will be omitted from the resulting object. - `billing_project` (`string`): The project whose identity will be used when sending messages to the -destination pubsub topic. It also specifies the project for API +destination pubsub topic. It also specifies the project for API enablement check, quota, and billing. - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object. - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent. @@ -363,7 +363,7 @@ Terraform sub block. - `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 + - `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. diff --git a/docs/4.x/google_cloud_asset_organization_feed.md b/docs/4.x/google_cloud_asset_organization_feed.md index 5987de1e..2ececcaa 100644 --- a/docs/4.x/google_cloud_asset_organization_feed.md +++ b/docs/4.x/google_cloud_asset_organization_feed.md @@ -65,7 +65,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of + - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of assetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object. @@ -75,7 +75,7 @@ the feed. For example: "compute.googleapis.com/Disk" See https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all supported asset types. When `null`, the `asset_types` field will be omitted from the resulting object. - `billing_project` (`string`): The project whose identity will be used when sending messages to the -destination pubsub topic. It also specifies the project for API +destination pubsub topic. It also specifies the project for API enablement check, quota, and billing. - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object. - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent. @@ -110,7 +110,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of + - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of assetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object. @@ -120,7 +120,7 @@ the feed. For example: "compute.googleapis.com/Disk" See https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all supported asset types. When `null`, the `asset_types` field will be omitted from the resulting object. - `billing_project` (`string`): The project whose identity will be used when sending messages to the -destination pubsub topic. It also specifies the project for API +destination pubsub topic. It also specifies the project for API enablement check, quota, and billing. - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object. - `feed_id` (`string`): This is the client-assigned asset feed identifier and it needs to be unique under a specific parent. @@ -363,7 +363,7 @@ Terraform sub block. - `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 + - `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. diff --git a/docs/4.x/google_cloud_asset_project_feed.md b/docs/4.x/google_cloud_asset_project_feed.md index 0f241e92..69c1e05f 100644 --- a/docs/4.x/google_cloud_asset_project_feed.md +++ b/docs/4.x/google_cloud_asset_project_feed.md @@ -65,7 +65,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of + - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of assetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object. @@ -75,7 +75,7 @@ the feed. For example: "compute.googleapis.com/Disk" See https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all supported asset types. When `null`, the `asset_types` field will be omitted from the resulting object. - `billing_project` (`string`): The project whose identity will be used when sending messages to the -destination pubsub topic. It also specifies the project for API +destination pubsub topic. It also specifies the project for API enablement check, quota, and billing. If not specified, the resource's project will be used. When `null`, the `billing_project` field will be omitted from the resulting object. - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object. @@ -111,7 +111,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of + - `asset_names` (`list`): A list of the full names of the assets to receive updates. You must specify either or both of assetNames and assetTypes. Only asset updates matching specified assetNames and assetTypes are exported to the feed. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See https://cloud.google.com/apis/design/resourceNames#fullResourceName for more info. When `null`, the `asset_names` field will be omitted from the resulting object. @@ -121,7 +121,7 @@ the feed. For example: "compute.googleapis.com/Disk" See https://cloud.google.com/asset-inventory/docs/supported-asset-types for a list of all supported asset types. When `null`, the `asset_types` field will be omitted from the resulting object. - `billing_project` (`string`): The project whose identity will be used when sending messages to the -destination pubsub topic. It also specifies the project for API +destination pubsub topic. It also specifies the project for API enablement check, quota, and billing. If not specified, the resource's project will be used. When `null`, the `billing_project` field will be omitted from the resulting object. - `content_type` (`string`): Asset content type. If not specified, no content but the asset name and type will be returned. Possible values: ["CONTENT_TYPE_UNSPECIFIED", "RESOURCE", "IAM_POLICY", "ORG_POLICY", "OS_INVENTORY", "ACCESS_POLICY"] When `null`, the `content_type` field will be omitted from the resulting object. @@ -365,7 +365,7 @@ Terraform sub block. - `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 + - `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. diff --git a/docs/4.x/google_cloud_run_service.md b/docs/4.x/google_cloud_run_service.md index 093b10bd..892ab830 100644 --- a/docs/4.x/google_cloud_run_service.md +++ b/docs/4.x/google_cloud_run_service.md @@ -705,10 +705,10 @@ Terraform sub block. **Args**: - `key` (`string`): A Cloud Secret Manager secret version. Must be 'latest' for the latest version or an integer for a specific version. - - `name` (`string`): The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. -If the secret is in another project, you must define an alias. -An alias definition has the form: :projects/{project-id|project-number}/secrets/. -If multiple alias definitions are needed, they must be separated by commas. + - `name` (`string`): The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. +If the secret is in another project, you must define an alias. +An alias definition has the form: :projects/{project-id|project-number}/secrets/. +If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. **Returns**: @@ -885,7 +885,8 @@ Terraform sub block. **Args**: - - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. When `null`, the `port` field will be omitted from the resulting object. + - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. +If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object. @@ -912,6 +913,8 @@ Terraform sub block. **Args**: - `path` (`string`): Path to access on the HTTP server. If set, it should not be empty string. When `null`, the `path` field will be omitted from the resulting object. + - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. +If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_service.template.spec.containers.liveness_probe.http_get.http_headers.new](#fn-templatetemplatespeccontainersliveness_probehttp_headersnew) constructor. **Returns**: @@ -1049,7 +1052,8 @@ Terraform sub block. **Args**: - - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. When `null`, the `port` field will be omitted from the resulting object. + - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. +If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object. @@ -1076,6 +1080,8 @@ Terraform sub block. **Args**: - `path` (`string`): Path to access on the HTTP server. If set, it should not be empty string. When `null`, the `path` field will be omitted from the resulting object. + - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. +If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_service.template.spec.containers.startup_probe.http_get.http_headers.new](#fn-templatetemplatespeccontainersstartup_probehttp_headersnew) constructor. **Returns**: @@ -1123,7 +1129,8 @@ Terraform sub block. **Args**: - - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. When `null`, the `port` field will be omitted from the resulting object. + - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. +If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `tcp_socket` sub block. diff --git a/docs/4.x/google_cloud_run_v2_job.md b/docs/4.x/google_cloud_run_v2_job.md index 74858552..7d5615b6 100644 --- a/docs/4.x/google_cloud_run_v2_job.md +++ b/docs/4.x/google_cloud_run_v2_job.md @@ -109,7 +109,10 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `client` (`string`): Arbitrary identifier for the API client. When `null`, the `client` field will be omitted from the resulting object. - `client_version` (`string`): Arbitrary version identifier for the API client. When `null`, the `client_version` field will be omitted from the resulting object. - `labels` (`obj`): KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object. - - `launch_stage` (`string`): The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object. + - `launch_stage` (`string`): The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA. +If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. + +For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object. - `location` (`string`): The location of the cloud run job When `null`, the `location` field will be omitted from the resulting object. - `name` (`string`): Name of the Job. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. @@ -142,7 +145,10 @@ injecting into a complete block. - `client` (`string`): Arbitrary identifier for the API client. When `null`, the `client` field will be omitted from the resulting object. - `client_version` (`string`): Arbitrary version identifier for the API client. When `null`, the `client_version` field will be omitted from the resulting object. - `labels` (`obj`): KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object. - - `launch_stage` (`string`): The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object. + - `launch_stage` (`string`): The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA. +If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. + +For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object. - `location` (`string`): The location of the cloud run job When `null`, the `location` field will be omitted from the resulting object. - `name` (`string`): Name of the Job. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. diff --git a/docs/4.x/google_cloud_run_v2_service.md b/docs/4.x/google_cloud_run_v2_service.md index 8f77b087..34fc9cb6 100644 --- a/docs/4.x/google_cloud_run_v2_service.md +++ b/docs/4.x/google_cloud_run_v2_service.md @@ -123,7 +123,10 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `description` (`string`): User-provided description of the Service. This field currently has a 512-character limit. When `null`, the `description` field will be omitted from the resulting object. - `ingress` (`string`): Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Possible values: ["INGRESS_TRAFFIC_ALL", "INGRESS_TRAFFIC_INTERNAL_ONLY", "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER"] When `null`, the `ingress` field will be omitted from the resulting object. - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object. - - `launch_stage` (`string`): The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object. + - `launch_stage` (`string`): The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA. +If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. + +For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object. - `location` (`string`): The location of the cloud run service When `null`, the `location` field will be omitted from the resulting object. - `name` (`string`): Name of the Service. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. @@ -160,7 +163,10 @@ injecting into a complete block. - `description` (`string`): User-provided description of the Service. This field currently has a 512-character limit. When `null`, the `description` field will be omitted from the resulting object. - `ingress` (`string`): Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Possible values: ["INGRESS_TRAFFIC_ALL", "INGRESS_TRAFFIC_INTERNAL_ONLY", "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER"] When `null`, the `ingress` field will be omitted from the resulting object. - `labels` (`obj`): Map of string keys and values that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved. When `null`, the `labels` field will be omitted from the resulting object. - - `launch_stage` (`string`): The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object. + - `launch_stage` (`string`): The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA. +If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. + +For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When `null`, the `launch_stage` field will be omitted from the resulting object. - `location` (`string`): The location of the cloud run service When `null`, the `location` field will be omitted from the resulting object. - `name` (`string`): Name of the Service. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. @@ -528,6 +534,7 @@ Terraform sub block. - `max_instance_request_concurrency` (`number`): Sets the maximum number of requests that each serving instance can receive. When `null`, the `max_instance_request_concurrency` field will be omitted from the resulting object. - `revision` (`string`): The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name. When `null`, the `revision` field will be omitted from the resulting object. - `service_account` (`string`): Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. When `null`, the `service_account` field will be omitted from the resulting object. + - `session_affinity` (`bool`): Enables session affinity. For more information, go to https://cloud.google.com/run/docs/configuring/session-affinity When `null`, the `session_affinity` field will be omitted from the resulting object. - `timeout` (`string`): Max allowed time for an instance to respond to a request. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". When `null`, the `timeout` field will be omitted from the resulting object. @@ -693,7 +700,8 @@ Terraform sub block. **Args**: - - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. + - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. +If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object. @@ -720,6 +728,8 @@ Terraform sub block. **Args**: - `path` (`string`): Path to access on the HTTP server. Defaults to '/'. When `null`, the `path` field will be omitted from the resulting object. + - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. +If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.liveness_probe.http_get.http_headers.new](#fn-templatetemplatecontainersliveness_probehttp_headersnew) constructor. **Returns**: @@ -816,6 +826,7 @@ Terraform sub block. **Args**: - `cpu_idle` (`bool`): Determines whether CPU should be throttled or not outside of requests. When `null`, the `cpu_idle` field will be omitted from the resulting object. - `limits` (`obj`): Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go When `null`, the `limits` field will be omitted from the resulting object. + - `startup_cpu_boost` (`bool`): Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. When `null`, the `startup_cpu_boost` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `resources` sub block. @@ -867,7 +878,8 @@ Terraform sub block. **Args**: - - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. + - `port` (`number`): Port number to access on the container. Number must be in the range 1 to 65535. +If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. - `service` (`string`): The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. When `null`, the `service` field will be omitted from the resulting object. @@ -894,6 +906,8 @@ Terraform sub block. **Args**: - `path` (`string`): Path to access on the HTTP server. Defaults to '/'. When `null`, the `path` field will be omitted from the resulting object. + - `port` (`number`): Port number to access on the container. Must be in the range 1 to 65535. +If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. - `http_headers` (`list[obj]`): Custom headers to set in the request. HTTP allows repeated headers. When `null`, the `http_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_run_v2_service.template.containers.startup_probe.http_get.http_headers.new](#fn-templatetemplatecontainersstartup_probehttp_headersnew) constructor. **Returns**: @@ -941,7 +955,8 @@ Terraform sub block. **Args**: - - `port` (`number`): Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to 8080. When `null`, the `port` field will be omitted from the resulting object. + - `port` (`number`): Port number to access on the container. Must be in the range 1 to 65535. +If not specified, defaults to the same value as container.ports[0].containerPort. When `null`, the `port` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `tcp_socket` sub block. diff --git a/docs/4.x/google_cloud_scheduler_job.md b/docs/4.x/google_cloud_scheduler_job.md index 9354def7..b6c3bbda 100644 --- a/docs/4.x/google_cloud_scheduler_job.md +++ b/docs/4.x/google_cloud_scheduler_job.md @@ -87,7 +87,7 @@ The allowed duration for this deadline is: * For App Engine HTTP targets, between 15 seconds and 24 hours. * **Note**: For PubSub targets, this field is ignored - setting it will introduce an unresolvable diff. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s" When `null`, the `attempt_deadline` field will be omitted from the resulting object. - - `description` (`string`): A human-readable description for the job. + - `description` (`string`): A human-readable description for the job. This string must not contain more than 500 characters. When `null`, the `description` field will be omitted from the resulting object. - `name` (`string`): The name of the job. - `paused` (`bool`): Sets the job to a paused state. Jobs default to being enabled when this property is not set. When `null`, the `paused` field will be omitted from the resulting object. @@ -97,16 +97,16 @@ This string must not contain more than 500 characters. When `null`, the `descrip - `time_zone` (`string`): Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database. When `null`, the `time_zone` field will be omitted from the resulting object. - `app_engine_http_target` (`list[obj]`): App Engine HTTP target. -If the job providers a App Engine HTTP target the cron will +If the job providers a App Engine HTTP target the cron will send a request to the service instance When `null`, the `app_engine_http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.app_engine_http_target.new](#fn-app_engine_http_targetnew) constructor. - `http_target` (`list[obj]`): HTTP target. -If the job providers a http_target the cron will +If the job providers a http_target the cron will send a request to the targeted url When `null`, the `http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.http_target.new](#fn-http_targetnew) constructor. - `pubsub_target` (`list[obj]`): Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic When `null`, the `pubsub_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.pubsub_target.new](#fn-pubsub_targetnew) constructor. - - `retry_config` (`list[obj]`): By default, if a job does not complete successfully, -meaning that an acknowledgement is not received from the handler, + - `retry_config` (`list[obj]`): By default, if a job does not complete successfully, +meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings When `null`, the `retry_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-beta.google_cloud_scheduler_job.retry_config.new](#fn-retry_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-beta.google_cloud_scheduler_job.timeouts.new](#fn-timeoutsnew) constructor. @@ -140,7 +140,7 @@ The allowed duration for this deadline is: * For App Engine HTTP targets, between 15 seconds and 24 hours. * **Note**: For PubSub targets, this field is ignored - setting it will introduce an unresolvable diff. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s" When `null`, the `attempt_deadline` field will be omitted from the resulting object. - - `description` (`string`): A human-readable description for the job. + - `description` (`string`): A human-readable description for the job. This string must not contain more than 500 characters. When `null`, the `description` field will be omitted from the resulting object. - `name` (`string`): The name of the job. - `paused` (`bool`): Sets the job to a paused state. Jobs default to being enabled when this property is not set. When `null`, the `paused` field will be omitted from the resulting object. @@ -150,16 +150,16 @@ This string must not contain more than 500 characters. When `null`, the `descrip - `time_zone` (`string`): Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database. When `null`, the `time_zone` field will be omitted from the resulting object. - `app_engine_http_target` (`list[obj]`): App Engine HTTP target. -If the job providers a App Engine HTTP target the cron will +If the job providers a App Engine HTTP target the cron will send a request to the service instance When `null`, the `app_engine_http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.app_engine_http_target.new](#fn-app_engine_http_targetnew) constructor. - `http_target` (`list[obj]`): HTTP target. -If the job providers a http_target the cron will +If the job providers a http_target the cron will send a request to the targeted url When `null`, the `http_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.http_target.new](#fn-http_targetnew) constructor. - `pubsub_target` (`list[obj]`): Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic When `null`, the `pubsub_target` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.pubsub_target.new](#fn-pubsub_targetnew) constructor. - - `retry_config` (`list[obj]`): By default, if a job does not complete successfully, -meaning that an acknowledgement is not received from the handler, + - `retry_config` (`list[obj]`): By default, if a job does not complete successfully, +meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings When `null`, the `retry_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-beta.google_cloud_scheduler_job.retry_config.new](#fn-retry_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-beta.google_cloud_scheduler_job.timeouts.new](#fn-timeoutsnew) constructor. @@ -496,19 +496,19 @@ Terraform sub block. **Args**: - - `body` (`string`): HTTP request body. -A request body is allowed only if the HTTP method is POST or PUT. + - `body` (`string`): HTTP request body. +A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod. A base64-encoded string. When `null`, the `body` field will be omitted from the resulting object. - `headers` (`obj`): HTTP request headers. -This map contains the header field names and values. +This map contains the header field names and values. Headers can be set when the job is created. When `null`, the `headers` field will be omitted from the resulting object. - `http_method` (`string`): Which HTTP method to use for the request. When `null`, the `http_method` field will be omitted from the resulting object. - `relative_uri` (`string`): The relative URI. -The relative URL must begin with "/" and must be a valid HTTP relative URL. -It can contain a path, query string arguments, and \# fragments. -If the relative URL is empty, then the root path "/" will be used. +The relative URL must begin with "/" and must be a valid HTTP relative URL. +It can contain a path, query string arguments, and \# fragments. +If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters - `app_engine_routing` (`list[obj]`): App Engine Routing setting for the job. When `null`, the `app_engine_routing` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloud_scheduler_job.app_engine_http_target.app_engine_routing.new](#fn-app_engine_http_targetapp_engine_routingnew) constructor. @@ -561,12 +561,12 @@ Terraform sub block. **Args**: - - `body` (`string`): HTTP request body. -A request body is allowed only if the HTTP method is POST, PUT, or PATCH. + - `body` (`string`): HTTP request body. +A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod. A base64-encoded string. When `null`, the `body` field will be omitted from the resulting object. - - `headers` (`obj`): This map contains the header field names and values. + - `headers` (`obj`): This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. When `null`, the `headers` field will be omitted from the resulting object. - `http_method` (`string`): Which HTTP method to use for the request. When `null`, the `http_method` field will be omitted from the resulting object. - `uri` (`string`): The full URI path that the request will be sent to. @@ -683,15 +683,15 @@ Terraform sub block. - `max_backoff_duration` (`string`): The maximum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by 's'. When `null`, the `max_backoff_duration` field will be omitted from the resulting object. - `max_doublings` (`number`): The time between retries will double maxDoublings times. -A job's retry interval starts at minBackoffDuration, -then doubles maxDoublings times, then increases linearly, +A job's retry interval starts at minBackoffDuration, +then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoffDuration up to retryCount times. When `null`, the `max_doublings` field will be omitted from the resulting object. - - `max_retry_duration` (`string`): The time limit for retrying a failed job, measured from time when an execution was first attempted. + - `max_retry_duration` (`string`): The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retryCount, the job will be retried until both limits are reached. A duration in seconds with up to nine fractional digits, terminated by 's'. When `null`, the `max_retry_duration` field will be omitted from the resulting object. - `min_backoff_duration` (`string`): The minimum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by 's'. When `null`, the `min_backoff_duration` field will be omitted from the resulting object. - - `retry_count` (`number`): The number of attempts that the system will make to run a + - `retry_count` (`number`): The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings. Values greater than 5 and negative values are not allowed. When `null`, the `retry_count` field will be omitted from the resulting object. diff --git a/docs/4.x/google_cloudbuild_bitbucket_server_config.md b/docs/4.x/google_cloudbuild_bitbucket_server_config.md index 2c3cb28e..94af290a 100644 --- a/docs/4.x/google_cloudbuild_bitbucket_server_config.md +++ b/docs/4.x/google_cloudbuild_bitbucket_server_config.md @@ -71,9 +71,9 @@ Changing this field will result in deleting/ recreating the resource. - `host_uri` (`string`): Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - `location` (`string`): The location of this bitbucket server config. - - `peered_network` (`string`): The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. -This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, -no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format + - `peered_network` (`string`): The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. +This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, +no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project. When `null`, the `peered_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. - `ssl_ca` (`string`): SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of .pem, .cer, or .crt. When `null`, the `ssl_ca` field will be omitted from the resulting object. @@ -110,9 +110,9 @@ Changing this field will result in deleting/ recreating the resource. - `host_uri` (`string`): Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - `location` (`string`): The location of this bitbucket server config. - - `peered_network` (`string`): The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. -This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, -no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format + - `peered_network` (`string`): The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. +This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, +no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project. When `null`, the `peered_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. - `ssl_ca` (`string`): SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of .pem, .cer, or .crt. When `null`, the `ssl_ca` field will be omitted from the resulting object. diff --git a/docs/4.x/google_cloudbuild_trigger.md b/docs/4.x/google_cloudbuild_trigger.md index 63e2a7fa..8fbd9364 100644 --- a/docs/4.x/google_cloudbuild_trigger.md +++ b/docs/4.x/google_cloudbuild_trigger.md @@ -140,7 +140,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `description` (`string`): Human-readable description of the trigger. When `null`, the `description` field will be omitted from the resulting object. - `disabled` (`bool`): Whether the trigger is disabled or not. If true, the trigger will never result in a build. When `null`, the `disabled` field will be omitted from the resulting object. - - `filename` (`string`): Path, from the source root, to a file whose contents is used for the template. + - `filename` (`string`): Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided. Set this only when using trigger_template or github. When using Pub/Sub, Webhook or Manual set the file name using git_file_source instead. When `null`, the `filename` field will be omitted from the resulting object. - `filter` (`string`): A Common Expression Language string. Used only with Pub/Sub and Webhook. When `null`, the `filter` field will be omitted from the resulting object. @@ -180,8 +180,8 @@ If no service account is set, then the standard Cloud Build service account Format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL} When `null`, the `service_account` field will be omitted from the resulting object. - `substitutions` (`obj`): Substitutions data for Build resource. When `null`, the `substitutions` field will be omitted from the resulting object. - `tags` (`list`): Tags for annotation of a BuildTrigger When `null`, the `tags` field will be omitted from the resulting object. - - `approval_config` (`list[obj]`): Configuration for manual approval to start a build invocation of this BuildTrigger. -Builds created by this trigger will require approval before they execute. + - `approval_config` (`list[obj]`): Configuration for manual approval to start a build invocation of this BuildTrigger. +Builds created by this trigger will require approval before they execute. Any user with a Cloud Build Approver role for the project can approve a build. When `null`, the `approval_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-beta.google_cloudbuild_trigger.approval_config.new](#fn-approval_confignew) constructor. - `bitbucket_server_trigger_config` (`list[obj]`): BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. When `null`, the `bitbucket_server_trigger_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-beta.google_cloudbuild_trigger.bitbucket_server_trigger_config.new](#fn-bitbucket_server_trigger_confignew) constructor. - `build` (`list[obj]`): Contents of the build template. Either a filename or build template must be provided. When `null`, the `build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.new](#fn-buildnew) constructor. @@ -189,14 +189,14 @@ Any user with a Cloud Build Approver role for the project can approve a build. W - `github` (`list[obj]`): Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of 'trigger_template', 'github', 'pubsub_config' or 'webhook_config' must be provided. When `null`, the `github` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.github.new](#fn-githubnew) constructor. - - `pubsub_config` (`list[obj]`): PubsubConfig describes the configuration of a trigger that creates + - `pubsub_config` (`list[obj]`): PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. One of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `pubsub_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-beta.google_cloudbuild_trigger.pubsub_config.new](#fn-pubsub_confignew) constructor. - `repository_event_config` (`list[obj]`): The configuration of a trigger that creates a build whenever an event from Repo API is received. When `null`, the `repository_event_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-beta.google_cloudbuild_trigger.repository_event_config.new](#fn-repository_event_confignew) constructor. - - `source_to_build` (`list[obj]`): The repo and ref of the repository from which to build. -This field is used only for those triggers that do not respond to SCM events. -Triggers that respond to such events build source at whatever commit caused the event. + - `source_to_build` (`list[obj]`): The repo and ref of the repository from which to build. +This field is used only for those triggers that do not respond to SCM events. +Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. One of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `source_to_build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.source_to_build.new](#fn-source_to_buildnew) constructor. @@ -208,7 +208,7 @@ expressions. Any branch or tag change that matches that regular expression will trigger a build. One of 'trigger_template', 'github', 'pubsub_config', 'webhook_config' or 'source_to_build' must be provided. When `null`, the `trigger_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.trigger_template.new](#fn-trigger_templatenew) constructor. - - `webhook_config` (`list[obj]`): WebhookConfig describes the configuration of a trigger that creates + - `webhook_config` (`list[obj]`): WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. One of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `webhook_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-beta.google_cloudbuild_trigger.webhook_config.new](#fn-webhook_confignew) constructor. @@ -237,7 +237,7 @@ injecting into a complete block. **Args**: - `description` (`string`): Human-readable description of the trigger. When `null`, the `description` field will be omitted from the resulting object. - `disabled` (`bool`): Whether the trigger is disabled or not. If true, the trigger will never result in a build. When `null`, the `disabled` field will be omitted from the resulting object. - - `filename` (`string`): Path, from the source root, to a file whose contents is used for the template. + - `filename` (`string`): Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided. Set this only when using trigger_template or github. When using Pub/Sub, Webhook or Manual set the file name using git_file_source instead. When `null`, the `filename` field will be omitted from the resulting object. - `filter` (`string`): A Common Expression Language string. Used only with Pub/Sub and Webhook. When `null`, the `filter` field will be omitted from the resulting object. @@ -277,8 +277,8 @@ If no service account is set, then the standard Cloud Build service account Format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL} When `null`, the `service_account` field will be omitted from the resulting object. - `substitutions` (`obj`): Substitutions data for Build resource. When `null`, the `substitutions` field will be omitted from the resulting object. - `tags` (`list`): Tags for annotation of a BuildTrigger When `null`, the `tags` field will be omitted from the resulting object. - - `approval_config` (`list[obj]`): Configuration for manual approval to start a build invocation of this BuildTrigger. -Builds created by this trigger will require approval before they execute. + - `approval_config` (`list[obj]`): Configuration for manual approval to start a build invocation of this BuildTrigger. +Builds created by this trigger will require approval before they execute. Any user with a Cloud Build Approver role for the project can approve a build. When `null`, the `approval_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-beta.google_cloudbuild_trigger.approval_config.new](#fn-approval_confignew) constructor. - `bitbucket_server_trigger_config` (`list[obj]`): BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. When `null`, the `bitbucket_server_trigger_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-beta.google_cloudbuild_trigger.bitbucket_server_trigger_config.new](#fn-bitbucket_server_trigger_confignew) constructor. - `build` (`list[obj]`): Contents of the build template. Either a filename or build template must be provided. When `null`, the `build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.build.new](#fn-buildnew) constructor. @@ -286,14 +286,14 @@ Any user with a Cloud Build Approver role for the project can approve a build. W - `github` (`list[obj]`): Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of 'trigger_template', 'github', 'pubsub_config' or 'webhook_config' must be provided. When `null`, the `github` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.github.new](#fn-githubnew) constructor. - - `pubsub_config` (`list[obj]`): PubsubConfig describes the configuration of a trigger that creates + - `pubsub_config` (`list[obj]`): PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. One of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `pubsub_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-beta.google_cloudbuild_trigger.pubsub_config.new](#fn-pubsub_confignew) constructor. - `repository_event_config` (`list[obj]`): The configuration of a trigger that creates a build whenever an event from Repo API is received. When `null`, the `repository_event_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-beta.google_cloudbuild_trigger.repository_event_config.new](#fn-repository_event_confignew) constructor. - - `source_to_build` (`list[obj]`): The repo and ref of the repository from which to build. -This field is used only for those triggers that do not respond to SCM events. -Triggers that respond to such events build source at whatever commit caused the event. + - `source_to_build` (`list[obj]`): The repo and ref of the repository from which to build. +This field is used only for those triggers that do not respond to SCM events. +Triggers that respond to such events build source at whatever commit caused the event. This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers. One of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `source_to_build` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.source_to_build.new](#fn-source_to_buildnew) constructor. @@ -305,7 +305,7 @@ expressions. Any branch or tag change that matches that regular expression will trigger a build. One of 'trigger_template', 'github', 'pubsub_config', 'webhook_config' or 'source_to_build' must be provided. When `null`, the `trigger_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_cloudbuild_trigger.trigger_template.new](#fn-trigger_templatenew) constructor. - - `webhook_config` (`list[obj]`): WebhookConfig describes the configuration of a trigger that creates + - `webhook_config` (`list[obj]`): WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. One of 'trigger_template', 'github', 'pubsub_config' 'webhook_config' or 'source_to_build' must be provided. When `null`, the `webhook_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-beta.google_cloudbuild_trigger.webhook_config.new](#fn-webhook_confignew) constructor. @@ -945,7 +945,7 @@ Terraform sub block. **Args**: - - `approval_required` (`bool`): Whether or not approval is needed. If this is set on a build, it will become pending when run, + - `approval_required` (`bool`): Whether or not approval is needed. If this is set on a build, it will become pending when run, and will need to be explicitly approved to start. When `null`, the `approval_required` field will be omitted from the resulting object. **Returns**: @@ -1052,9 +1052,9 @@ Terraform sub block. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE. When `null`, the `images` field will be omitted from the resulting object. - - `logs_bucket` (`string`): Google Cloud Storage bucket where logs should be written. + - `logs_bucket` (`string`): Google Cloud Storage bucket where logs should be written. Logs file names will be of the format ${logsBucket}/log-${build_id}.txt. When `null`, the `logs_bucket` field will be omitted from the resulting object. - - `queue_ttl` (`string`): TTL in queue for this build. If provided and the build is enqueued longer than this value, + - `queue_ttl` (`string`): TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be EXPIRED. The TTL starts ticking from createTime. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `queue_ttl` field will be omitted from the resulting object. @@ -1298,8 +1298,8 @@ Terraform sub block. **Args**: - `kms_key_name` (`string`): Cloud KMS key name to use to decrypt these envs. - `secret_env` (`obj`): Map of environment variable name to its encrypted value. -Secret environment variables must be unique across all of a build's secrets, -and must be used by at least one build step. Values can be at most 64 KB in size. +Secret environment variables must be unique across all of a build's secrets, +and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. When `null`, the `secret_env` field will be omitted from the resulting object. **Returns**: @@ -1348,19 +1348,19 @@ Terraform sub block. **Args**: - `branch_name` (`string`): Regex matching branches to build. Exactly one a of branch name, tag, or commit SHA must be provided. -The syntax of the regular expressions accepted is the syntax accepted by RE2 and +The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax When `null`, the `branch_name` field will be omitted from the resulting object. - `commit_sha` (`string`): Explicit commit SHA to build. Exactly one a of branch name, tag, or commit SHA must be provided. When `null`, the `commit_sha` field will be omitted from the resulting object. - `dir` (`string`): Directory, relative to the source root, in which to run the build. -This must be a relative path. If a step's dir is specified and is an absolute path, +This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution. When `null`, the `dir` field will be omitted from the resulting object. - `invert_regex` (`bool`): Only trigger a build if the revision regex does NOT match the revision regex. When `null`, the `invert_regex` field will be omitted from the resulting object. - - `project_id` (`string`): ID of the project that owns the Cloud Source Repository. + - `project_id` (`string`): ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. When `null`, the `project_id` field will be omitted from the resulting object. - `repo_name` (`string`): Name of the Cloud Source Repository. - `substitutions` (`obj`): Substitutions to use in a triggered build. Should only be used with triggers.run When `null`, the `substitutions` field will be omitted from the resulting object. - `tag_name` (`string`): Regex matching tags to build. Exactly one a of branch name, tag, or commit SHA must be provided. -The syntax of the regular expressions accepted is the syntax accepted by RE2 and +The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax When `null`, the `tag_name` field will be omitted from the resulting object. **Returns**: @@ -1385,7 +1385,7 @@ Terraform sub block. **Args**: - `bucket` (`string`): Google Cloud Storage bucket containing the source. - - `generation` (`string`): Google Cloud Storage generation for the object. + - `generation` (`string`): Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used When `null`, the `generation` field will be omitted from the resulting object. - `object` (`string`): Google Cloud Storage object containing the source. This object must be a gzipped archive file (.tar.gz) containing source to build. @@ -1443,7 +1443,7 @@ run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of -the officially supported build steps (see https://github.com/GoogleCloudPlatform/cloud-builders +the officially supported build steps (see https://github.com/GoogleCloudPlatform/cloud-builders for images and examples). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time @@ -1452,7 +1452,7 @@ you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. - - `script` (`string`): A shell script to be executed in the step. + - `script` (`string`): A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. When `null`, the `script` field will be omitted from the resulting object. - `secret_env` (`list`): A list of environment variables which are encrypted using a Cloud Key @@ -1533,12 +1533,12 @@ Terraform sub block. - `github_enterprise_config` (`string`): The full resource name of the github enterprise config. Format: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}. projects/{project}/githubEnterpriseConfigs/{id}. When `null`, the `github_enterprise_config` field will be omitted from the resulting object. - `path` (`string`): The path of the file, with the repo root as the root of the path. - - `repo_type` (`string`): The type of the repo, since it may not be explicit from the repo field (e.g from a URL). + - `repo_type` (`string`): The type of the repo, since it may not be explicit from the repo field (e.g from a URL). Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER Possible values: ["UNKNOWN", "CLOUD_SOURCE_REPOSITORIES", "GITHUB", "BITBUCKET_SERVER"] - - `revision` (`string`): The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the -filename (optional). This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions + - `revision` (`string`): The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the +filename (optional). This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions If unspecified, the revision from which the trigger invocation originated is assumed to be the revision from which to read the specified path. When `null`, the `revision` field will be omitted from the resulting object. - - `uri` (`string`): The URI of the repo (optional). If unspecified, the repo from which the trigger + - `uri` (`string`): The URI of the repo (optional). If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path. When `null`, the `uri` field will be omitted from the resulting object. **Returns**: diff --git a/docs/4.x/google_cloudfunctions2_function.md b/docs/4.x/google_cloudfunctions2_function.md index dc75d7d6..028eabb2 100644 --- a/docs/4.x/google_cloudfunctions2_function.md +++ b/docs/4.x/google_cloudfunctions2_function.md @@ -436,9 +436,9 @@ Terraform sub block. - `branch_name` (`string`): Regex matching branches to build. When `null`, the `branch_name` field will be omitted from the resulting object. - `commit_sha` (`string`): Regex matching tags to build. When `null`, the `commit_sha` field will be omitted from the resulting object. - `dir` (`string`): Directory, relative to the source root, in which to run the build. When `null`, the `dir` field will be omitted from the resulting object. - - `invert_regex` (`bool`): Only trigger a build if the revision regex does + - `invert_regex` (`bool`): Only trigger a build if the revision regex does NOT match the revision regex. When `null`, the `invert_regex` field will be omitted from the resulting object. - - `project_id` (`string`): ID of the project that owns the Cloud Source Repository. If omitted, the + - `project_id` (`string`): ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. When `null`, the `project_id` field will be omitted from the resulting object. - `repo_name` (`string`): Name of the Cloud Source Repository. When `null`, the `repo_name` field will be omitted from the resulting object. - `tag_name` (`string`): Regex matching tags to build. When `null`, the `tag_name` field will be omitted from the resulting object. @@ -465,7 +465,7 @@ Terraform sub block. **Args**: - `bucket` (`string`): Google Cloud Storage bucket containing the source When `null`, the `bucket` field will be omitted from the resulting object. - - `generation` (`number`): Google Cloud Storage generation for the object. If the generation + - `generation` (`number`): Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. When `null`, the `generation` field will be omitted from the resulting object. - `object` (`string`): Google Cloud Storage object containing the source. When `null`, the `object` field will be omitted from the resulting object. diff --git a/docs/4.x/google_compute_backend_service.md b/docs/4.x/google_compute_backend_service.md index d71367fa..6b279bb8 100644 --- a/docs/4.x/google_compute_backend_service.md +++ b/docs/4.x/google_compute_backend_service.md @@ -57,6 +57,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-backendnew) * [`obj cdn_policy`](#obj-cdn_policy) * [`fn new()`](#fn-cdn_policynew) + * [`obj cdn_policy.bypass_cache_on_request_headers`](#obj-cdn_policybypass_cache_on_request_headers) + * [`fn new()`](#fn-cdn_policybypass_cache_on_request_headersnew) * [`obj cdn_policy.cache_key_policy`](#obj-cdn_policycache_key_policy) * [`fn new()`](#fn-cdn_policycache_key_policynew) * [`obj cdn_policy.negative_caching_policy`](#obj-cdn_policynegative_caching_policy) @@ -1201,6 +1203,8 @@ internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. When `null`, the `signed_url_cache_max_age_sec` field will be omitted from the resulting object. + - `bypass_cache_on_request_headers` (`list[obj]`): Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. +The cache is bypassed for all cdnPolicy.cacheMode settings. When `null`, the `bypass_cache_on_request_headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_backend_service.cdn_policy.bypass_cache_on_request_headers.new](#fn-cdn_policybypass_cache_on_request_headersnew) constructor. - `cache_key_policy` (`list[obj]`): The CacheKeyPolicy for this CdnPolicy. When `null`, the `cache_key_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-beta.google_compute_backend_service.cdn_policy.cache_key_policy.new](#fn-cdn_policycache_key_policynew) constructor. - `negative_caching_policy` (`list[obj]`): Sets a cache TTL for the specified HTTP status code. negativeCaching must be enabled to configure negativeCachingPolicy. Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's default cache TTLs. When `null`, the `negative_caching_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-beta.google_compute_backend_service.cdn_policy.negative_caching_policy.new](#fn-cdn_policynegative_caching_policynew) constructor. @@ -1209,6 +1213,29 @@ Omitting the policy and leaving negativeCaching enabled will use Cloud CDN's - An attribute object that represents the `cdn_policy` sub block. +## obj cdn_policy.bypass_cache_on_request_headers + + + +### fn cdn_policy.bypass_cache_on_request_headers.new + +```ts +new() +``` + + +`google-beta.google_compute_backend_service.cdn_policy.bypass_cache_on_request_headers.new` constructs a new object with attributes and blocks configured for the `bypass_cache_on_request_headers` +Terraform sub block. + + + +**Args**: + - `header_name` (`string`): The header field name to match on when bypassing cache. Values are case-insensitive. + +**Returns**: + - An attribute object that represents the `bypass_cache_on_request_headers` sub block. + + ## obj cdn_policy.cache_key_policy diff --git a/docs/4.x/google_compute_disk.md b/docs/4.x/google_compute_disk.md index b8779992..18426ec3 100644 --- a/docs/4.x/google_compute_disk.md +++ b/docs/4.x/google_compute_disk.md @@ -15,6 +15,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withAsyncPrimaryDisk()`](#fn-withasyncprimarydisk) +* [`fn withAsyncPrimaryDiskMixin()`](#fn-withasyncprimarydiskmixin) * [`fn withDescription()`](#fn-withdescription) * [`fn withDiskEncryptionKey()`](#fn-withdiskencryptionkey) * [`fn withDiskEncryptionKeyMixin()`](#fn-withdiskencryptionkeymixin) @@ -38,6 +40,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`fn withType()`](#fn-withtype) * [`fn withZone()`](#fn-withzone) +* [`obj async_primary_disk`](#obj-async_primary_disk) + * [`fn new()`](#fn-async_primary_disknew) * [`obj disk_encryption_key`](#obj-disk_encryption_key) * [`fn new()`](#fn-disk_encryption_keynew) * [`obj source_image_encryption_key`](#obj-source_image_encryption_key) @@ -145,6 +149,7 @@ For example, the following are valid values: - `type` (`string`): URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object. - `zone` (`string`): A reference to the zone where the disk resides. When `null`, the `zone` field will be omitted from the resulting object. + - `async_primary_disk` (`list[obj]`): A nested object resource When `null`, the `async_primary_disk` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.async_primary_disk.new](#fn-async_primary_disknew) constructor. - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must @@ -255,6 +260,7 @@ For example, the following are valid values: - `type` (`string`): URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object. - `zone` (`string`): A reference to the zone where the disk resides. When `null`, the `zone` field will be omitted from the resulting object. + - `async_primary_disk` (`list[obj]`): A nested object resource When `null`, the `async_primary_disk` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_disk.async_primary_disk.new](#fn-async_primary_disknew) constructor. - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must @@ -278,6 +284,43 @@ key. When `null`, the `source_snapshot_encryption_key` sub block will be omitted - 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 `google_compute_disk` resource into the root Terraform configuration. +### fn withAsyncPrimaryDisk + +```ts +withAsyncPrimaryDisk() +``` + +`google-beta.list[obj].withAsyncPrimaryDisk` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the async_primary_disk 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-beta.list[obj].withAsyncPrimaryDiskMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `async_primary_disk` field. + + +### fn withAsyncPrimaryDiskMixin + +```ts +withAsyncPrimaryDiskMixin() +``` + +`google-beta.list[obj].withAsyncPrimaryDiskMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the async_primary_disk 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-beta.list[obj].withAsyncPrimaryDisk](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `async_primary_disk` field. + + ### fn withDescription ```ts @@ -665,6 +708,29 @@ Terraform resource block to set or update the zone field. - `value` (`string`): The value to set for the `zone` field. +## obj async_primary_disk + + + +### fn async_primary_disk.new + +```ts +new() +``` + + +`google-beta.google_compute_disk.async_primary_disk.new` constructs a new object with attributes and blocks configured for the `async_primary_disk` +Terraform sub block. + + + +**Args**: + - `disk` (`string`): Primary disk for asynchronous disk replication. + +**Returns**: + - An attribute object that represents the `async_primary_disk` sub block. + + ## obj disk_encryption_key @@ -691,8 +757,8 @@ See https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encr If absent, the Compute Engine Service Agent service account is used. When `null`, the `kms_key_service_account` field will be omitted from the resulting object. - `raw_key` (`string`): Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. When `null`, the `raw_key` field will be omitted from the resulting object. - - `rsa_encrypted_key` (`string`): Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit -customer-supplied encryption key to either encrypt or decrypt + - `rsa_encrypted_key` (`string`): Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit +customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. When `null`, the `rsa_encrypted_key` field will be omitted from the resulting object. **Returns**: diff --git a/docs/4.x/google_compute_firewall_policy_rule.md b/docs/4.x/google_compute_firewall_policy_rule.md index 5352d08b..6da7fcc4 100644 --- a/docs/4.x/google_compute_firewall_policy_rule.md +++ b/docs/4.x/google_compute_firewall_policy_rule.md @@ -64,7 +64,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `action` (`string`): The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. + - `action` (`string`): The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - `description` (`string`): An optional description for this resource. When `null`, the `description` field will be omitted from the resulting object. - `direction` (`string`): The direction in which this rule applies. Possible values: INGRESS, EGRESS - `disabled` (`bool`): Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. When `null`, the `disabled` field will be omitted from the resulting object. @@ -98,7 +98,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `action` (`string`): The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. + - `action` (`string`): The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - `description` (`string`): An optional description for this resource. When `null`, the `description` field will be omitted from the resulting object. - `direction` (`string`): The direction in which this rule applies. Possible values: INGRESS, EGRESS - `disabled` (`bool`): Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. When `null`, the `disabled` field will be omitted from the resulting object. @@ -348,8 +348,16 @@ Terraform sub block. **Args**: + - `dest_address_groups` (`list`): Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules. When `null`, the `dest_address_groups` field will be omitted from the resulting object. + - `dest_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_fqdns` field will be omitted from the resulting object. - `dest_ip_ranges` (`list`): CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256. When `null`, the `dest_ip_ranges` field will be omitted from the resulting object. + - `dest_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_region_codes` field will be omitted from the resulting object. + - `dest_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `dest_threat_intelligences` field will be omitted from the resulting object. + - `src_address_groups` (`list`): Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules. When `null`, the `src_address_groups` field will be omitted from the resulting object. + - `src_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_fqdns` field will be omitted from the resulting object. - `src_ip_ranges` (`list`): CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256. When `null`, the `src_ip_ranges` field will be omitted from the resulting object. + - `src_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_region_codes` field will be omitted from the resulting object. + - `src_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `src_threat_intelligences` field will be omitted from the resulting object. - `layer4_configs` (`list[obj]`): Pairs of IP protocols and ports that the rule should match. When `null`, the `layer4_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_firewall_policy_rule.match.layer4_configs.new](#fn-matchlayer4_configsnew) constructor. **Returns**: diff --git a/docs/4.x/google_compute_forwarding_rule.md b/docs/4.x/google_compute_forwarding_rule.md index 3a5dee9d..15e3e053 100644 --- a/docs/4.x/google_compute_forwarding_rule.md +++ b/docs/4.x/google_compute_forwarding_rule.md @@ -17,6 +17,7 @@ This package contains functions and utilities for setting up the resource using * [`fn newAttrs()`](#fn-newattrs) * [`fn withAllPorts()`](#fn-withallports) * [`fn withAllowGlobalAccess()`](#fn-withallowglobalaccess) +* [`fn withAllowPscGlobalAccess()`](#fn-withallowpscglobalaccess) * [`fn withBackendService()`](#fn-withbackendservice) * [`fn withDescription()`](#fn-withdescription) * [`fn withIpAddress()`](#fn-withipaddress) @@ -34,6 +35,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withServiceDirectoryRegistrations()`](#fn-withservicedirectoryregistrations) * [`fn withServiceDirectoryRegistrationsMixin()`](#fn-withservicedirectoryregistrationsmixin) * [`fn withServiceLabel()`](#fn-withservicelabel) +* [`fn withSourceIpRanges()`](#fn-withsourceipranges) * [`fn withSubnetwork()`](#fn-withsubnetwork) * [`fn withTarget()`](#fn-withtarget) * [`fn withTimeouts()`](#fn-withtimeouts) @@ -72,50 +74,215 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `all_ports` (`bool`): This field is used along with the `backend_service` field for internal load balancing or with the `target` field for internal TargetInstance. This field cannot be used with `port` or `portRange` fields. When the load balancing scheme is `INTERNAL` and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. When `null`, the `all_ports` field will be omitted from the resulting object. - - `allow_global_access` (`bool`): This field is used along with the `backend_service` field for internal load balancing or with the `target` field for internal TargetInstance. If the field is set to `TRUE`, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. When `null`, the `allow_global_access` field will be omitted from the resulting object. - - `backend_service` (`string`): This field is only used for `INTERNAL` load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. When `null`, the `backend_service` field will be omitted from the resulting object. - - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object. - - `ip_address` (`string`): IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in `https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name` * Partial URL or by name, as in: * `projects/project_id/regions/region/addresses/address-name` * `regions/region/addresses/address-name` * `global/addresses/address-name` * `address-name` The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When `null`, the `ip_address` field will be omitted from the resulting object. - - `ip_protocol` (`string`): The IP protocol to which this rule applies. For protocol forwarding, valid options are `TCP`, `UDP`, `ESP`, `AH`, `SCTP` or `ICMP`. For Internal TCP/UDP Load Balancing, the load balancing scheme is `INTERNAL`, and one of `TCP` or `UDP` are valid. For Traffic Director, the load balancing scheme is `INTERNAL_SELF_MANAGED`, and only `TCP`is valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is `INTERNAL_MANAGED`, and only `TCP` is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is `EXTERNAL` and only `TCP` is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is `EXTERNAL`, and one of `TCP` or `UDP` is valid. When `null`, the `ip_protocol` field will be omitted from the resulting object. - - `is_mirroring_collector` (`bool`): Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a `PacketMirroring` rule applies to them. This can only be set to true for load balancers that have their `loadBalancingScheme` set to `INTERNAL`. When `null`, the `is_mirroring_collector` field will be omitted from the resulting object. - - `labels` (`obj`): Labels to apply to this rule. When `null`, the `labels` field will be omitted from the resulting object. + - `all_ports` (`bool`): This field can only be used: +* If 'IPProtocol' is one of TCP, UDP, or SCTP. +* By internal TCP/UDP load balancers, backend service-based network load +balancers, and internal and external protocol forwarding. + + +Set this field to true to allow packets addressed to any port or packets +lacking destination port information (for example, UDP fragments after the +first fragment) to be forwarded to the backends configured with this +forwarding rule. + +The 'ports', 'port_range', and +'allPorts' fields are mutually exclusive. When `null`, the `all_ports` field will be omitted from the resulting object. + - `allow_global_access` (`bool`): This field is used along with the 'backend_service' field for +internal load balancing or with the 'target' field for internal +TargetInstance. + +If the field is set to 'TRUE', clients can access ILB from all +regions. + +Otherwise only allows access from clients in the same region as the +internal load balancer. When `null`, the `allow_global_access` field will be omitted from the resulting object. + - `allow_psc_global_access` (`bool`): This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. When `null`, the `allow_psc_global_access` field will be omitted from the resulting object. + - `backend_service` (`string`): Identifies the backend service to which the forwarding rule sends traffic. + +Required for Internal TCP/UDP Load Balancing and Network Load Balancing; +must be omitted for all other load balancer types. When `null`, the `backend_service` field will be omitted from the resulting object. + - `description` (`string`): An optional description of this resource. Provide this property when +you create the resource. When `null`, the `description` field will be omitted from the resulting object. + - `ip_address` (`string`): IP address for which this forwarding rule accepts traffic. When a client +sends traffic to this IP address, the forwarding rule directs the traffic +to the referenced 'target' or 'backendService'. + +While creating a forwarding rule, specifying an 'IPAddress' is +required under the following circumstances: + +* When the 'target' is set to 'targetGrpcProxy' and +'validateForProxyless' is set to 'true', the +'IPAddress' should be set to '0.0.0.0'. +* When the 'target' is a Private Service Connect Google APIs +bundle, you must specify an 'IPAddress'. + + +Otherwise, you can optionally specify an IP address that references an +existing static (reserved) IP address resource. When omitted, Google Cloud +assigns an ephemeral IP address. + +Use one of the following formats to specify an IP address while creating a +forwarding rule: + +* IP address number, as in '100.1.2.3' +* IPv6 address range, as in '2600:1234::/96' +* Full resource URL, as in +'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name' +* Partial URL or by name, as in: + * 'projects/project_id/regions/region/addresses/address-name' + * 'regions/region/addresses/address-name' + * 'global/addresses/address-name' + * 'address-name' + + +The forwarding rule's 'target' or 'backendService', +and in most cases, also the 'loadBalancingScheme', determine the +type of IP address that you can use. For detailed information, see +[IP address +specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). + +When reading an 'IPAddress', the API always returns the IP +address number. When `null`, the `ip_address` field will be omitted from the resulting object. + - `ip_protocol` (`string`): The IP protocol to which this rule applies. + +For protocol forwarding, valid +options are 'TCP', 'UDP', 'ESP', +'AH', 'SCTP', 'ICMP' and +'L3_DEFAULT'. + +The valid IP protocols are different for different load balancing products +as described in [Load balancing +features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). Possible values: ["TCP", "UDP", "ESP", "AH", "SCTP", "ICMP", "L3_DEFAULT"] When `null`, the `ip_protocol` field will be omitted from the resulting object. + - `is_mirroring_collector` (`bool`): Indicates whether or not this load balancer can be used as a collector for +packet mirroring. To prevent mirroring loops, instances behind this +load balancer will not have their traffic mirrored even if a +'PacketMirroring' rule applies to them. + +This can only be set to true for load balancers that have their +'loadBalancingScheme' set to 'INTERNAL'. When `null`, the `is_mirroring_collector` field will be omitted from the resulting object. + - `labels` (`obj`): Labels to apply to this forwarding rule. A list of key->value pairs. When `null`, the `labels` field will be omitted from the resulting object. - `load_balancing_scheme` (`string`): Specifies the forwarding rule type. -* `EXTERNAL` is used for: - * Classic Cloud VPN gateways - * Protocol forwarding to VMs from an external IP address - * The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP -* `INTERNAL` is used for: - * Protocol forwarding to VMs from an internal IP address - * Internal TCP/UDP load balancers -* `INTERNAL_MANAGED` is used for: - * Internal HTTP(S) load balancers -* `INTERNAL_SELF_MANAGED` is used for: - * Traffic Director -* `EXTERNAL_MANAGED` is used for: - * Global external HTTP(S) load balancers - -For more information about forwarding rules, refer to [Forwarding rule concepts](/load-balancing/docs/forwarding-rule-concepts). Possible values: INVALID, INTERNAL, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED, EXTERNAL, EXTERNAL_MANAGED When `null`, the `load_balancing_scheme` field will be omitted from the resulting object. - - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - - `network` (`string`): This field is not used for external load balancing. For `INTERNAL` and `INTERNAL_SELF_MANAGED` load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. When `null`, the `network` field will be omitted from the resulting object. - - `network_tier` (`string`): This signifies the networking tier used for configuring this load balancer and can only take the following values: `PREMIUM`, `STANDARD`. For regional ForwardingRule, the valid values are `PREMIUM` and `STANDARD`. For GlobalForwardingRule, the valid value is `PREMIUM`. If this field is not specified, it is assumed to be `PREMIUM`. If `IPAddress` is specified, this value must be equal to the networkTier of the Address. When `null`, the `network_tier` field will be omitted from the resulting object. - - `port_range` (`string`): When the load balancing scheme is `EXTERNAL`, `INTERNAL_SELF_MANAGED` and `INTERNAL_MANAGED`, you can specify a `port_range`. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the `target` field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when `IPProtocol` is `TCP`, `UDP`, or `SCTP`, only packets addressed to ports in the specified range will be forwarded to `target`. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: - -* TargetHttpProxy: 80, 8080 -* TargetHttpsProxy: 443 -* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 -* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 -* TargetVpnGateway: 500, 4500 - -@pattern: d+(?:-d+)? When `null`, the `port_range` field will be omitted from the resulting object. - - `ports` (`list`): This field is used along with the `backend_service` field for internal load balancing. When the load balancing scheme is `INTERNAL`, a list of ports can be configured, for example, ['80'], ['8000','9000']. Only packets addressed to these ports are forwarded to the backends configured with the forwarding rule. If the forwarding rule's loadBalancingScheme is INTERNAL, you can specify ports in one of the following ways: * A list of up to five ports, which can be non-contiguous * Keyword `ALL`, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol. @pattern: d+(?:-d+)? For more information, refer to [Port specifications](/load-balancing/docs/forwarding-rule-concepts#port_specifications). When `null`, the `ports` field will be omitted from the resulting object. - - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object. - - `region` (`string`): The location of this resource. When `null`, the `region` field will be omitted from the resulting object. - - `service_label` (`string`): An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. When `null`, the `service_label` field will be omitted from the resulting object. - - `subnetwork` (`string`): This field is only used for `INTERNAL` load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. When `null`, the `subnetwork` field will be omitted from the resulting object. - - `target` (`string`): The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For `INTERNAL_SELF_MANAGED` load balancing, only `targetHttpProxy` is valid, not `targetHttpsProxy`. When `null`, the `target` field will be omitted from the resulting object. - - `service_directory_registrations` (`list[obj]`): Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. When `null`, the `service_directory_registrations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_forwarding_rule.service_directory_registrations.new](#fn-service_directory_registrationsnew) constructor. +For more information about forwarding rules, refer to +[Forwarding rule concepts](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts). Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource; provided by the client when the resource is created. +The name must be 1-63 characters long, and comply with +[RFC1035](https://www.ietf.org/rfc/rfc1035.txt). + +Specifically, the name must be 1-63 characters long and match the regular +expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first +character must be a lowercase letter, and all following characters must +be a dash, lowercase letter, or digit, except the last character, which +cannot be a dash. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, the forwarding rule name must be a 1-20 characters string with +lowercase letters and numbers and must start with a letter. + - `network` (`string`): This field is not used for external load balancing. + +For Internal TCP/UDP Load Balancing, this field identifies the network that +the load balanced IP should belong to for this Forwarding Rule. +If the subnetwork is specified, the network of the subnetwork will be used. +If neither subnetwork nor this field is specified, the default network will +be used. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, a network must be provided. When `null`, the `network` field will be omitted from the resulting object. + - `network_tier` (`string`): This signifies the networking tier used for configuring +this load balancer and can only take the following values: +'PREMIUM', 'STANDARD'. + +For regional ForwardingRule, the valid values are 'PREMIUM' and +'STANDARD'. For GlobalForwardingRule, the valid value is +'PREMIUM'. + +If this field is not specified, it is assumed to be 'PREMIUM'. +If 'IPAddress' is specified, this value must be equal to the +networkTier of the Address. Possible values: ["PREMIUM", "STANDARD"] When `null`, the `network_tier` field will be omitted from the resulting object. + - `port_range` (`string`): This field can only be used: + +* If 'IPProtocol' is one of TCP, UDP, or SCTP. +* By backend service-based network load balancers, target pool-based +network load balancers, internal proxy load balancers, external proxy load +balancers, Traffic Director, external protocol forwarding, and Classic VPN. +Some products have restrictions on what ports can be used. See +[port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications) +for details. + + +Only packets addressed to ports in the specified range will be forwarded to +the backends configured with this forwarding rule. + +The 'ports' and 'port_range' fields are mutually exclusive. + +For external forwarding rules, two or more forwarding rules cannot use the +same '[IPAddress, IPProtocol]' pair, and cannot have +overlapping 'portRange's. + +For internal forwarding rules within the same VPC network, two or more +forwarding rules cannot use the same '[IPAddress, IPProtocol]' +pair, and cannot have overlapping 'portRange's. When `null`, the `port_range` field will be omitted from the resulting object. + - `ports` (`list`): This field can only be used: + +* If 'IPProtocol' is one of TCP, UDP, or SCTP. +* By internal TCP/UDP load balancers, backend service-based network load +balancers, and internal protocol forwarding. + + +You can specify a list of up to five ports by number, separated by commas. +The ports can be contiguous or discontiguous. Only packets addressed to +these ports will be forwarded to the backends configured with this +forwarding rule. + +For external forwarding rules, two or more forwarding rules cannot use the +same '[IPAddress, IPProtocol]' pair, and cannot share any values +defined in 'ports'. + +For internal forwarding rules within the same VPC network, two or more +forwarding rules cannot use the same '[IPAddress, IPProtocol]' +pair, and cannot share any values defined in 'ports'. + +The 'ports' and 'port_range' fields are mutually exclusive. When `null`, the `ports` 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. + - `region` (`string`): A reference to the region where the regional forwarding rule resides. + +This field is not applicable to global forwarding rules. When `null`, the `region` field will be omitted from the resulting object. + - `service_label` (`string`): An optional prefix to the service name for this Forwarding Rule. +If specified, will be the first label of the fully qualified service +name. + +The label must be 1-63 characters long, and comply with RFC1035. +Specifically, the label must be 1-63 characters long and match the +regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first +character must be a lowercase letter, and all following characters +must be a dash, lowercase letter, or digit, except the last +character, which cannot be a dash. + +This field is only used for INTERNAL load balancing. When `null`, the `service_label` field will be omitted from the resulting object. + - `source_ip_ranges` (`list`): If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). When `null`, the `source_ip_ranges` field will be omitted from the resulting object. + - `subnetwork` (`string`): This field identifies the subnetwork that the load balanced IP should +belong to for this Forwarding Rule, used in internal load balancing and +network load balancing with IPv6. + +If the network specified is in auto subnet mode, this field is optional. +However, a subnetwork must be specified if the network is in custom subnet +mode or when creating external forwarding rule with IPv6. When `null`, the `subnetwork` field will be omitted from the resulting object. + - `target` (`string`): The URL of the target resource to receive the matched traffic. For +regional forwarding rules, this target must be in the same region as the +forwarding rule. For global forwarding rules, this target must be a global +load balancing resource. + +The forwarded traffic must be of a type appropriate to the target object. +* For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). +* For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: + * 'vpc-sc' - [ APIs that support VPC Service Controls](https://cloud.google.com/vpc-service-controls/docs/supported-products). + * 'all-apis' - [All supported Google APIs](https://cloud.google.com/vpc/docs/private-service-connect#supported-apis). + + +For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. When `null`, the `target` field will be omitted from the resulting object. + - `service_directory_registrations` (`list[obj]`): Service Directory resources to register this forwarding rule with. + +Currently, only supports a single Service Directory resource. When `null`, the `service_directory_registrations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_forwarding_rule.service_directory_registrations.new](#fn-service_directory_registrationsnew) 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-beta.google_compute_forwarding_rule.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -140,50 +307,215 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `all_ports` (`bool`): This field is used along with the `backend_service` field for internal load balancing or with the `target` field for internal TargetInstance. This field cannot be used with `port` or `portRange` fields. When the load balancing scheme is `INTERNAL` and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. When `null`, the `all_ports` field will be omitted from the resulting object. - - `allow_global_access` (`bool`): This field is used along with the `backend_service` field for internal load balancing or with the `target` field for internal TargetInstance. If the field is set to `TRUE`, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. When `null`, the `allow_global_access` field will be omitted from the resulting object. - - `backend_service` (`string`): This field is only used for `INTERNAL` load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. When `null`, the `backend_service` field will be omitted from the resulting object. - - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object. - - `ip_address` (`string`): IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in `https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name` * Partial URL or by name, as in: * `projects/project_id/regions/region/addresses/address-name` * `regions/region/addresses/address-name` * `global/addresses/address-name` * `address-name` The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When `null`, the `ip_address` field will be omitted from the resulting object. - - `ip_protocol` (`string`): The IP protocol to which this rule applies. For protocol forwarding, valid options are `TCP`, `UDP`, `ESP`, `AH`, `SCTP` or `ICMP`. For Internal TCP/UDP Load Balancing, the load balancing scheme is `INTERNAL`, and one of `TCP` or `UDP` are valid. For Traffic Director, the load balancing scheme is `INTERNAL_SELF_MANAGED`, and only `TCP`is valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is `INTERNAL_MANAGED`, and only `TCP` is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is `EXTERNAL` and only `TCP` is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is `EXTERNAL`, and one of `TCP` or `UDP` is valid. When `null`, the `ip_protocol` field will be omitted from the resulting object. - - `is_mirroring_collector` (`bool`): Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a `PacketMirroring` rule applies to them. This can only be set to true for load balancers that have their `loadBalancingScheme` set to `INTERNAL`. When `null`, the `is_mirroring_collector` field will be omitted from the resulting object. - - `labels` (`obj`): Labels to apply to this rule. When `null`, the `labels` field will be omitted from the resulting object. + - `all_ports` (`bool`): This field can only be used: +* If 'IPProtocol' is one of TCP, UDP, or SCTP. +* By internal TCP/UDP load balancers, backend service-based network load +balancers, and internal and external protocol forwarding. + + +Set this field to true to allow packets addressed to any port or packets +lacking destination port information (for example, UDP fragments after the +first fragment) to be forwarded to the backends configured with this +forwarding rule. + +The 'ports', 'port_range', and +'allPorts' fields are mutually exclusive. When `null`, the `all_ports` field will be omitted from the resulting object. + - `allow_global_access` (`bool`): This field is used along with the 'backend_service' field for +internal load balancing or with the 'target' field for internal +TargetInstance. + +If the field is set to 'TRUE', clients can access ILB from all +regions. + +Otherwise only allows access from clients in the same region as the +internal load balancer. When `null`, the `allow_global_access` field will be omitted from the resulting object. + - `allow_psc_global_access` (`bool`): This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. When `null`, the `allow_psc_global_access` field will be omitted from the resulting object. + - `backend_service` (`string`): Identifies the backend service to which the forwarding rule sends traffic. + +Required for Internal TCP/UDP Load Balancing and Network Load Balancing; +must be omitted for all other load balancer types. When `null`, the `backend_service` field will be omitted from the resulting object. + - `description` (`string`): An optional description of this resource. Provide this property when +you create the resource. When `null`, the `description` field will be omitted from the resulting object. + - `ip_address` (`string`): IP address for which this forwarding rule accepts traffic. When a client +sends traffic to this IP address, the forwarding rule directs the traffic +to the referenced 'target' or 'backendService'. + +While creating a forwarding rule, specifying an 'IPAddress' is +required under the following circumstances: + +* When the 'target' is set to 'targetGrpcProxy' and +'validateForProxyless' is set to 'true', the +'IPAddress' should be set to '0.0.0.0'. +* When the 'target' is a Private Service Connect Google APIs +bundle, you must specify an 'IPAddress'. + + +Otherwise, you can optionally specify an IP address that references an +existing static (reserved) IP address resource. When omitted, Google Cloud +assigns an ephemeral IP address. + +Use one of the following formats to specify an IP address while creating a +forwarding rule: + +* IP address number, as in '100.1.2.3' +* IPv6 address range, as in '2600:1234::/96' +* Full resource URL, as in +'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name' +* Partial URL or by name, as in: + * 'projects/project_id/regions/region/addresses/address-name' + * 'regions/region/addresses/address-name' + * 'global/addresses/address-name' + * 'address-name' + + +The forwarding rule's 'target' or 'backendService', +and in most cases, also the 'loadBalancingScheme', determine the +type of IP address that you can use. For detailed information, see +[IP address +specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). + +When reading an 'IPAddress', the API always returns the IP +address number. When `null`, the `ip_address` field will be omitted from the resulting object. + - `ip_protocol` (`string`): The IP protocol to which this rule applies. + +For protocol forwarding, valid +options are 'TCP', 'UDP', 'ESP', +'AH', 'SCTP', 'ICMP' and +'L3_DEFAULT'. + +The valid IP protocols are different for different load balancing products +as described in [Load balancing +features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). Possible values: ["TCP", "UDP", "ESP", "AH", "SCTP", "ICMP", "L3_DEFAULT"] When `null`, the `ip_protocol` field will be omitted from the resulting object. + - `is_mirroring_collector` (`bool`): Indicates whether or not this load balancer can be used as a collector for +packet mirroring. To prevent mirroring loops, instances behind this +load balancer will not have their traffic mirrored even if a +'PacketMirroring' rule applies to them. + +This can only be set to true for load balancers that have their +'loadBalancingScheme' set to 'INTERNAL'. When `null`, the `is_mirroring_collector` field will be omitted from the resulting object. + - `labels` (`obj`): Labels to apply to this forwarding rule. A list of key->value pairs. When `null`, the `labels` field will be omitted from the resulting object. - `load_balancing_scheme` (`string`): Specifies the forwarding rule type. -* `EXTERNAL` is used for: - * Classic Cloud VPN gateways - * Protocol forwarding to VMs from an external IP address - * The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP -* `INTERNAL` is used for: - * Protocol forwarding to VMs from an internal IP address - * Internal TCP/UDP load balancers -* `INTERNAL_MANAGED` is used for: - * Internal HTTP(S) load balancers -* `INTERNAL_SELF_MANAGED` is used for: - * Traffic Director -* `EXTERNAL_MANAGED` is used for: - * Global external HTTP(S) load balancers - -For more information about forwarding rules, refer to [Forwarding rule concepts](/load-balancing/docs/forwarding-rule-concepts). Possible values: INVALID, INTERNAL, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED, EXTERNAL, EXTERNAL_MANAGED When `null`, the `load_balancing_scheme` field will be omitted from the resulting object. - - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - - `network` (`string`): This field is not used for external load balancing. For `INTERNAL` and `INTERNAL_SELF_MANAGED` load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. When `null`, the `network` field will be omitted from the resulting object. - - `network_tier` (`string`): This signifies the networking tier used for configuring this load balancer and can only take the following values: `PREMIUM`, `STANDARD`. For regional ForwardingRule, the valid values are `PREMIUM` and `STANDARD`. For GlobalForwardingRule, the valid value is `PREMIUM`. If this field is not specified, it is assumed to be `PREMIUM`. If `IPAddress` is specified, this value must be equal to the networkTier of the Address. When `null`, the `network_tier` field will be omitted from the resulting object. - - `port_range` (`string`): When the load balancing scheme is `EXTERNAL`, `INTERNAL_SELF_MANAGED` and `INTERNAL_MANAGED`, you can specify a `port_range`. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the `target` field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when `IPProtocol` is `TCP`, `UDP`, or `SCTP`, only packets addressed to ports in the specified range will be forwarded to `target`. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: - -* TargetHttpProxy: 80, 8080 -* TargetHttpsProxy: 443 -* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 -* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 -* TargetVpnGateway: 500, 4500 - -@pattern: d+(?:-d+)? When `null`, the `port_range` field will be omitted from the resulting object. - - `ports` (`list`): This field is used along with the `backend_service` field for internal load balancing. When the load balancing scheme is `INTERNAL`, a list of ports can be configured, for example, ['80'], ['8000','9000']. Only packets addressed to these ports are forwarded to the backends configured with the forwarding rule. If the forwarding rule's loadBalancingScheme is INTERNAL, you can specify ports in one of the following ways: * A list of up to five ports, which can be non-contiguous * Keyword `ALL`, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol. @pattern: d+(?:-d+)? For more information, refer to [Port specifications](/load-balancing/docs/forwarding-rule-concepts#port_specifications). When `null`, the `ports` field will be omitted from the resulting object. - - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object. - - `region` (`string`): The location of this resource. When `null`, the `region` field will be omitted from the resulting object. - - `service_label` (`string`): An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. When `null`, the `service_label` field will be omitted from the resulting object. - - `subnetwork` (`string`): This field is only used for `INTERNAL` load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. When `null`, the `subnetwork` field will be omitted from the resulting object. - - `target` (`string`): The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For `INTERNAL_SELF_MANAGED` load balancing, only `targetHttpProxy` is valid, not `targetHttpsProxy`. When `null`, the `target` field will be omitted from the resulting object. - - `service_directory_registrations` (`list[obj]`): Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. When `null`, the `service_directory_registrations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_forwarding_rule.service_directory_registrations.new](#fn-service_directory_registrationsnew) constructor. +For more information about forwarding rules, refer to +[Forwarding rule concepts](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts). Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource; provided by the client when the resource is created. +The name must be 1-63 characters long, and comply with +[RFC1035](https://www.ietf.org/rfc/rfc1035.txt). + +Specifically, the name must be 1-63 characters long and match the regular +expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first +character must be a lowercase letter, and all following characters must +be a dash, lowercase letter, or digit, except the last character, which +cannot be a dash. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, the forwarding rule name must be a 1-20 characters string with +lowercase letters and numbers and must start with a letter. + - `network` (`string`): This field is not used for external load balancing. + +For Internal TCP/UDP Load Balancing, this field identifies the network that +the load balanced IP should belong to for this Forwarding Rule. +If the subnetwork is specified, the network of the subnetwork will be used. +If neither subnetwork nor this field is specified, the default network will +be used. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, a network must be provided. When `null`, the `network` field will be omitted from the resulting object. + - `network_tier` (`string`): This signifies the networking tier used for configuring +this load balancer and can only take the following values: +'PREMIUM', 'STANDARD'. + +For regional ForwardingRule, the valid values are 'PREMIUM' and +'STANDARD'. For GlobalForwardingRule, the valid value is +'PREMIUM'. + +If this field is not specified, it is assumed to be 'PREMIUM'. +If 'IPAddress' is specified, this value must be equal to the +networkTier of the Address. Possible values: ["PREMIUM", "STANDARD"] When `null`, the `network_tier` field will be omitted from the resulting object. + - `port_range` (`string`): This field can only be used: + +* If 'IPProtocol' is one of TCP, UDP, or SCTP. +* By backend service-based network load balancers, target pool-based +network load balancers, internal proxy load balancers, external proxy load +balancers, Traffic Director, external protocol forwarding, and Classic VPN. +Some products have restrictions on what ports can be used. See +[port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications) +for details. + + +Only packets addressed to ports in the specified range will be forwarded to +the backends configured with this forwarding rule. + +The 'ports' and 'port_range' fields are mutually exclusive. + +For external forwarding rules, two or more forwarding rules cannot use the +same '[IPAddress, IPProtocol]' pair, and cannot have +overlapping 'portRange's. + +For internal forwarding rules within the same VPC network, two or more +forwarding rules cannot use the same '[IPAddress, IPProtocol]' +pair, and cannot have overlapping 'portRange's. When `null`, the `port_range` field will be omitted from the resulting object. + - `ports` (`list`): This field can only be used: + +* If 'IPProtocol' is one of TCP, UDP, or SCTP. +* By internal TCP/UDP load balancers, backend service-based network load +balancers, and internal protocol forwarding. + + +You can specify a list of up to five ports by number, separated by commas. +The ports can be contiguous or discontiguous. Only packets addressed to +these ports will be forwarded to the backends configured with this +forwarding rule. + +For external forwarding rules, two or more forwarding rules cannot use the +same '[IPAddress, IPProtocol]' pair, and cannot share any values +defined in 'ports'. + +For internal forwarding rules within the same VPC network, two or more +forwarding rules cannot use the same '[IPAddress, IPProtocol]' +pair, and cannot share any values defined in 'ports'. + +The 'ports' and 'port_range' fields are mutually exclusive. When `null`, the `ports` 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. + - `region` (`string`): A reference to the region where the regional forwarding rule resides. + +This field is not applicable to global forwarding rules. When `null`, the `region` field will be omitted from the resulting object. + - `service_label` (`string`): An optional prefix to the service name for this Forwarding Rule. +If specified, will be the first label of the fully qualified service +name. + +The label must be 1-63 characters long, and comply with RFC1035. +Specifically, the label must be 1-63 characters long and match the +regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first +character must be a lowercase letter, and all following characters +must be a dash, lowercase letter, or digit, except the last +character, which cannot be a dash. + +This field is only used for INTERNAL load balancing. When `null`, the `service_label` field will be omitted from the resulting object. + - `source_ip_ranges` (`list`): If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). When `null`, the `source_ip_ranges` field will be omitted from the resulting object. + - `subnetwork` (`string`): This field identifies the subnetwork that the load balanced IP should +belong to for this Forwarding Rule, used in internal load balancing and +network load balancing with IPv6. + +If the network specified is in auto subnet mode, this field is optional. +However, a subnetwork must be specified if the network is in custom subnet +mode or when creating external forwarding rule with IPv6. When `null`, the `subnetwork` field will be omitted from the resulting object. + - `target` (`string`): The URL of the target resource to receive the matched traffic. For +regional forwarding rules, this target must be in the same region as the +forwarding rule. For global forwarding rules, this target must be a global +load balancing resource. + +The forwarded traffic must be of a type appropriate to the target object. +* For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). +* For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: + * 'vpc-sc' - [ APIs that support VPC Service Controls](https://cloud.google.com/vpc-service-controls/docs/supported-products). + * 'all-apis' - [All supported Google APIs](https://cloud.google.com/vpc/docs/private-service-connect#supported-apis). + + +For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. When `null`, the `target` field will be omitted from the resulting object. + - `service_directory_registrations` (`list[obj]`): Service Directory resources to register this forwarding rule with. + +Currently, only supports a single Service Directory resource. When `null`, the `service_directory_registrations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_forwarding_rule.service_directory_registrations.new](#fn-service_directory_registrationsnew) 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-beta.google_compute_forwarding_rule.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -222,6 +554,22 @@ Terraform resource block to set or update the allow_global_access field. - `value` (`bool`): The value to set for the `allow_global_access` field. +### fn withAllowPscGlobalAccess + +```ts +withAllowPscGlobalAccess() +``` + +`google-beta.bool.withAllowPscGlobalAccess` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the allow_psc_global_access field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `allow_psc_global_access` field. + + ### fn withBackendService ```ts @@ -499,6 +847,22 @@ Terraform resource block to set or update the service_label field. - `value` (`string`): The value to set for the `service_label` field. +### fn withSourceIpRanges + +```ts +withSourceIpRanges() +``` + +`google-beta.list.withSourceIpRanges` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the source_ip_ranges field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `source_ip_ranges` field. + + ### fn withSubnetwork ```ts diff --git a/docs/4.x/google_compute_global_forwarding_rule.md b/docs/4.x/google_compute_global_forwarding_rule.md index f4099319..8642a039 100644 --- a/docs/4.x/google_compute_global_forwarding_rule.md +++ b/docs/4.x/google_compute_global_forwarding_rule.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withAllowPscGlobalAccess()`](#fn-withallowpscglobalaccess) * [`fn withDescription()`](#fn-withdescription) * [`fn withIpAddress()`](#fn-withipaddress) * [`fn withIpProtocol()`](#fn-withipprotocol) @@ -27,6 +28,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withNetwork()`](#fn-withnetwork) * [`fn withPortRange()`](#fn-withportrange) * [`fn withProject()`](#fn-withproject) +* [`fn withSourceIpRanges()`](#fn-withsourceipranges) * [`fn withTarget()`](#fn-withtarget) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) @@ -66,48 +68,138 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object. - - `ip_address` (`string`): IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in `https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name` * Partial URL or by name, as in: * `projects/project_id/regions/region/addresses/address-name` * `regions/region/addresses/address-name` * `global/addresses/address-name` * `address-name` The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When `null`, the `ip_address` field will be omitted from the resulting object. - - `ip_protocol` (`string`): The IP protocol to which this rule applies. For protocol forwarding, valid options are `TCP`, `UDP`, `ESP`, `AH`, `SCTP` or `ICMP`. For Internal TCP/UDP Load Balancing, the load balancing scheme is `INTERNAL`, and one of `TCP` or `UDP` are valid. For Traffic Director, the load balancing scheme is `INTERNAL_SELF_MANAGED`, and only `TCP`is valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is `INTERNAL_MANAGED`, and only `TCP` is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is `EXTERNAL` and only `TCP` is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is `EXTERNAL`, and one of `TCP` or `UDP` is valid. When `null`, the `ip_protocol` field will be omitted from the resulting object. - - `ip_version` (`string`): The IP Version that will be used by this forwarding rule. Valid options are `IPV4` or `IPV6`. This can only be specified for an external global forwarding rule. Possible values: UNSPECIFIED_VERSION, IPV4, IPV6 When `null`, the `ip_version` field will be omitted from the resulting object. - - `labels` (`obj`): Labels to apply to this rule. When `null`, the `labels` field will be omitted from the resulting object. + - `allow_psc_global_access` (`bool`): This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. When `null`, the `allow_psc_global_access` field will be omitted from the resulting object. + - `description` (`string`): An optional description of this resource. Provide this property when +you create the resource. When `null`, the `description` field will be omitted from the resulting object. + - `ip_address` (`string`): IP address for which this forwarding rule accepts traffic. When a client +sends traffic to this IP address, the forwarding rule directs the traffic +to the referenced 'target'. + +While creating a forwarding rule, specifying an 'IPAddress' is +required under the following circumstances: + +* When the 'target' is set to 'targetGrpcProxy' and +'validateForProxyless' is set to 'true', the +'IPAddress' should be set to '0.0.0.0'. +* When the 'target' is a Private Service Connect Google APIs +bundle, you must specify an 'IPAddress'. + + +Otherwise, you can optionally specify an IP address that references an +existing static (reserved) IP address resource. When omitted, Google Cloud +assigns an ephemeral IP address. + +Use one of the following formats to specify an IP address while creating a +forwarding rule: + +* IP address number, as in '100.1.2.3' +* IPv6 address range, as in '2600:1234::/96' +* Full resource URL, as in +'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name' +* Partial URL or by name, as in: + * 'projects/project_id/regions/region/addresses/address-name' + * 'regions/region/addresses/address-name' + * 'global/addresses/address-name' + * 'address-name' + + +The forwarding rule's 'target', +and in most cases, also the 'loadBalancingScheme', determine the +type of IP address that you can use. For detailed information, see +[IP address +specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). + +When reading an 'IPAddress', the API always returns the IP +address number. When `null`, the `ip_address` field will be omitted from the resulting object. + - `ip_protocol` (`string`): The IP protocol to which this rule applies. + +For protocol forwarding, valid +options are 'TCP', 'UDP', 'ESP', +'AH', 'SCTP', 'ICMP' and +'L3_DEFAULT'. + +The valid IP protocols are different for different load balancing products +as described in [Load balancing +features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). Possible values: ["TCP", "UDP", "ESP", "AH", "SCTP", "ICMP"] When `null`, the `ip_protocol` field will be omitted from the resulting object. + - `ip_version` (`string`): The IP Version that will be used by this global forwarding rule. Possible values: ["IPV4", "IPV6"] When `null`, the `ip_version` field will be omitted from the resulting object. + - `labels` (`obj`): Labels to apply to this forwarding rule. A list of key->value pairs. When `null`, the `labels` field will be omitted from the resulting object. - `load_balancing_scheme` (`string`): Specifies the forwarding rule type. -* `EXTERNAL` is used for: - * Classic Cloud VPN gateways - * Protocol forwarding to VMs from an external IP address - * The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP -* `INTERNAL` is used for: - * Protocol forwarding to VMs from an internal IP address - * Internal TCP/UDP load balancers -* `INTERNAL_MANAGED` is used for: - * Internal HTTP(S) load balancers -* `INTERNAL_SELF_MANAGED` is used for: - * Traffic Director -* `EXTERNAL_MANAGED` is used for: - * Global external HTTP(S) load balancers - -For more information about forwarding rules, refer to [Forwarding rule concepts](/load-balancing/docs/forwarding-rule-concepts). Possible values: INVALID, INTERNAL, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED, EXTERNAL, EXTERNAL_MANAGED When `null`, the `load_balancing_scheme` field will be omitted from the resulting object. - - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - - `network` (`string`): This field is not used for external load balancing. For `INTERNAL` and `INTERNAL_SELF_MANAGED` load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. When `null`, the `network` field will be omitted from the resulting object. - - `port_range` (`string`): When the load balancing scheme is `EXTERNAL`, `INTERNAL_SELF_MANAGED` and `INTERNAL_MANAGED`, you can specify a `port_range`. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the `target` field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when `IPProtocol` is `TCP`, `UDP`, or `SCTP`, only packets addressed to ports in the specified range will be forwarded to `target`. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: - -* TargetHttpProxy: 80, 8080 -* TargetHttpsProxy: 443 -* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 -* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 -* TargetVpnGateway: 500, 4500 - -@pattern: d+(?:-d+)? When `null`, the `port_range` field will be omitted from the resulting object. - - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object. - - `target` (`string`): The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For `INTERNAL_SELF_MANAGED` load balancing, only `targetHttpProxy` is valid, not `targetHttpsProxy`. - - `metadata_filters` (`list[obj]`): Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of [xDS](https://github.com/envoyproxy/data-plane-api/blob/master/XDS_PROTOCOL.md) compliant clients. In their xDS requests to Loadbalancer, xDS clients present [node metadata](https://github.com/envoyproxy/data-plane-api/search?q=%22message+Node%22+in%3A%2Fenvoy%2Fapi%2Fv2%2Fcore%2Fbase.proto&). If a match takes place, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. `TargetHttpProxy`, `UrlMap`) referenced by the `ForwardingRule` will not be visible to those proxies. - -For each `metadataFilter` in this list, if its `filterMatchCriteria` is set to MATCH_ANY, at least one of the `filterLabel`s must match the corresponding label provided in the metadata. If its `filterMatchCriteria` is set to MATCH_ALL, then all of its `filterLabel`s must match with corresponding labels provided in the metadata. - -`metadataFilters` specified here will be applifed before those specified in the `UrlMap` that this `ForwardingRule` references. - -`metadataFilters` only applies to Loadbalancers that have their loadBalancingScheme set to `INTERNAL_SELF_MANAGED`. When `null`, the `metadata_filters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_global_forwarding_rule.metadata_filters.new](#fn-metadata_filtersnew) constructor. +For more information about forwarding rules, refer to +[Forwarding rule concepts](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts). Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL_SELF_MANAGED"] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource; provided by the client when the resource is created. +The name must be 1-63 characters long, and comply with +[RFC1035](https://www.ietf.org/rfc/rfc1035.txt). + +Specifically, the name must be 1-63 characters long and match the regular +expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first +character must be a lowercase letter, and all following characters must +be a dash, lowercase letter, or digit, except the last character, which +cannot be a dash. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, the forwarding rule name must be a 1-20 characters string with +lowercase letters and numbers and must start with a letter. + - `network` (`string`): This field is not used for external load balancing. + +For Internal TCP/UDP Load Balancing, this field identifies the network that +the load balanced IP should belong to for this Forwarding Rule. +If the subnetwork is specified, the network of the subnetwork will be used. +If neither subnetwork nor this field is specified, the default network will +be used. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, a network must be provided. When `null`, the `network` field will be omitted from the resulting object. + - `port_range` (`string`): This field can only be used: + +* If 'IPProtocol' is one of TCP, UDP, or SCTP. +* By backend service-based network load balancers, target pool-based +network load balancers, internal proxy load balancers, external proxy load +balancers, Traffic Director, external protocol forwarding, and Classic VPN. +Some products have restrictions on what ports can be used. See +[port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications) +for details. + + +* TargetHttpProxy: 80, 8080 +* TargetHttpsProxy: 443 +* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, + 1883, 5222 +* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, + 1883, 5222 +* TargetVpnGateway: 500, 4500 When `null`, the `port_range` 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. + - `source_ip_ranges` (`list`): If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). When `null`, the `source_ip_ranges` field will be omitted from the resulting object. + - `target` (`string`): The URL of the target resource to receive the matched traffic. For +regional forwarding rules, this target must be in the same region as the +forwarding rule. For global forwarding rules, this target must be a global +load balancing resource. + +The forwarded traffic must be of a type appropriate to the target object. +* For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). +* For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: + * 'vpc-sc' - [ APIs that support VPC Service Controls](https://cloud.google.com/vpc-service-controls/docs/supported-products). + * 'all-apis' - [All supported Google APIs](https://cloud.google.com/vpc/docs/private-service-connect#supported-apis). + + +For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. + - `metadata_filters` (`list[obj]`): Opaque filter criteria used by Loadbalancer to restrict routing +configuration to a limited set xDS compliant clients. In their xDS +requests to Loadbalancer, xDS clients present node metadata. If a +match takes place, the relevant routing configuration is made available +to those proxies. + +For each metadataFilter in this list, if its filterMatchCriteria is set +to MATCH_ANY, at least one of the filterLabels must match the +corresponding label provided in the metadata. If its filterMatchCriteria +is set to MATCH_ALL, then all of its filterLabels must match with +corresponding labels in the provided metadata. + +metadataFilters specified here can be overridden by those specified in +the UrlMap that this ForwardingRule references. + +metadataFilters only applies to Loadbalancers that have their +loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `metadata_filters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_global_forwarding_rule.metadata_filters.new](#fn-metadata_filtersnew) 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-beta.google_compute_global_forwarding_rule.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -132,54 +224,160 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `description` (`string`): An optional description of this resource. Provide this property when you create the resource. When `null`, the `description` field will be omitted from the resulting object. - - `ip_address` (`string`): IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in `https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name` * Partial URL or by name, as in: * `projects/project_id/regions/region/addresses/address-name` * `regions/region/addresses/address-name` * `global/addresses/address-name` * `address-name` The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When `null`, the `ip_address` field will be omitted from the resulting object. - - `ip_protocol` (`string`): The IP protocol to which this rule applies. For protocol forwarding, valid options are `TCP`, `UDP`, `ESP`, `AH`, `SCTP` or `ICMP`. For Internal TCP/UDP Load Balancing, the load balancing scheme is `INTERNAL`, and one of `TCP` or `UDP` are valid. For Traffic Director, the load balancing scheme is `INTERNAL_SELF_MANAGED`, and only `TCP`is valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is `INTERNAL_MANAGED`, and only `TCP` is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is `EXTERNAL` and only `TCP` is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is `EXTERNAL`, and one of `TCP` or `UDP` is valid. When `null`, the `ip_protocol` field will be omitted from the resulting object. - - `ip_version` (`string`): The IP Version that will be used by this forwarding rule. Valid options are `IPV4` or `IPV6`. This can only be specified for an external global forwarding rule. Possible values: UNSPECIFIED_VERSION, IPV4, IPV6 When `null`, the `ip_version` field will be omitted from the resulting object. - - `labels` (`obj`): Labels to apply to this rule. When `null`, the `labels` field will be omitted from the resulting object. + - `allow_psc_global_access` (`bool`): This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. When `null`, the `allow_psc_global_access` field will be omitted from the resulting object. + - `description` (`string`): An optional description of this resource. Provide this property when +you create the resource. When `null`, the `description` field will be omitted from the resulting object. + - `ip_address` (`string`): IP address for which this forwarding rule accepts traffic. When a client +sends traffic to this IP address, the forwarding rule directs the traffic +to the referenced 'target'. + +While creating a forwarding rule, specifying an 'IPAddress' is +required under the following circumstances: + +* When the 'target' is set to 'targetGrpcProxy' and +'validateForProxyless' is set to 'true', the +'IPAddress' should be set to '0.0.0.0'. +* When the 'target' is a Private Service Connect Google APIs +bundle, you must specify an 'IPAddress'. + + +Otherwise, you can optionally specify an IP address that references an +existing static (reserved) IP address resource. When omitted, Google Cloud +assigns an ephemeral IP address. + +Use one of the following formats to specify an IP address while creating a +forwarding rule: + +* IP address number, as in '100.1.2.3' +* IPv6 address range, as in '2600:1234::/96' +* Full resource URL, as in +'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name' +* Partial URL or by name, as in: + * 'projects/project_id/regions/region/addresses/address-name' + * 'regions/region/addresses/address-name' + * 'global/addresses/address-name' + * 'address-name' + + +The forwarding rule's 'target', +and in most cases, also the 'loadBalancingScheme', determine the +type of IP address that you can use. For detailed information, see +[IP address +specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). + +When reading an 'IPAddress', the API always returns the IP +address number. When `null`, the `ip_address` field will be omitted from the resulting object. + - `ip_protocol` (`string`): The IP protocol to which this rule applies. + +For protocol forwarding, valid +options are 'TCP', 'UDP', 'ESP', +'AH', 'SCTP', 'ICMP' and +'L3_DEFAULT'. + +The valid IP protocols are different for different load balancing products +as described in [Load balancing +features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). Possible values: ["TCP", "UDP", "ESP", "AH", "SCTP", "ICMP"] When `null`, the `ip_protocol` field will be omitted from the resulting object. + - `ip_version` (`string`): The IP Version that will be used by this global forwarding rule. Possible values: ["IPV4", "IPV6"] When `null`, the `ip_version` field will be omitted from the resulting object. + - `labels` (`obj`): Labels to apply to this forwarding rule. A list of key->value pairs. When `null`, the `labels` field will be omitted from the resulting object. - `load_balancing_scheme` (`string`): Specifies the forwarding rule type. -* `EXTERNAL` is used for: - * Classic Cloud VPN gateways - * Protocol forwarding to VMs from an external IP address - * The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP -* `INTERNAL` is used for: - * Protocol forwarding to VMs from an internal IP address - * Internal TCP/UDP load balancers -* `INTERNAL_MANAGED` is used for: - * Internal HTTP(S) load balancers -* `INTERNAL_SELF_MANAGED` is used for: - * Traffic Director -* `EXTERNAL_MANAGED` is used for: - * Global external HTTP(S) load balancers - -For more information about forwarding rules, refer to [Forwarding rule concepts](/load-balancing/docs/forwarding-rule-concepts). Possible values: INVALID, INTERNAL, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED, EXTERNAL, EXTERNAL_MANAGED When `null`, the `load_balancing_scheme` field will be omitted from the resulting object. - - `name` (`string`): Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - - `network` (`string`): This field is not used for external load balancing. For `INTERNAL` and `INTERNAL_SELF_MANAGED` load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. When `null`, the `network` field will be omitted from the resulting object. - - `port_range` (`string`): When the load balancing scheme is `EXTERNAL`, `INTERNAL_SELF_MANAGED` and `INTERNAL_MANAGED`, you can specify a `port_range`. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the `target` field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when `IPProtocol` is `TCP`, `UDP`, or `SCTP`, only packets addressed to ports in the specified range will be forwarded to `target`. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: - -* TargetHttpProxy: 80, 8080 -* TargetHttpsProxy: 443 -* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 -* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 -* TargetVpnGateway: 500, 4500 - -@pattern: d+(?:-d+)? When `null`, the `port_range` field will be omitted from the resulting object. - - `project` (`string`): The project this resource belongs in. When `null`, the `project` field will be omitted from the resulting object. - - `target` (`string`): The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For `INTERNAL_SELF_MANAGED` load balancing, only `targetHttpProxy` is valid, not `targetHttpsProxy`. - - `metadata_filters` (`list[obj]`): Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of [xDS](https://github.com/envoyproxy/data-plane-api/blob/master/XDS_PROTOCOL.md) compliant clients. In their xDS requests to Loadbalancer, xDS clients present [node metadata](https://github.com/envoyproxy/data-plane-api/search?q=%22message+Node%22+in%3A%2Fenvoy%2Fapi%2Fv2%2Fcore%2Fbase.proto&). If a match takes place, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. `TargetHttpProxy`, `UrlMap`) referenced by the `ForwardingRule` will not be visible to those proxies. - -For each `metadataFilter` in this list, if its `filterMatchCriteria` is set to MATCH_ANY, at least one of the `filterLabel`s must match the corresponding label provided in the metadata. If its `filterMatchCriteria` is set to MATCH_ALL, then all of its `filterLabel`s must match with corresponding labels provided in the metadata. - -`metadataFilters` specified here will be applifed before those specified in the `UrlMap` that this `ForwardingRule` references. - -`metadataFilters` only applies to Loadbalancers that have their loadBalancingScheme set to `INTERNAL_SELF_MANAGED`. When `null`, the `metadata_filters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_global_forwarding_rule.metadata_filters.new](#fn-metadata_filtersnew) constructor. +For more information about forwarding rules, refer to +[Forwarding rule concepts](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts). Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL_SELF_MANAGED"] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object. + - `name` (`string`): Name of the resource; provided by the client when the resource is created. +The name must be 1-63 characters long, and comply with +[RFC1035](https://www.ietf.org/rfc/rfc1035.txt). + +Specifically, the name must be 1-63 characters long and match the regular +expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first +character must be a lowercase letter, and all following characters must +be a dash, lowercase letter, or digit, except the last character, which +cannot be a dash. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, the forwarding rule name must be a 1-20 characters string with +lowercase letters and numbers and must start with a letter. + - `network` (`string`): This field is not used for external load balancing. + +For Internal TCP/UDP Load Balancing, this field identifies the network that +the load balanced IP should belong to for this Forwarding Rule. +If the subnetwork is specified, the network of the subnetwork will be used. +If neither subnetwork nor this field is specified, the default network will +be used. + +For Private Service Connect forwarding rules that forward traffic to Google +APIs, a network must be provided. When `null`, the `network` field will be omitted from the resulting object. + - `port_range` (`string`): This field can only be used: + +* If 'IPProtocol' is one of TCP, UDP, or SCTP. +* By backend service-based network load balancers, target pool-based +network load balancers, internal proxy load balancers, external proxy load +balancers, Traffic Director, external protocol forwarding, and Classic VPN. +Some products have restrictions on what ports can be used. See +[port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#port_specifications) +for details. + + +* TargetHttpProxy: 80, 8080 +* TargetHttpsProxy: 443 +* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, + 1883, 5222 +* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, + 1883, 5222 +* TargetVpnGateway: 500, 4500 When `null`, the `port_range` 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. + - `source_ip_ranges` (`list`): If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). When `null`, the `source_ip_ranges` field will be omitted from the resulting object. + - `target` (`string`): The URL of the target resource to receive the matched traffic. For +regional forwarding rules, this target must be in the same region as the +forwarding rule. For global forwarding rules, this target must be a global +load balancing resource. + +The forwarded traffic must be of a type appropriate to the target object. +* For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). +* For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: + * 'vpc-sc' - [ APIs that support VPC Service Controls](https://cloud.google.com/vpc-service-controls/docs/supported-products). + * 'all-apis' - [All supported Google APIs](https://cloud.google.com/vpc/docs/private-service-connect#supported-apis). + + +For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. + - `metadata_filters` (`list[obj]`): Opaque filter criteria used by Loadbalancer to restrict routing +configuration to a limited set xDS compliant clients. In their xDS +requests to Loadbalancer, xDS clients present node metadata. If a +match takes place, the relevant routing configuration is made available +to those proxies. + +For each metadataFilter in this list, if its filterMatchCriteria is set +to MATCH_ANY, at least one of the filterLabels must match the +corresponding label provided in the metadata. If its filterMatchCriteria +is set to MATCH_ALL, then all of its filterLabels must match with +corresponding labels in the provided metadata. + +metadataFilters specified here can be overridden by those specified in +the UrlMap that this ForwardingRule references. + +metadataFilters only applies to Loadbalancers that have their +loadBalancingScheme set to INTERNAL_SELF_MANAGED. When `null`, the `metadata_filters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_global_forwarding_rule.metadata_filters.new](#fn-metadata_filtersnew) 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-beta.google_compute_global_forwarding_rule.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 `google_compute_global_forwarding_rule` resource into the root Terraform configuration. +### fn withAllowPscGlobalAccess + +```ts +withAllowPscGlobalAccess() +``` + +`google-beta.bool.withAllowPscGlobalAccess` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the allow_psc_global_access field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `allow_psc_global_access` field. + + ### fn withDescription ```ts @@ -377,6 +575,22 @@ Terraform resource block to set or update the project field. - `value` (`string`): The value to set for the `project` field. +### fn withSourceIpRanges + +```ts +withSourceIpRanges() +``` + +`google-beta.list.withSourceIpRanges` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the source_ip_ranges field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `source_ip_ranges` field. + + ### fn withTarget ```ts @@ -446,13 +660,15 @@ Terraform sub block. **Args**: - - `filter_match_criteria` (`string`): Specifies how individual `filterLabel` matches within the list of `filterLabel`s contribute towards the overall `metadataFilter` match. + - `filter_match_criteria` (`string`): Specifies how individual filterLabel matches within the list of +filterLabels contribute towards the overall metadataFilter match. -Supported values are: - -* MATCH_ANY: At least one of the `filterLabels` must have a matching label in the provided metadata. -* MATCH_ALL: All `filterLabels` must have matching labels in the provided metadata. Possible values: NOT_SET, MATCH_ALL, MATCH_ANY - - `filter_labels` (`list[obj]`): The list of label value pairs that must match labels in the provided metadata based on `filterMatchCriteria` +MATCH_ANY - At least one of the filterLabels must have a matching +label in the provided metadata. +MATCH_ALL - All filterLabels must have matching labels in the +provided metadata. Possible values: ["MATCH_ANY", "MATCH_ALL"] + - `filter_labels` (`list[obj]`): The list of label value pairs that must match labels in the +provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. When `null`, the `filter_labels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_global_forwarding_rule.metadata_filters.filter_labels.new](#fn-metadata_filtersfilter_labelsnew) constructor. @@ -477,12 +693,10 @@ Terraform sub block. **Args**: - - `name` (`string`): Name of metadata label. - -The name can have a maximum length of 1024 characters and must be at least 1 character long. - - `value` (`string`): The value of the label must match the specified value. - -value can have a maximum length of 1024 characters. + - `name` (`string`): Name of the metadata label. The length must be between +1 and 1024 characters, inclusive. + - `value` (`string`): The value that the label must match. The value has a maximum +length of 1024 characters. **Returns**: - An attribute object that represents the `filter_labels` sub block. diff --git a/docs/4.x/google_compute_network.md b/docs/4.x/google_compute_network.md index a481bf9e..17b07f0f 100644 --- a/docs/4.x/google_compute_network.md +++ b/docs/4.x/google_compute_network.md @@ -69,17 +69,17 @@ the user can explicitly connect subnetwork resources. When `null`, the `auto_cre immediately after network creation. Defaults to 'false'. When `null`, the `delete_default_routes_on_create` field will be omitted from the resulting object. - `description` (`string`): An optional description of this resource. The resource must be recreated to modify this field. When `null`, the `description` field will be omitted from the resulting object. - - `enable_ula_internal_ipv6` (`bool`): Enable ULA internal ipv6 on this network. Enabling this feature will assign + - `enable_ula_internal_ipv6` (`bool`): Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. When `null`, the `enable_ula_internal_ipv6` field will be omitted from the resulting object. - - `internal_ipv6_range` (`string`): When enabling ula internal ipv6, caller optionally can specify the /48 range -they want from the google defined ULA prefix fd20::/20. The input must be a -valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will -fail if the speficied /48 is already in used by another resource. + - `internal_ipv6_range` (`string`): When enabling ula internal ipv6, caller optionally can specify the /48 range +they want from the google defined ULA prefix fd20::/20. The input must be a +valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will +fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. When `null`, the `internal_ipv6_range` field will be omitted from the resulting object. - - `mtu` (`number`): Maximum Transmission Unit in bytes. The default value is 1460 bytes. + - `mtu` (`number`): Maximum Transmission Unit in bytes. The default value is 1460 bytes. The minimum value for this field is 1300 and the maximum value is 8896 bytes (jumbo frames). Note that packets larger than 1500 bytes (standard Ethernet) can be subject to TCP-MSS clamping or dropped -with an ICMP 'Fragmentation-Needed' message if the packets are routed to the Internet or other VPCs +with an ICMP 'Fragmentation-Needed' message if the packets are routed to the Internet or other VPCs with varying MTUs. When `null`, the `mtu` field will be omitted from the resulting object. - `name` (`string`): Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with @@ -88,7 +88,7 @@ the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - - `network_firewall_policy_enforcement_order` (`string`): Set the order that Firewall Rules and Firewall Policies are evaluated. Needs to be either 'AFTER_CLASSIC_FIREWALL' or 'BEFORE_CLASSIC_FIREWALL' Default 'AFTER_CLASSIC_FIREWALL' Default value: "AFTER_CLASSIC_FIREWALL" Possible values: ["BEFORE_CLASSIC_FIREWALL", "AFTER_CLASSIC_FIREWALL"] When `null`, the `network_firewall_policy_enforcement_order` field will be omitted from the resulting object. + - `network_firewall_policy_enforcement_order` (`string`): Set the order that Firewall Rules and Firewall Policies are evaluated. Default value: "AFTER_CLASSIC_FIREWALL" Possible values: ["BEFORE_CLASSIC_FIREWALL", "AFTER_CLASSIC_FIREWALL"] When `null`, the `network_firewall_policy_enforcement_order` 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. - `routing_mode` (`string`): The network-wide routing mode to use. If set to 'REGIONAL', this network's cloud routers will only advertise routes with subnetworks @@ -129,17 +129,17 @@ the user can explicitly connect subnetwork resources. When `null`, the `auto_cre immediately after network creation. Defaults to 'false'. When `null`, the `delete_default_routes_on_create` field will be omitted from the resulting object. - `description` (`string`): An optional description of this resource. The resource must be recreated to modify this field. When `null`, the `description` field will be omitted from the resulting object. - - `enable_ula_internal_ipv6` (`bool`): Enable ULA internal ipv6 on this network. Enabling this feature will assign + - `enable_ula_internal_ipv6` (`bool`): Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. When `null`, the `enable_ula_internal_ipv6` field will be omitted from the resulting object. - - `internal_ipv6_range` (`string`): When enabling ula internal ipv6, caller optionally can specify the /48 range -they want from the google defined ULA prefix fd20::/20. The input must be a -valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will -fail if the speficied /48 is already in used by another resource. + - `internal_ipv6_range` (`string`): When enabling ula internal ipv6, caller optionally can specify the /48 range +they want from the google defined ULA prefix fd20::/20. The input must be a +valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will +fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. When `null`, the `internal_ipv6_range` field will be omitted from the resulting object. - - `mtu` (`number`): Maximum Transmission Unit in bytes. The default value is 1460 bytes. + - `mtu` (`number`): Maximum Transmission Unit in bytes. The default value is 1460 bytes. The minimum value for this field is 1300 and the maximum value is 8896 bytes (jumbo frames). Note that packets larger than 1500 bytes (standard Ethernet) can be subject to TCP-MSS clamping or dropped -with an ICMP 'Fragmentation-Needed' message if the packets are routed to the Internet or other VPCs +with an ICMP 'Fragmentation-Needed' message if the packets are routed to the Internet or other VPCs with varying MTUs. When `null`, the `mtu` field will be omitted from the resulting object. - `name` (`string`): Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with @@ -148,7 +148,7 @@ the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - - `network_firewall_policy_enforcement_order` (`string`): Set the order that Firewall Rules and Firewall Policies are evaluated. Needs to be either 'AFTER_CLASSIC_FIREWALL' or 'BEFORE_CLASSIC_FIREWALL' Default 'AFTER_CLASSIC_FIREWALL' Default value: "AFTER_CLASSIC_FIREWALL" Possible values: ["BEFORE_CLASSIC_FIREWALL", "AFTER_CLASSIC_FIREWALL"] When `null`, the `network_firewall_policy_enforcement_order` field will be omitted from the resulting object. + - `network_firewall_policy_enforcement_order` (`string`): Set the order that Firewall Rules and Firewall Policies are evaluated. Default value: "AFTER_CLASSIC_FIREWALL" Possible values: ["BEFORE_CLASSIC_FIREWALL", "AFTER_CLASSIC_FIREWALL"] When `null`, the `network_firewall_policy_enforcement_order` 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. - `routing_mode` (`string`): The network-wide routing mode to use. If set to 'REGIONAL', this network's cloud routers will only advertise routes with subnetworks diff --git a/docs/4.x/google_compute_network_firewall_policy_rule.md b/docs/4.x/google_compute_network_firewall_policy_rule.md index 8c50a7f2..0464d570 100644 --- a/docs/4.x/google_compute_network_firewall_policy_rule.md +++ b/docs/4.x/google_compute_network_firewall_policy_rule.md @@ -412,8 +412,16 @@ Terraform sub block. **Args**: + - `dest_address_groups` (`list`): Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules. When `null`, the `dest_address_groups` field will be omitted from the resulting object. + - `dest_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_fqdns` field will be omitted from the resulting object. - `dest_ip_ranges` (`list`): CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. When `null`, the `dest_ip_ranges` field will be omitted from the resulting object. + - `dest_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_region_codes` field will be omitted from the resulting object. + - `dest_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `dest_threat_intelligences` field will be omitted from the resulting object. + - `src_address_groups` (`list`): Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules. When `null`, the `src_address_groups` field will be omitted from the resulting object. + - `src_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_fqdns` field will be omitted from the resulting object. - `src_ip_ranges` (`list`): CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. When `null`, the `src_ip_ranges` field will be omitted from the resulting object. + - `src_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_region_codes` field will be omitted from the resulting object. + - `src_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `src_threat_intelligences` field will be omitted from the resulting object. - `layer4_configs` (`list[obj]`): Pairs of IP protocols and ports that the rule should match. When `null`, the `layer4_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_network_firewall_policy_rule.match.layer4_configs.new](#fn-matchlayer4_configsnew) constructor. - `src_secure_tags` (`list[obj]`): List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the <code>srcSecureTag</code> are INEFFECTIVE, and there is no <code>srcIpRange</code>, this rule will be ignored. Maximum number of source tag values allowed is 256. When `null`, the `src_secure_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-beta.google_compute_network_firewall_policy_rule.match.src_secure_tags.new](#fn-matchsrc_secure_tagsnew) constructor. diff --git a/docs/4.x/google_compute_region_commitment.md b/docs/4.x/google_compute_region_commitment.md index af674eb3..c18633a1 100644 --- a/docs/4.x/google_compute_region_commitment.md +++ b/docs/4.x/google_compute_region_commitment.md @@ -65,9 +65,9 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment. -The default value is false if not specified. -If the field is set to true, the commitment will be automatically renewed for either + - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment. +The default value is false if not specified. +If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. When `null`, the `auto_renew` field will be omitted from the resulting object. - `category` (`string`): The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE @@ -83,12 +83,12 @@ character, which cannot be a dash. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Possible values: ["TWELVE_MONTH", "THIRTY_SIX_MONTH"] - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `region` (`string`): URL of the region where this commitment may be used. When `null`, the `region` field will be omitted from the resulting object. - - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources. + - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. Possible values: ["MEMORY_OPTIMIZED", "ACCELERATOR_OPTIMIZED"] When `null`, the `type` field will be omitted from the resulting object. - `license_resource` (`list[obj]`): The license specification required as part of a license commitment. When `null`, the `license_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.license_resource.new](#fn-license_resourcenew) constructor. - - `resources` (`list[obj]`): A list of commitment amounts for particular resources. + - `resources` (`list[obj]`): A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. When `null`, the `resources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.resources.new](#fn-resourcesnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.timeouts.new](#fn-timeoutsnew) constructor. @@ -114,9 +114,9 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment. -The default value is false if not specified. -If the field is set to true, the commitment will be automatically renewed for either + - `auto_renew` (`bool`): Specifies whether to enable automatic renewal for the commitment. +The default value is false if not specified. +If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. When `null`, the `auto_renew` field will be omitted from the resulting object. - `category` (`string`): The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE @@ -132,12 +132,12 @@ character, which cannot be a dash. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). Possible values: ["TWELVE_MONTH", "THIRTY_SIX_MONTH"] - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `region` (`string`): URL of the region where this commitment may be used. When `null`, the `region` field will be omitted from the resulting object. - - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources. + - `type` (`string`): The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. Possible values: ["MEMORY_OPTIMIZED", "ACCELERATOR_OPTIMIZED"] When `null`, the `type` field will be omitted from the resulting object. - `license_resource` (`list[obj]`): The license specification required as part of a license commitment. When `null`, the `license_resource` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.license_resource.new](#fn-license_resourcenew) constructor. - - `resources` (`list[obj]`): A list of commitment amounts for particular resources. + - `resources` (`list[obj]`): A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. When `null`, the `resources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.resources.new](#fn-resourcesnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_commitment.timeouts.new](#fn-timeoutsnew) constructor. diff --git a/docs/4.x/google_compute_region_disk.md b/docs/4.x/google_compute_region_disk.md index ba97319e..b82006cf 100644 --- a/docs/4.x/google_compute_region_disk.md +++ b/docs/4.x/google_compute_region_disk.md @@ -15,6 +15,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withAsyncPrimaryDisk()`](#fn-withasyncprimarydisk) +* [`fn withAsyncPrimaryDiskMixin()`](#fn-withasyncprimarydiskmixin) * [`fn withDescription()`](#fn-withdescription) * [`fn withDiskEncryptionKey()`](#fn-withdiskencryptionkey) * [`fn withDiskEncryptionKeyMixin()`](#fn-withdiskencryptionkeymixin) @@ -33,6 +35,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`fn withType()`](#fn-withtype) +* [`obj async_primary_disk`](#obj-async_primary_disk) + * [`fn new()`](#fn-async_primary_disknew) * [`obj disk_encryption_key`](#obj-disk_encryption_key) * [`fn new()`](#fn-disk_encryption_keynew) * [`obj source_snapshot_encryption_key`](#obj-source_snapshot_encryption_key) @@ -115,6 +119,7 @@ For example, the following are valid values: * regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object. - `type` (`string`): URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object. + - `async_primary_disk` (`list[obj]`): A nested object resource When `null`, the `async_primary_disk` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.async_primary_disk.new](#fn-async_primary_disknew) constructor. - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must @@ -200,6 +205,7 @@ For example, the following are valid values: * regions/{region}/disks/{disk} When `null`, the `source_disk` field will be omitted from the resulting object. - `type` (`string`): URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. When `null`, the `type` field will be omitted from the resulting object. + - `async_primary_disk` (`list[obj]`): A nested object resource When `null`, the `async_primary_disk` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_disk.async_primary_disk.new](#fn-async_primary_disknew) constructor. - `disk_encryption_key` (`list[obj]`): Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must @@ -221,6 +227,43 @@ key. When `null`, the `source_snapshot_encryption_key` sub block will be omitted - 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 `google_compute_region_disk` resource into the root Terraform configuration. +### fn withAsyncPrimaryDisk + +```ts +withAsyncPrimaryDisk() +``` + +`google-beta.list[obj].withAsyncPrimaryDisk` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the async_primary_disk 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-beta.list[obj].withAsyncPrimaryDiskMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `async_primary_disk` field. + + +### fn withAsyncPrimaryDiskMixin + +```ts +withAsyncPrimaryDiskMixin() +``` + +`google-beta.list[obj].withAsyncPrimaryDiskMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the async_primary_disk 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-beta.list[obj].withAsyncPrimaryDisk](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `async_primary_disk` field. + + ### fn withDescription ```ts @@ -523,6 +566,29 @@ Terraform resource block to set or update the type field. - `value` (`string`): The value to set for the `type` field. +## obj async_primary_disk + + + +### fn async_primary_disk.new + +```ts +new() +``` + + +`google-beta.google_compute_region_disk.async_primary_disk.new` constructs a new object with attributes and blocks configured for the `async_primary_disk` +Terraform sub block. + + + +**Args**: + - `disk` (`string`): Primary disk for asynchronous disk replication. + +**Returns**: + - An attribute object that represents the `async_primary_disk` sub block. + + ## obj disk_encryption_key diff --git a/docs/4.x/google_compute_region_network_firewall_policy_rule.md b/docs/4.x/google_compute_region_network_firewall_policy_rule.md index 9064993c..60ae67eb 100644 --- a/docs/4.x/google_compute_region_network_firewall_policy_rule.md +++ b/docs/4.x/google_compute_region_network_firewall_policy_rule.md @@ -431,8 +431,16 @@ Terraform sub block. **Args**: + - `dest_address_groups` (`list`): Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules. When `null`, the `dest_address_groups` field will be omitted from the resulting object. + - `dest_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_fqdns` field will be omitted from the resulting object. - `dest_ip_ranges` (`list`): CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. When `null`, the `dest_ip_ranges` field will be omitted from the resulting object. + - `dest_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress. When `null`, the `dest_region_codes` field will be omitted from the resulting object. + - `dest_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `dest_threat_intelligences` field will be omitted from the resulting object. + - `src_address_groups` (`list`): Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules. When `null`, the `src_address_groups` field will be omitted from the resulting object. + - `src_fqdns` (`list`): Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_fqdns` field will be omitted from the resulting object. - `src_ip_ranges` (`list`): CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. When `null`, the `src_ip_ranges` field will be omitted from the resulting object. + - `src_region_codes` (`list`): The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress. When `null`, the `src_region_codes` field will be omitted from the resulting object. + - `src_threat_intelligences` (`list`): Name of the Google Cloud Threat Intelligence list. When `null`, the `src_threat_intelligences` field will be omitted from the resulting object. - `layer4_configs` (`list[obj]`): Pairs of IP protocols and ports that the rule should match. When `null`, the `layer4_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_region_network_firewall_policy_rule.match.layer4_configs.new](#fn-matchlayer4_configsnew) constructor. - `src_secure_tags` (`list[obj]`): List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the <code>srcSecureTag</code> are INEFFECTIVE, and there is no <code>srcIpRange</code>, this rule will be ignored. Maximum number of source tag values allowed is 256. When `null`, the `src_secure_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-beta.google_compute_region_network_firewall_policy_rule.match.src_secure_tags.new](#fn-matchsrc_secure_tagsnew) constructor. diff --git a/docs/4.x/google_compute_resource_policy.md b/docs/4.x/google_compute_resource_policy.md index 1b2cbc47..fad864d0 100644 --- a/docs/4.x/google_compute_resource_policy.md +++ b/docs/4.x/google_compute_resource_policy.md @@ -16,6 +16,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) * [`fn withDescription()`](#fn-withdescription) +* [`fn withDiskConsistencyGroupPolicy()`](#fn-withdiskconsistencygrouppolicy) +* [`fn withDiskConsistencyGroupPolicyMixin()`](#fn-withdiskconsistencygrouppolicymixin) * [`fn withGroupPlacementPolicy()`](#fn-withgroupplacementpolicy) * [`fn withGroupPlacementPolicyMixin()`](#fn-withgroupplacementpolicymixin) * [`fn withInstanceSchedulePolicy()`](#fn-withinstanceschedulepolicy) @@ -27,6 +29,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withSnapshotSchedulePolicyMixin()`](#fn-withsnapshotschedulepolicymixin) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj disk_consistency_group_policy`](#obj-disk_consistency_group_policy) + * [`fn new()`](#fn-disk_consistency_group_policynew) * [`obj group_placement_policy`](#obj-group_placement_policy) * [`fn new()`](#fn-group_placement_policynew) * [`obj instance_schedule_policy`](#obj-instance_schedule_policy) @@ -93,6 +97,7 @@ must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `region` (`string`): Region where resource policy resides. When `null`, the `region` field will be omitted from the resulting object. + - `disk_consistency_group_policy` (`list[obj]`): Replication consistency group for asynchronous disk replication. When `null`, the `disk_consistency_group_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-beta.google_compute_resource_policy.disk_consistency_group_policy.new](#fn-disk_consistency_group_policynew) constructor. - `group_placement_policy` (`list[obj]`): Resource policy for instances used for placement configuration. When `null`, the `group_placement_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-beta.google_compute_resource_policy.group_placement_policy.new](#fn-group_placement_policynew) constructor. - `instance_schedule_policy` (`list[obj]`): Resource policy for scheduling instance operations. When `null`, the `instance_schedule_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-beta.google_compute_resource_policy.instance_schedule_policy.new](#fn-instance_schedule_policynew) constructor. - `snapshot_schedule_policy` (`list[obj]`): Policy for creating snapshots of persistent disks. When `null`, the `snapshot_schedule_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-beta.google_compute_resource_policy.snapshot_schedule_policy.new](#fn-snapshot_schedule_policynew) constructor. @@ -130,6 +135,7 @@ must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `region` (`string`): Region where resource policy resides. When `null`, the `region` field will be omitted from the resulting object. + - `disk_consistency_group_policy` (`list[obj]`): Replication consistency group for asynchronous disk replication. When `null`, the `disk_consistency_group_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-beta.google_compute_resource_policy.disk_consistency_group_policy.new](#fn-disk_consistency_group_policynew) constructor. - `group_placement_policy` (`list[obj]`): Resource policy for instances used for placement configuration. When `null`, the `group_placement_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-beta.google_compute_resource_policy.group_placement_policy.new](#fn-group_placement_policynew) constructor. - `instance_schedule_policy` (`list[obj]`): Resource policy for scheduling instance operations. When `null`, the `instance_schedule_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-beta.google_compute_resource_policy.instance_schedule_policy.new](#fn-instance_schedule_policynew) constructor. - `snapshot_schedule_policy` (`list[obj]`): Policy for creating snapshots of persistent disks. When `null`, the `snapshot_schedule_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-beta.google_compute_resource_policy.snapshot_schedule_policy.new](#fn-snapshot_schedule_policynew) constructor. @@ -155,6 +161,43 @@ Terraform resource block to set or update the description field. - `value` (`string`): The value to set for the `description` field. +### fn withDiskConsistencyGroupPolicy + +```ts +withDiskConsistencyGroupPolicy() +``` + +`google-beta.list[obj].withDiskConsistencyGroupPolicy` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the disk_consistency_group_policy 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-beta.list[obj].withDiskConsistencyGroupPolicyMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `disk_consistency_group_policy` field. + + +### fn withDiskConsistencyGroupPolicyMixin + +```ts +withDiskConsistencyGroupPolicyMixin() +``` + +`google-beta.list[obj].withDiskConsistencyGroupPolicyMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the disk_consistency_group_policy 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-beta.list[obj].withDiskConsistencyGroupPolicy](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `disk_consistency_group_policy` field. + + ### fn withGroupPlacementPolicy ```ts @@ -350,6 +393,29 @@ function. - `value` (`obj`): The value to set for the `timeouts` field. +## obj disk_consistency_group_policy + + + +### fn disk_consistency_group_policy.new + +```ts +new() +``` + + +`google-beta.google_compute_resource_policy.disk_consistency_group_policy.new` constructs a new object with attributes and blocks configured for the `disk_consistency_group_policy` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Enable disk consistency on the resource policy. + +**Returns**: + - An attribute object that represents the `disk_consistency_group_policy` sub block. + + ## obj group_placement_policy @@ -649,8 +715,8 @@ Terraform sub block. **Args**: - - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the -specified name. The chain name must be 1-63 characters long and comply + - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the +specified name. The chain name must be 1-63 characters long and comply with RFC1035. When `null`, the `chain_name` field will be omitted from the resulting object. - `guest_flush` (`bool`): Whether to perform a 'guest aware' snapshot. When `null`, the `guest_flush` field will be omitted from the resulting object. - `labels` (`obj`): A set of key-value pairs. When `null`, the `labels` field will be omitted from the resulting object. diff --git a/docs/4.x/google_compute_router_peer.md b/docs/4.x/google_compute_router_peer.md index 654a9c64..5fa6463f 100644 --- a/docs/4.x/google_compute_router_peer.md +++ b/docs/4.x/google_compute_router_peer.md @@ -23,11 +23,14 @@ This package contains functions and utilities for setting up the resource using * [`fn withBfd()`](#fn-withbfd) * [`fn withBfdMixin()`](#fn-withbfdmixin) * [`fn withEnable()`](#fn-withenable) +* [`fn withEnableIpv6()`](#fn-withenableipv6) * [`fn withInterface()`](#fn-withinterface) * [`fn withIpAddress()`](#fn-withipaddress) +* [`fn withIpv6NexthopAddress()`](#fn-withipv6nexthopaddress) * [`fn withName()`](#fn-withname) * [`fn withPeerAsn()`](#fn-withpeerasn) * [`fn withPeerIpAddress()`](#fn-withpeeripaddress) +* [`fn withPeerIpv6NexthopAddress()`](#fn-withpeeripv6nexthopaddress) * [`fn withProject()`](#fn-withproject) * [`fn withRegion()`](#fn-withregion) * [`fn withRouter()`](#fn-withrouter) @@ -91,9 +94,14 @@ length, the routes with the lowest priority value win. When `null`, the `adverti with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true. When `null`, the `enable` field will be omitted from the resulting object. + - `enable_ipv6` (`bool`): Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. When `null`, the `enable_ipv6` field will be omitted from the resulting object. - `interface` (`string`): Name of the interface the BGP peer is associated with. - `ip_address` (`string`): IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. When `null`, the `ip_address` field will be omitted from the resulting object. + - `ipv6_nexthop_address` (`string`): IPv6 address of the interface inside Google Cloud Platform. +The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. +If you do not specify the next hop addresses, Google Cloud automatically +assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `ipv6_nexthop_address` field will be omitted from the resulting object. - `name` (`string`): Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which @@ -104,6 +112,10 @@ except the last character, which cannot be a dash. Each BGP interface may use a different value. - `peer_ip_address` (`string`): IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. + - `peer_ipv6_nexthop_address` (`string`): IPv6 address of the BGP interface outside Google Cloud Platform. +The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. +If you do not specify the next hop addresses, Google Cloud automatically +assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `peer_ipv6_nexthop_address` 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. - `region` (`string`): Region where the router and BgpPeer reside. If it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object. @@ -163,9 +175,14 @@ length, the routes with the lowest priority value win. When `null`, the `adverti with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true. When `null`, the `enable` field will be omitted from the resulting object. + - `enable_ipv6` (`bool`): Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. When `null`, the `enable_ipv6` field will be omitted from the resulting object. - `interface` (`string`): Name of the interface the BGP peer is associated with. - `ip_address` (`string`): IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. When `null`, the `ip_address` field will be omitted from the resulting object. + - `ipv6_nexthop_address` (`string`): IPv6 address of the interface inside Google Cloud Platform. +The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. +If you do not specify the next hop addresses, Google Cloud automatically +assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `ipv6_nexthop_address` field will be omitted from the resulting object. - `name` (`string`): Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which @@ -176,6 +193,10 @@ except the last character, which cannot be a dash. Each BGP interface may use a different value. - `peer_ip_address` (`string`): IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. + - `peer_ipv6_nexthop_address` (`string`): IPv6 address of the BGP interface outside Google Cloud Platform. +The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. +If you do not specify the next hop addresses, Google Cloud automatically +assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `peer_ipv6_nexthop_address` 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. - `region` (`string`): Region where the router and BgpPeer reside. If it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object. @@ -334,6 +355,22 @@ Terraform resource block to set or update the enable field. - `value` (`bool`): The value to set for the `enable` field. +### fn withEnableIpv6 + +```ts +withEnableIpv6() +``` + +`google-beta.bool.withEnableIpv6` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the enable_ipv6 field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `enable_ipv6` field. + + ### fn withInterface ```ts @@ -366,6 +403,22 @@ Terraform resource block to set or update the ip_address field. - `value` (`string`): The value to set for the `ip_address` field. +### fn withIpv6NexthopAddress + +```ts +withIpv6NexthopAddress() +``` + +`google-beta.string.withIpv6NexthopAddress` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the ipv6_nexthop_address field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `ipv6_nexthop_address` field. + + ### fn withName ```ts @@ -414,6 +467,22 @@ Terraform resource block to set or update the peer_ip_address field. - `value` (`string`): The value to set for the `peer_ip_address` field. +### fn withPeerIpv6NexthopAddress + +```ts +withPeerIpv6NexthopAddress() +``` + +`google-beta.string.withPeerIpv6NexthopAddress` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the peer_ipv6_nexthop_address field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `peer_ipv6_nexthop_address` field. + + ### fn withProject ```ts diff --git a/docs/4.x/google_compute_snapshot.md b/docs/4.x/google_compute_snapshot.md index 4458b566..2333d09c 100644 --- a/docs/4.x/google_compute_snapshot.md +++ b/docs/4.x/google_compute_snapshot.md @@ -65,11 +65,11 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the -specified name. The chain name must be 1-63 characters long and -comply with RFC1035. This is an uncommon option only for advanced -service owners who needs to create separate snapshot chains, for -example, for chargeback tracking. When you describe your snapshot + - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the +specified name. The chain name must be 1-63 characters long and +comply with RFC1035. This is an uncommon option only for advanced +service owners who needs to create separate snapshot chains, for +example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. When `null`, the `chain_name` field will be omitted from the resulting object. - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object. - `labels` (`obj`): Labels to apply to this Snapshot. When `null`, the `labels` field will be omitted from the resulting object. @@ -124,11 +124,11 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the -specified name. The chain name must be 1-63 characters long and -comply with RFC1035. This is an uncommon option only for advanced -service owners who needs to create separate snapshot chains, for -example, for chargeback tracking. When you describe your snapshot + - `chain_name` (`string`): Creates the new snapshot in the snapshot chain labeled with the +specified name. The chain name must be 1-63 characters long and +comply with RFC1035. This is an uncommon option only for advanced +service owners who needs to create separate snapshot chains, for +example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. When `null`, the `chain_name` field will be omitted from the resulting object. - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object. - `labels` (`obj`): Labels to apply to this Snapshot. When `null`, the `labels` field will be omitted from the resulting object. diff --git a/docs/4.x/google_compute_target_https_proxy.md b/docs/4.x/google_compute_target_https_proxy.md index c345580c..a03c9e74 100644 --- a/docs/4.x/google_compute_target_https_proxy.md +++ b/docs/4.x/google_compute_target_https_proxy.md @@ -58,7 +58,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map + - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. Accepted format is '//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}'. When `null`, the `certificate_map` field will be omitted from the resulting object. - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object. @@ -108,7 +108,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map + - `certificate_map` (`string`): A reference to the CertificateMap resource uri that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. Accepted format is '//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}'. When `null`, the `certificate_map` field will be omitted from the resulting object. - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object. diff --git a/docs/4.x/google_container_aws_node_pool.md b/docs/4.x/google_container_aws_node_pool.md index d8c34992..e8a99974 100644 --- a/docs/4.x/google_container_aws_node_pool.md +++ b/docs/4.x/google_container_aws_node_pool.md @@ -44,6 +44,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-configproxy_confignew) * [`obj config.root_volume`](#obj-configroot_volume) * [`fn new()`](#fn-configroot_volumenew) + * [`obj config.spot_config`](#obj-configspot_config) + * [`fn new()`](#fn-configspot_confignew) * [`obj config.ssh_config`](#obj-configssh_config) * [`fn new()`](#fn-configssh_confignew) * [`obj config.taints`](#obj-configtaints) @@ -443,6 +445,7 @@ Terraform sub block. - `instance_placement` (`list[obj]`): Details of placement information for an instance. When `null`, the `instance_placement` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_aws_node_pool.config.instance_placement.new](#fn-configinstance_placementnew) constructor. - `proxy_config` (`list[obj]`): Proxy configuration for outbound HTTP(S) traffic. When `null`, the `proxy_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-beta.google_container_aws_node_pool.config.proxy_config.new](#fn-configproxy_confignew) constructor. - `root_volume` (`list[obj]`): Optional. Template for the root volume provisioned for node pool nodes. Volumes will be provisioned in the availability zone assigned to the node pool subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type. When `null`, the `root_volume` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_aws_node_pool.config.root_volume.new](#fn-configroot_volumenew) constructor. + - `spot_config` (`list[obj]`): Optional. When specified, the node pool will provision Spot instances from the set of spot_config.instance_types. This field is mutually exclusive with `instance_type` When `null`, the `spot_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-beta.google_container_aws_node_pool.config.spot_config.new](#fn-configspot_confignew) constructor. - `ssh_config` (`list[obj]`): Optional. The SSH configuration. When `null`, the `ssh_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-beta.google_container_aws_node_pool.config.ssh_config.new](#fn-configssh_confignew) constructor. - `taints` (`list[obj]`): Optional. The initial taints assigned to nodes of this node pool. When `null`, the `taints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_aws_node_pool.config.taints.new](#fn-configtaintsnew) constructor. @@ -570,6 +573,29 @@ Terraform sub block. - An attribute object that represents the `root_volume` sub block. +## obj config.spot_config + + + +### fn config.spot_config.new + +```ts +new() +``` + + +`google-beta.google_container_aws_node_pool.config.spot_config.new` constructs a new object with attributes and blocks configured for the `spot_config` +Terraform sub block. + + + +**Args**: + - `instance_types` (`list`): List of AWS EC2 instance types for creating a spot node pool's nodes. The specified instance types must have the same number of CPUs and memory. You can use the Amazon EC2 Instance Selector tool (https://github.com/aws/amazon-ec2-instance-selector) to choose instance types with matching CPU and memory + +**Returns**: + - An attribute object that represents the `spot_config` sub block. + + ## obj config.ssh_config diff --git a/docs/4.x/google_data_fusion_instance.md b/docs/4.x/google_data_fusion_instance.md index dd289349..e04e2461 100644 --- a/docs/4.x/google_data_fusion_instance.md +++ b/docs/4.x/google_data_fusion_instance.md @@ -103,13 +103,13 @@ of concurrent pipelines, no support for streaming pipelines, etc. - ENTERPRISE: Enterprise Data Fusion instance. In Enterprise type, the user will have more features available, such as support for streaming pipelines, higher number of concurrent pipelines, etc. - DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but -with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration +with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration pipelines at low cost. Possible values: ["BASIC", "ENTERPRISE", "DEVELOPER"] - `version` (`string`): Current version of the Data Fusion. When `null`, the `version` field will be omitted from the resulting object. - `zone` (`string`): Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. When `null`, the `zone` field will be omitted from the resulting object. - `accelerators` (`list[obj]`): List of accelerators enabled for this CDF instance. -If accelerators are enabled it is possible a permadiff will be created with the Options field. +If accelerators are enabled it is possible a permadiff will be created with the Options field. Users will need to either manually update their state file to include these diffed options, or include the field in a [lifecycle ignore changes block](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes). When `null`, the `accelerators` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_fusion_instance.accelerators.new](#fn-acceleratorsnew) constructor. - `crypto_key_config` (`list[obj]`): The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. When `null`, the `crypto_key_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-beta.google_data_fusion_instance.crypto_key_config.new](#fn-crypto_key_confignew) constructor. - `event_publish_config` (`list[obj]`): Option to enable and pass metadata for event publishing. When `null`, the `event_publish_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-beta.google_data_fusion_instance.event_publish_config.new](#fn-event_publish_confignew) constructor. @@ -161,13 +161,13 @@ of concurrent pipelines, no support for streaming pipelines, etc. - ENTERPRISE: Enterprise Data Fusion instance. In Enterprise type, the user will have more features available, such as support for streaming pipelines, higher number of concurrent pipelines, etc. - DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but -with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration +with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration pipelines at low cost. Possible values: ["BASIC", "ENTERPRISE", "DEVELOPER"] - `version` (`string`): Current version of the Data Fusion. When `null`, the `version` field will be omitted from the resulting object. - `zone` (`string`): Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. When `null`, the `zone` field will be omitted from the resulting object. - `accelerators` (`list[obj]`): List of accelerators enabled for this CDF instance. -If accelerators are enabled it is possible a permadiff will be created with the Options field. +If accelerators are enabled it is possible a permadiff will be created with the Options field. Users will need to either manually update their state file to include these diffed options, or include the field in a [lifecycle ignore changes block](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes). When `null`, the `accelerators` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_fusion_instance.accelerators.new](#fn-acceleratorsnew) constructor. - `crypto_key_config` (`list[obj]`): The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. When `null`, the `crypto_key_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-beta.google_data_fusion_instance.crypto_key_config.new](#fn-crypto_key_confignew) constructor. - `event_publish_config` (`list[obj]`): Option to enable and pass metadata for event publishing. When `null`, the `event_publish_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-beta.google_data_fusion_instance.event_publish_config.new](#fn-event_publish_confignew) constructor. diff --git a/docs/4.x/google_data_loss_prevention_deidentify_template.md b/docs/4.x/google_data_loss_prevention_deidentify_template.md index cb4c1a82..56d92503 100644 --- a/docs/4.x/google_data_loss_prevention_deidentify_template.md +++ b/docs/4.x/google_data_loss_prevention_deidentify_template.md @@ -24,6 +24,20 @@ This package contains functions and utilities for setting up the resource using * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj deidentify_config`](#obj-deidentify_config) * [`fn new()`](#fn-deidentify_confignew) + * [`obj deidentify_config.image_transformations`](#obj-deidentify_configimage_transformations) + * [`fn new()`](#fn-deidentify_configimage_transformationsnew) + * [`obj deidentify_config.image_transformations.transforms`](#obj-deidentify_configimage_transformationstransforms) + * [`fn new()`](#fn-deidentify_configimage_transformationstransformsnew) + * [`obj deidentify_config.image_transformations.transforms.all_info_types`](#obj-deidentify_configimage_transformationstransformsall_info_types) + * [`fn new()`](#fn-deidentify_configimage_transformationstransformsall_info_typesnew) + * [`obj deidentify_config.image_transformations.transforms.all_text`](#obj-deidentify_configimage_transformationstransformsall_text) + * [`fn new()`](#fn-deidentify_configimage_transformationstransformsall_textnew) + * [`obj deidentify_config.image_transformations.transforms.redaction_color`](#obj-deidentify_configimage_transformationstransformsredaction_color) + * [`fn new()`](#fn-deidentify_configimage_transformationstransformsredaction_colornew) + * [`obj deidentify_config.image_transformations.transforms.selected_info_types`](#obj-deidentify_configimage_transformationstransformsselected_info_types) + * [`fn new()`](#fn-deidentify_configimage_transformationstransformsselected_info_typesnew) + * [`obj deidentify_config.image_transformations.transforms.selected_info_types.info_types`](#obj-deidentify_configimage_transformationstransformsselected_info_typesinfo_types) + * [`fn new()`](#fn-deidentify_configimage_transformationstransformsselected_info_typesinfo_typesnew) * [`obj deidentify_config.info_type_transformations`](#obj-deidentify_configinfo_type_transformations) * [`fn new()`](#fn-deidentify_configinfo_type_transformationsnew) * [`obj deidentify_config.info_type_transformations.transformations`](#obj-deidentify_configinfo_type_transformationstransformations) @@ -72,6 +86,10 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationreplace_confignew_valuedate_valuenew) * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_config.new_value.time_value`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationreplace_confignew_valuetime_value) * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationreplace_confignew_valuetime_valuenew) + * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationreplace_dictionary_config) + * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationreplace_dictionary_confignew) + * [`obj deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.word_list`](#obj-deidentify_configinfo_type_transformationstransformationsprimitive_transformationreplace_dictionary_configword_list) + * [`fn new()`](#fn-deidentify_configinfo_type_transformationstransformationsprimitive_transformationreplace_dictionary_configword_listnew) * [`obj deidentify_config.record_transformations`](#obj-deidentify_configrecord_transformations) * [`fn new()`](#fn-deidentify_configrecord_transformationsnew) * [`obj deidentify_config.record_transformations.field_transformations`](#obj-deidentify_configrecord_transformationsfield_transformations) @@ -438,6 +456,7 @@ Terraform sub block. **Args**: + - `image_transformations` (`list[obj]`): Treat the dataset as an image and redact. When `null`, the `image_transformations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.new](#fn-deidentify_configimage_transformationsnew) constructor. - `info_type_transformations` (`list[obj]`): Treat the dataset as free-form text and apply the same free text transformation everywhere When `null`, the `info_type_transformations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.new](#fn-deidentify_configinfo_type_transformationsnew) constructor. - `record_transformations` (`list[obj]`): Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table. When `null`, the `record_transformations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.record_transformations.new](#fn-deidentify_configrecord_transformationsnew) constructor. @@ -445,6 +464,168 @@ Terraform sub block. - An attribute object that represents the `deidentify_config` sub block. +## obj deidentify_config.image_transformations + + + +### fn deidentify_config.image_transformations.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.new` constructs a new object with attributes and blocks configured for the `image_transformations` +Terraform sub block. + + + +**Args**: + - `transforms` (`list[obj]`): For determination of how redaction of images should occur. When `null`, the `transforms` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.new](#fn-deidentify_configdeidentify_configtransformsnew) constructor. + +**Returns**: + - An attribute object that represents the `image_transformations` sub block. + + +## obj deidentify_config.image_transformations.transforms + + + +### fn deidentify_config.image_transformations.transforms.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.new` constructs a new object with attributes and blocks configured for the `transforms` +Terraform sub block. + + + +**Args**: + - `all_info_types` (`list[obj]`): Apply transformation to all findings not specified in other ImageTransformation's selectedInfoTypes. When `null`, the `all_info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.all_info_types.new](#fn-deidentify_configdeidentify_configimage_transformationsall_info_typesnew) constructor. + - `all_text` (`list[obj]`): Apply transformation to all text that doesn't match an infoType. When `null`, the `all_text` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.all_text.new](#fn-deidentify_configdeidentify_configimage_transformationsall_textnew) constructor. + - `redaction_color` (`list[obj]`): The color to use when redacting content from an image. If not specified, the default is black. When `null`, the `redaction_color` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.redaction_color.new](#fn-deidentify_configdeidentify_configimage_transformationsredaction_colornew) constructor. + - `selected_info_types` (`list[obj]`): Apply transformation to the selected infoTypes. When `null`, the `selected_info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.new](#fn-deidentify_configdeidentify_configimage_transformationsselected_info_typesnew) constructor. + +**Returns**: + - An attribute object that represents the `transforms` sub block. + + +## obj deidentify_config.image_transformations.transforms.all_info_types + + + +### fn deidentify_config.image_transformations.transforms.all_info_types.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.all_info_types.new` constructs a new object with attributes and blocks configured for the `all_info_types` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `all_info_types` sub block. + + +## obj deidentify_config.image_transformations.transforms.all_text + + + +### fn deidentify_config.image_transformations.transforms.all_text.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.all_text.new` constructs a new object with attributes and blocks configured for the `all_text` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `all_text` sub block. + + +## obj deidentify_config.image_transformations.transforms.redaction_color + + + +### fn deidentify_config.image_transformations.transforms.redaction_color.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.redaction_color.new` constructs a new object with attributes and blocks configured for the `redaction_color` +Terraform sub block. + + + +**Args**: + - `blue` (`number`): The amount of blue in the color as a value in the interval [0, 1]. When `null`, the `blue` field will be omitted from the resulting object. + - `green` (`number`): The amount of green in the color as a value in the interval [0, 1]. When `null`, the `green` field will be omitted from the resulting object. + - `red` (`number`): The amount of red in the color as a value in the interval [0, 1]. When `null`, the `red` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `redaction_color` sub block. + + +## obj deidentify_config.image_transformations.transforms.selected_info_types + + + +### fn deidentify_config.image_transformations.transforms.selected_info_types.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.new` constructs a new object with attributes and blocks configured for the `selected_info_types` +Terraform sub block. + + + +**Args**: + - `info_types` (`list[obj]`): InfoTypes to apply the transformation to. Leaving this empty will apply the transformation to apply to +all findings that correspond to infoTypes that were requested in InspectConfig. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.info_types.new](#fn-deidentify_configdeidentify_configimage_transformationstransformsinfo_typesnew) constructor. + +**Returns**: + - An attribute object that represents the `selected_info_types` sub block. + + +## obj deidentify_config.image_transformations.transforms.selected_info_types.info_types + + + +### fn deidentify_config.image_transformations.transforms.selected_info_types.info_types.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.image_transformations.transforms.selected_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types` +Terraform sub block. + + + +**Args**: + - `name` (`string`): Name of the information type. + - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `info_types` sub block. + + ## obj deidentify_config.info_type_transformations @@ -512,6 +693,7 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. + - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `info_types` sub block. @@ -542,6 +724,7 @@ Masking can start from the beginning or end of the string. When `null`, the `cha Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. When `null`, the `crypto_replace_ffx_fpe_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.crypto_replace_ffx_fpe_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationscrypto_replace_ffx_fpe_confignew) constructor. - `replace_config` (`list[obj]`): Replace each input value with a given value. When `null`, the `replace_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsreplace_confignew) constructor. + - `replace_dictionary_config` (`list[obj]`): Replace with a value randomly drawn (with replacement) from a dictionary. When `null`, the `replace_dictionary_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-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsreplace_dictionary_confignew) constructor. **Returns**: - An attribute object that represents the `primitive_transformation` sub block. @@ -1102,6 +1285,52 @@ Terraform sub block. - An attribute object that represents the `time_value` sub block. +## obj deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config + + + +### fn deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.new` constructs a new object with attributes and blocks configured for the `replace_dictionary_config` +Terraform sub block. + + + +**Args**: + - `word_list` (`list[obj]`): A list of words to select from for random replacement. The [limits](https://cloud.google.com/dlp/limits) page contains details about the size limits of dictionaries. When `null`, the `word_list` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.word_list.new](#fn-deidentify_configdeidentify_configinfo_type_transformationstransformationsprimitive_transformationword_listnew) constructor. + +**Returns**: + - An attribute object that represents the `replace_dictionary_config` sub block. + + +## obj deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.word_list + + + +### fn deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.word_list.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_deidentify_template.deidentify_config.info_type_transformations.transformations.primitive_transformation.replace_dictionary_config.word_list.new` constructs a new object with attributes and blocks configured for the `word_list` +Terraform sub block. + + + +**Args**: + - `words` (`list`): Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. + +**Returns**: + - An attribute object that represents the `word_list` sub block. + + ## obj deidentify_config.record_transformations diff --git a/docs/4.x/google_data_loss_prevention_inspect_template.md b/docs/4.x/google_data_loss_prevention_inspect_template.md index 686e87f4..b5061453 100644 --- a/docs/4.x/google_data_loss_prevention_inspect_template.md +++ b/docs/4.x/google_data_loss_prevention_inspect_template.md @@ -38,6 +38,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-inspect_configcustom_info_typesregexnew) * [`obj inspect_config.custom_info_types.stored_type`](#obj-inspect_configcustom_info_typesstored_type) * [`fn new()`](#fn-inspect_configcustom_info_typesstored_typenew) + * [`obj inspect_config.custom_info_types.surrogate_type`](#obj-inspect_configcustom_info_typessurrogate_type) + * [`fn new()`](#fn-inspect_configcustom_info_typessurrogate_typenew) * [`obj inspect_config.info_types`](#obj-inspect_configinfo_types) * [`fn new()`](#fn-inspect_configinfo_typesnew) * [`obj inspect_config.limits`](#obj-inspect_configlimits) @@ -60,6 +62,12 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-inspect_configrule_setrulesexclusion_ruledictionarycloud_storage_pathnew) * [`obj inspect_config.rule_set.rules.exclusion_rule.dictionary.word_list`](#obj-inspect_configrule_setrulesexclusion_ruledictionaryword_list) * [`fn new()`](#fn-inspect_configrule_setrulesexclusion_ruledictionaryword_listnew) + * [`obj inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword`](#obj-inspect_configrule_setrulesexclusion_ruleexclude_by_hotword) + * [`fn new()`](#fn-inspect_configrule_setrulesexclusion_ruleexclude_by_hotwordnew) + * [`obj inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex`](#obj-inspect_configrule_setrulesexclusion_ruleexclude_by_hotwordhotword_regex) + * [`fn new()`](#fn-inspect_configrule_setrulesexclusion_ruleexclude_by_hotwordhotword_regexnew) + * [`obj inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity`](#obj-inspect_configrule_setrulesexclusion_ruleexclude_by_hotwordproximity) + * [`fn new()`](#fn-inspect_configrule_setrulesexclusion_ruleexclude_by_hotwordproximitynew) * [`obj inspect_config.rule_set.rules.exclusion_rule.exclude_info_types`](#obj-inspect_configrule_setrulesexclusion_ruleexclude_info_types) * [`fn new()`](#fn-inspect_configrule_setrulesexclusion_ruleexclude_info_typesnew) * [`obj inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types`](#obj-inspect_configrule_setrulesexclusion_ruleexclude_info_typesinfo_types) @@ -337,6 +345,7 @@ one detected by the system. If built-in info type is not specified in 'info_ treated as a custom info type. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.info_type.new](#fn-inspect_configinspect_configinfo_typenew) constructor. - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.regex.new](#fn-inspect_configinspect_configregexnew) constructor. - `stored_type` (`list[obj]`): A reference to a StoredInfoType to use with scanning. When `null`, the `stored_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.stored_type.new](#fn-inspect_configinspect_configstored_typenew) constructor. + - `surrogate_type` (`list[obj]`): Message for detecting output from deidentification transformations that support reversing. When `null`, the `surrogate_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.surrogate_type.new](#fn-inspect_configinspect_configsurrogate_typenew) constructor. **Returns**: - An attribute object that represents the `custom_info_types` sub block. @@ -432,6 +441,7 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. + - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `info_type` sub block. @@ -486,6 +496,26 @@ or 'projects/project-id/storedInfoTypes/432452342'. - An attribute object that represents the `stored_type` sub block. +## obj inspect_config.custom_info_types.surrogate_type + + + +### fn inspect_config.custom_info_types.surrogate_type.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_inspect_template.inspect_config.custom_info_types.surrogate_type.new` constructs a new object with attributes and blocks configured for the `surrogate_type` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `surrogate_type` sub block. + + ## obj inspect_config.info_types @@ -581,6 +611,7 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. + - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `info_type` sub block. @@ -629,6 +660,7 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. + - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `info_types` sub block. @@ -677,6 +709,8 @@ Terraform sub block. **Args**: - `matching_type` (`string`): How the rule is applied. See the documentation for more information: https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#MatchingType Possible values: ["MATCHING_TYPE_FULL_MATCH", "MATCHING_TYPE_PARTIAL_MATCH", "MATCHING_TYPE_INVERSE_MATCH"] - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.dictionary.new](#fn-inspect_configinspect_configrule_setrulesdictionarynew) constructor. + - `exclude_by_hotword` (`list[obj]`): Drop if the hotword rule is contained in the proximate context. +For tabular data, the context includes the column name. When `null`, the `exclude_by_hotword` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.new](#fn-inspect_configinspect_configrule_setrulesexclude_by_hotwordnew) constructor. - `exclude_info_types` (`list[obj]`): Set of infoTypes for which findings would affect this rule. When `null`, the `exclude_info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.new](#fn-inspect_configinspect_configrule_setrulesexclude_info_typesnew) constructor. - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.regex.new](#fn-inspect_configinspect_configrule_setrulesregexnew) constructor. @@ -755,6 +789,84 @@ phrase and every phrase must contain at least 2 characters that are letters or d - An attribute object that represents the `word_list` sub block. +## obj inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword + + + +### fn inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.new` constructs a new object with attributes and blocks configured for the `exclude_by_hotword` +Terraform sub block. + + + +**Args**: + - `hotword_regex` (`list[obj]`): Regular expression pattern defining what qualifies as a hotword. When `null`, the `hotword_regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex.new](#fn-inspect_configinspect_configrule_setrulesexclusion_rulehotword_regexnew) constructor. + - `proximity` (`list[obj]`): Proximity of the finding within which the entire hotword must reside. The total length of the window cannot +exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be +used to match substrings of the finding itself. For example, the certainty of a phone number regex +'(\d{3}) \d{3}-\d{4}' could be adjusted upwards if the area code is known to be the local area code of a company +office using the hotword regex '(xxx)', where 'xxx' is the area code in question. When `null`, the `proximity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity.new](#fn-inspect_configinspect_configrule_setrulesexclusion_ruleproximitynew) constructor. + +**Returns**: + - An attribute object that represents the `exclude_by_hotword` sub block. + + +## obj inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex + + + +### fn inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex.new` constructs a new object with attributes and blocks configured for the `hotword_regex` +Terraform sub block. + + + +**Args**: + - `group_indexes` (`list`): The index of the submatch to extract as findings. When not specified, +the entire match is returned. No more than 3 may be included. When `null`, the `group_indexes` field will be omitted from the resulting object. + - `pattern` (`string`): Pattern defining the regular expression. Its syntax +(https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. + +**Returns**: + - An attribute object that represents the `hotword_regex` sub block. + + +## obj inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity + + + +### fn inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_inspect_template.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity.new` constructs a new object with attributes and blocks configured for the `proximity` +Terraform sub block. + + + +**Args**: + - `window_after` (`number`): Number of characters after the finding to consider. When `null`, the `window_after` field will be omitted from the resulting object. + - `window_before` (`number`): Number of characters before the finding to consider. When `null`, the `window_before` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `proximity` sub block. + + ## obj inspect_config.rule_set.rules.exclusion_rule.exclude_info_types @@ -797,6 +909,7 @@ Terraform sub block. **Args**: - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. + - `version` (`string`): Version name for this InfoType. When `null`, the `version` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `info_types` sub block. diff --git a/docs/4.x/google_data_loss_prevention_job_trigger.md b/docs/4.x/google_data_loss_prevention_job_trigger.md index 151fdee8..40e8a72a 100644 --- a/docs/4.x/google_data_loss_prevention_job_trigger.md +++ b/docs/4.x/google_data_loss_prevention_job_trigger.md @@ -51,6 +51,66 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-inspect_jobactionssave_findingsoutput_confignew) * [`obj inspect_job.actions.save_findings.output_config.table`](#obj-inspect_jobactionssave_findingsoutput_configtable) * [`fn new()`](#fn-inspect_jobactionssave_findingsoutput_configtablenew) + * [`obj inspect_job.inspect_config`](#obj-inspect_jobinspect_config) + * [`fn new()`](#fn-inspect_jobinspect_confignew) + * [`obj inspect_job.inspect_config.custom_info_types`](#obj-inspect_jobinspect_configcustom_info_types) + * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesnew) + * [`obj inspect_job.inspect_config.custom_info_types.dictionary`](#obj-inspect_jobinspect_configcustom_info_typesdictionary) + * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesdictionarynew) + * [`obj inspect_job.inspect_config.custom_info_types.dictionary.cloud_storage_path`](#obj-inspect_jobinspect_configcustom_info_typesdictionarycloud_storage_path) + * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesdictionarycloud_storage_pathnew) + * [`obj inspect_job.inspect_config.custom_info_types.dictionary.word_list`](#obj-inspect_jobinspect_configcustom_info_typesdictionaryword_list) + * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesdictionaryword_listnew) + * [`obj inspect_job.inspect_config.custom_info_types.info_type`](#obj-inspect_jobinspect_configcustom_info_typesinfo_type) + * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesinfo_typenew) + * [`obj inspect_job.inspect_config.custom_info_types.regex`](#obj-inspect_jobinspect_configcustom_info_typesregex) + * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesregexnew) + * [`obj inspect_job.inspect_config.custom_info_types.stored_type`](#obj-inspect_jobinspect_configcustom_info_typesstored_type) + * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typesstored_typenew) + * [`obj inspect_job.inspect_config.custom_info_types.surrogate_type`](#obj-inspect_jobinspect_configcustom_info_typessurrogate_type) + * [`fn new()`](#fn-inspect_jobinspect_configcustom_info_typessurrogate_typenew) + * [`obj inspect_job.inspect_config.info_types`](#obj-inspect_jobinspect_configinfo_types) + * [`fn new()`](#fn-inspect_jobinspect_configinfo_typesnew) + * [`obj inspect_job.inspect_config.limits`](#obj-inspect_jobinspect_configlimits) + * [`fn new()`](#fn-inspect_jobinspect_configlimitsnew) + * [`obj inspect_job.inspect_config.limits.max_findings_per_info_type`](#obj-inspect_jobinspect_configlimitsmax_findings_per_info_type) + * [`fn new()`](#fn-inspect_jobinspect_configlimitsmax_findings_per_info_typenew) + * [`obj inspect_job.inspect_config.limits.max_findings_per_info_type.info_type`](#obj-inspect_jobinspect_configlimitsmax_findings_per_info_typeinfo_type) + * [`fn new()`](#fn-inspect_jobinspect_configlimitsmax_findings_per_info_typeinfo_typenew) + * [`obj inspect_job.inspect_config.rule_set`](#obj-inspect_jobinspect_configrule_set) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setnew) + * [`obj inspect_job.inspect_config.rule_set.info_types`](#obj-inspect_jobinspect_configrule_setinfo_types) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setinfo_typesnew) + * [`obj inspect_job.inspect_config.rule_set.rules`](#obj-inspect_jobinspect_configrule_setrules) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesnew) + * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule`](#obj-inspect_jobinspect_configrule_setrulesexclusion_rule) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_rulenew) + * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruledictionary) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruledictionarynew) + * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.cloud_storage_path`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruledictionarycloud_storage_path) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruledictionarycloud_storage_pathnew) + * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.word_list`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruledictionaryword_list) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruledictionaryword_listnew) + * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_by_hotword) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_by_hotwordnew) + * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_by_hotwordhotword_regex) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_by_hotwordhotword_regexnew) + * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_by_hotwordproximity) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_by_hotwordproximitynew) + * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_info_types) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_info_typesnew) + * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_info_typesinfo_types) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruleexclude_info_typesinfo_typesnew) + * [`obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.regex`](#obj-inspect_jobinspect_configrule_setrulesexclusion_ruleregex) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setrulesexclusion_ruleregexnew) + * [`obj inspect_job.inspect_config.rule_set.rules.hotword_rule`](#obj-inspect_jobinspect_configrule_setruleshotword_rule) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setruleshotword_rulenew) + * [`obj inspect_job.inspect_config.rule_set.rules.hotword_rule.hotword_regex`](#obj-inspect_jobinspect_configrule_setruleshotword_rulehotword_regex) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setruleshotword_rulehotword_regexnew) + * [`obj inspect_job.inspect_config.rule_set.rules.hotword_rule.likelihood_adjustment`](#obj-inspect_jobinspect_configrule_setruleshotword_rulelikelihood_adjustment) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setruleshotword_rulelikelihood_adjustmentnew) + * [`obj inspect_job.inspect_config.rule_set.rules.hotword_rule.proximity`](#obj-inspect_jobinspect_configrule_setruleshotword_ruleproximity) + * [`fn new()`](#fn-inspect_jobinspect_configrule_setruleshotword_ruleproximitynew) * [`obj inspect_job.storage_config`](#obj-inspect_jobstorage_config) * [`fn new()`](#fn-inspect_jobstorage_confignew) * [`obj inspect_job.storage_config.big_query_options`](#obj-inspect_jobstorage_configbig_query_options) @@ -356,6 +416,7 @@ Terraform sub block. **Args**: - `inspect_template_name` (`string`): The name of the template to run when this job is triggered. - `actions` (`list[obj]`): A task to execute on the completion of a job. When `null`, the `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-beta.google_data_loss_prevention_job_trigger.inspect_job.actions.new](#fn-inspect_jobactionsnew) constructor. + - `inspect_config` (`list[obj]`): The core content of the template. When `null`, the `inspect_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-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.new](#fn-inspect_jobinspect_confignew) constructor. - `storage_config` (`list[obj]`): Information on where to inspect When `null`, the `storage_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.storage_config.new](#fn-inspect_jobstorage_confignew) constructor. **Returns**: @@ -418,7 +479,7 @@ De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket - `file_types_to_transform` (`list`): List of user-specified file type groups to transform. If specified, only the files with these filetypes will be transformed. -If empty, all supported files will be transformed. Supported types may be automatically added over time. +If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Possible values: ["IMAGE", "TEXT_FILE", "CSV", "TSV"] When `null`, the `file_types_to_transform` field will be omitted from the resulting object. - `transformation_config` (`list[obj]`): User specified deidentify templates and configs for structured, unstructured, and image files. When `null`, the `transformation_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.actions.deidentify.transformation_config.new](#fn-inspect_jobinspect_jobactionstransformation_confignew) constructor. @@ -666,6 +727,769 @@ Terraform sub block. - An attribute object that represents the `table` sub block. +## obj inspect_job.inspect_config + + + +### fn inspect_job.inspect_config.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.new` constructs a new object with attributes and blocks configured for the `inspect_config` +Terraform sub block. + + + +**Args**: + - `exclude_info_types` (`bool`): When true, excludes type information of the findings. When `null`, the `exclude_info_types` field will be omitted from the resulting object. + - `include_quote` (`bool`): When true, a contextual quote from the data that triggered a finding is included in the response. When `null`, the `include_quote` field will be omitted from the resulting object. + - `min_likelihood` (`string`): Only returns findings equal or above this threshold. See https://cloud.google.com/dlp/docs/likelihood for more info Default value: "POSSIBLE" Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `min_likelihood` field will be omitted from the resulting object. + - `custom_info_types` (`list[obj]`): Custom info types to be used. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more. When `null`, the `custom_info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.new](#fn-inspect_jobinspect_jobcustom_info_typesnew) constructor. + - `info_types` (`list[obj]`): Restricts what infoTypes to look for. The values must correspond to InfoType values returned by infoTypes.list +or listed at https://cloud.google.com/dlp/docs/infotypes-reference. + +When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. +By default this may be all types, but may change over time as detectors are updated. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.info_types.new](#fn-inspect_jobinspect_jobinfo_typesnew) constructor. + - `limits` (`list[obj]`): Configuration to control the number of findings returned. When `null`, the `limits` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.new](#fn-inspect_jobinspect_joblimitsnew) constructor. + - `rule_set` (`list[obj]`): Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, +other rules are executed in the order they are specified for each info type. When `null`, the `rule_set` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.new](#fn-inspect_jobinspect_jobrule_setnew) constructor. + +**Returns**: + - An attribute object that represents the `inspect_config` sub block. + + +## obj inspect_job.inspect_config.custom_info_types + + + +### fn inspect_job.inspect_config.custom_info_types.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.new` constructs a new object with attributes and blocks configured for the `custom_info_types` +Terraform sub block. + + + +**Args**: + - `exclusion_type` (`string`): If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Possible values: ["EXCLUSION_TYPE_EXCLUDE"] When `null`, the `exclusion_type` field will be omitted from the resulting object. + - `likelihood` (`string`): Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria +specified by the rule. Default value: "VERY_LIKELY" Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `likelihood` field will be omitted from the resulting object. + - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.new](#fn-inspect_jobinspect_jobinspect_configdictionarynew) constructor. + - `info_type` (`list[obj]`): CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing +infoTypes and that infoType is specified in 'info_types' field. Specifying the latter adds findings to the +one detected by the system. If built-in info type is not specified in 'info_types' list then the name is +treated as a custom info type. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.new](#fn-inspect_jobinspect_jobinspect_configinfo_typenew) constructor. + - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.regex.new](#fn-inspect_jobinspect_jobinspect_configregexnew) constructor. + - `stored_type` (`list[obj]`): A reference to a StoredInfoType to use with scanning. When `null`, the `stored_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.stored_type.new](#fn-inspect_jobinspect_jobinspect_configstored_typenew) constructor. + - `surrogate_type` (`list[obj]`): Message for detecting output from deidentification transformations that support reversing. When `null`, the `surrogate_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.surrogate_type.new](#fn-inspect_jobinspect_jobinspect_configsurrogate_typenew) constructor. + +**Returns**: + - An attribute object that represents the `custom_info_types` sub block. + + +## obj inspect_job.inspect_config.custom_info_types.dictionary + + + +### fn inspect_job.inspect_config.custom_info_types.dictionary.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.new` constructs a new object with attributes and blocks configured for the `dictionary` +Terraform sub block. + + + +**Args**: + - `cloud_storage_path` (`list[obj]`): Newline-delimited file of words in Cloud Storage. Only a single file is accepted. When `null`, the `cloud_storage_path` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.cloud_storage_path.new](#fn-inspect_jobinspect_jobinspect_configcustom_info_typescloud_storage_pathnew) constructor. + - `word_list` (`list[obj]`): List of words or phrases to search for. When `null`, the `word_list` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.word_list.new](#fn-inspect_jobinspect_jobinspect_configcustom_info_typesword_listnew) constructor. + +**Returns**: + - An attribute object that represents the `dictionary` sub block. + + +## obj inspect_job.inspect_config.custom_info_types.dictionary.cloud_storage_path + + + +### fn inspect_job.inspect_config.custom_info_types.dictionary.cloud_storage_path.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.cloud_storage_path.new` constructs a new object with attributes and blocks configured for the `cloud_storage_path` +Terraform sub block. + + + +**Args**: + - `path` (`string`): A url representing a file or path (no wildcards) in Cloud Storage. Example: 'gs://[BUCKET_NAME]/dictionary.txt' + +**Returns**: + - An attribute object that represents the `cloud_storage_path` sub block. + + +## obj inspect_job.inspect_config.custom_info_types.dictionary.word_list + + + +### fn inspect_job.inspect_config.custom_info_types.dictionary.word_list.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.dictionary.word_list.new` constructs a new object with attributes and blocks configured for the `word_list` +Terraform sub block. + + + +**Args**: + - `words` (`list`): Words or phrases defining the dictionary. The dictionary must contain at least one +phrase and every phrase must contain at least 2 characters that are letters or digits. + +**Returns**: + - An attribute object that represents the `word_list` sub block. + + +## obj inspect_job.inspect_config.custom_info_types.info_type + + + +### fn inspect_job.inspect_config.custom_info_types.info_type.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.info_type.new` constructs a new object with attributes and blocks configured for the `info_type` +Terraform sub block. + + + +**Args**: + - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names +listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. + - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `info_type` sub block. + + +## obj inspect_job.inspect_config.custom_info_types.regex + + + +### fn inspect_job.inspect_config.custom_info_types.regex.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.regex.new` constructs a new object with attributes and blocks configured for the `regex` +Terraform sub block. + + + +**Args**: + - `group_indexes` (`list`): The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. When `null`, the `group_indexes` field will be omitted from the resulting object. + - `pattern` (`string`): Pattern defining the regular expression. +Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. + +**Returns**: + - An attribute object that represents the `regex` sub block. + + +## obj inspect_job.inspect_config.custom_info_types.stored_type + + + +### fn inspect_job.inspect_config.custom_info_types.stored_type.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.stored_type.new` constructs a new object with attributes and blocks configured for the `stored_type` +Terraform sub block. + + + +**Args**: + - `name` (`string`): Resource name of the requested StoredInfoType, for example 'organizations/433245324/storedInfoTypes/432452342' +or 'projects/project-id/storedInfoTypes/432452342'. + +**Returns**: + - An attribute object that represents the `stored_type` sub block. + + +## obj inspect_job.inspect_config.custom_info_types.surrogate_type + + + +### fn inspect_job.inspect_config.custom_info_types.surrogate_type.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.custom_info_types.surrogate_type.new` constructs a new object with attributes and blocks configured for the `surrogate_type` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `surrogate_type` sub block. + + +## obj inspect_job.inspect_config.info_types + + + +### fn inspect_job.inspect_config.info_types.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.info_types.new` constructs a new object with attributes and blocks configured for the `info_types` +Terraform sub block. + + + +**Args**: + - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed +at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. + - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `info_types` sub block. + + +## obj inspect_job.inspect_config.limits + + + +### fn inspect_job.inspect_config.limits.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.new` constructs a new object with attributes and blocks configured for the `limits` +Terraform sub block. + + + +**Args**: + - `max_findings_per_item` (`number`): Max number of findings that will be returned for each item scanned. The maximum returned is 2000. When `null`, the `max_findings_per_item` field will be omitted from the resulting object. + - `max_findings_per_request` (`number`): Max number of findings that will be returned per request/job. The maximum returned is 2000. When `null`, the `max_findings_per_request` field will be omitted from the resulting object. + - `max_findings_per_info_type` (`list[obj]`): Configuration of findings limit given for specified infoTypes. When `null`, the `max_findings_per_info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.new](#fn-inspect_jobinspect_jobinspect_configmax_findings_per_info_typenew) constructor. + +**Returns**: + - An attribute object that represents the `limits` sub block. + + +## obj inspect_job.inspect_config.limits.max_findings_per_info_type + + + +### fn inspect_job.inspect_config.limits.max_findings_per_info_type.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.new` constructs a new object with attributes and blocks configured for the `max_findings_per_info_type` +Terraform sub block. + + + +**Args**: + - `max_findings` (`number`): Max findings limit for the given infoType. When `null`, the `max_findings` field will be omitted from the resulting object. + - `info_type` (`list[obj]`): Type of information the findings limit applies to. Only one limit per infoType should be provided. If InfoTypeLimit does +not have an infoType, the DLP API applies the limit against all infoTypes that are found but not +specified in another InfoTypeLimit. When `null`, the `info_type` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.new](#fn-inspect_jobinspect_jobinspect_configlimitsinfo_typenew) constructor. + +**Returns**: + - An attribute object that represents the `max_findings_per_info_type` sub block. + + +## obj inspect_job.inspect_config.limits.max_findings_per_info_type.info_type + + + +### fn inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.limits.max_findings_per_info_type.info_type.new` constructs a new object with attributes and blocks configured for the `info_type` +Terraform sub block. + + + +**Args**: + - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed +at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. + - `version` (`string`): Version of the information type to use. By default, the version is set to stable When `null`, the `version` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `info_type` sub block. + + +## obj inspect_job.inspect_config.rule_set + + + +### fn inspect_job.inspect_config.rule_set.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.new` constructs a new object with attributes and blocks configured for the `rule_set` +Terraform sub block. + + + +**Args**: + - `info_types` (`list[obj]`): List of infoTypes this rule set is applied to. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.info_types.new](#fn-inspect_jobinspect_jobinspect_configinfo_typesnew) constructor. + - `rules` (`list[obj]`): Set of rules to be applied to infoTypes. The rules are applied in order. When `null`, the `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-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.new](#fn-inspect_jobinspect_jobinspect_configrulesnew) constructor. + +**Returns**: + - An attribute object that represents the `rule_set` sub block. + + +## obj inspect_job.inspect_config.rule_set.info_types + + + +### fn inspect_job.inspect_config.rule_set.info_types.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.info_types.new` constructs a new object with attributes and blocks configured for the `info_types` +Terraform sub block. + + + +**Args**: + - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed +at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. + - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `info_types` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules + + + +### fn inspect_job.inspect_config.rule_set.rules.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.new` constructs a new object with attributes and blocks configured for the `rules` +Terraform sub block. + + + +**Args**: + - `exclusion_rule` (`list[obj]`): The rule that specifies conditions when findings of infoTypes specified in InspectionRuleSet are removed from results. When `null`, the `exclusion_rule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.new](#fn-inspect_jobinspect_jobinspect_configrule_setexclusion_rulenew) constructor. + - `hotword_rule` (`list[obj]`): Hotword-based detection rule. When `null`, the `hotword_rule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.new](#fn-inspect_jobinspect_jobinspect_configrule_sethotword_rulenew) constructor. + +**Returns**: + - An attribute object that represents the `rules` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule + + + +### fn inspect_job.inspect_config.rule_set.rules.exclusion_rule.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.new` constructs a new object with attributes and blocks configured for the `exclusion_rule` +Terraform sub block. + + + +**Args**: + - `matching_type` (`string`): How the rule is applied. See the documentation for more information: https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#MatchingType Possible values: ["MATCHING_TYPE_FULL_MATCH", "MATCHING_TYPE_PARTIAL_MATCH", "MATCHING_TYPE_INVERSE_MATCH"] + - `dictionary` (`list[obj]`): Dictionary which defines the rule. When `null`, the `dictionary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesdictionarynew) constructor. + - `exclude_by_hotword` (`list[obj]`): Drop if the hotword rule is contained in the proximate context. When `null`, the `exclude_by_hotword` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclude_by_hotwordnew) constructor. + - `exclude_info_types` (`list[obj]`): Set of infoTypes for which findings would affect this rule. When `null`, the `exclude_info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclude_info_typesnew) constructor. + - `regex` (`list[obj]`): Regular expression which defines the rule. When `null`, the `regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.regex.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesregexnew) constructor. + +**Returns**: + - An attribute object that represents the `exclusion_rule` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary + + + +### fn inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.new` constructs a new object with attributes and blocks configured for the `dictionary` +Terraform sub block. + + + +**Args**: + - `cloud_storage_path` (`list[obj]`): Newline-delimited file of words in Cloud Storage. Only a single file is accepted. When `null`, the `cloud_storage_path` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.cloud_storage_path.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_rulecloud_storage_pathnew) constructor. + - `word_list` (`list[obj]`): List of words or phrases to search for. When `null`, the `word_list` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.word_list.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_ruleword_listnew) constructor. + +**Returns**: + - An attribute object that represents the `dictionary` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.cloud_storage_path + + + +### fn inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.cloud_storage_path.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.cloud_storage_path.new` constructs a new object with attributes and blocks configured for the `cloud_storage_path` +Terraform sub block. + + + +**Args**: + - `path` (`string`): A url representing a file or path (no wildcards) in Cloud Storage. Example: 'gs://[BUCKET_NAME]/dictionary.txt' + +**Returns**: + - An attribute object that represents the `cloud_storage_path` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.word_list + + + +### fn inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.word_list.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.dictionary.word_list.new` constructs a new object with attributes and blocks configured for the `word_list` +Terraform sub block. + + + +**Args**: + - `words` (`list`): Words or phrases defining the dictionary. The dictionary must contain at least one +phrase and every phrase must contain at least 2 characters that are letters or digits. + +**Returns**: + - An attribute object that represents the `word_list` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword + + + +### fn inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.new` constructs a new object with attributes and blocks configured for the `exclude_by_hotword` +Terraform sub block. + + + +**Args**: + - `hotword_regex` (`list[obj]`): Regular expression pattern defining what qualifies as a hotword. When `null`, the `hotword_regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_rulehotword_regexnew) constructor. + - `proximity` (`list[obj]`): Proximity of the finding within which the entire hotword must reside. The total length of the window cannot +exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be +used to match substrings of the finding itself. For example, the certainty of a phone number regex +'(\d{3}) \d{3}-\d{4}' could be adjusted upwards if the area code is known to be the local area code of a company +office using the hotword regex '(xxx)', where 'xxx' is the area code in question. When `null`, the `proximity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_ruleproximitynew) constructor. + +**Returns**: + - An attribute object that represents the `exclude_by_hotword` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex + + + +### fn inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.hotword_regex.new` constructs a new object with attributes and blocks configured for the `hotword_regex` +Terraform sub block. + + + +**Args**: + - `group_indexes` (`list`): The index of the submatch to extract as findings. When not specified, +the entire match is returned. No more than 3 may be included. When `null`, the `group_indexes` field will be omitted from the resulting object. + - `pattern` (`string`): Pattern defining the regular expression. Its syntax +(https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. When `null`, the `pattern` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `hotword_regex` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity + + + +### fn inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_by_hotword.proximity.new` constructs a new object with attributes and blocks configured for the `proximity` +Terraform sub block. + + + +**Args**: + - `window_after` (`number`): Number of characters after the finding to consider. Either this or window_before must be specified When `null`, the `window_after` field will be omitted from the resulting object. + - `window_before` (`number`): Number of characters before the finding to consider. Either this or window_after must be specified When `null`, the `window_before` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `proximity` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types + + + +### fn inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.new` constructs a new object with attributes and blocks configured for the `exclude_info_types` +Terraform sub block. + + + +**Args**: + - `info_types` (`list[obj]`): If a finding is matched by any of the infoType detectors listed here, the finding will be excluded from the scan results. When `null`, the `info_types` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesexclusion_ruleinfo_typesnew) constructor. + +**Returns**: + - An attribute object that represents the `exclude_info_types` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types + + + +### fn inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.exclude_info_types.info_types.new` constructs a new object with attributes and blocks configured for the `info_types` +Terraform sub block. + + + +**Args**: + - `name` (`string`): Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed +at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. + - `version` (`string`): Version of the information type to use. By default, the version is set to stable. When `null`, the `version` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `info_types` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.exclusion_rule.regex + + + +### fn inspect_job.inspect_config.rule_set.rules.exclusion_rule.regex.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.exclusion_rule.regex.new` constructs a new object with attributes and blocks configured for the `regex` +Terraform sub block. + + + +**Args**: + - `group_indexes` (`list`): The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. When `null`, the `group_indexes` field will be omitted from the resulting object. + - `pattern` (`string`): Pattern defining the regular expression. +Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. + +**Returns**: + - An attribute object that represents the `regex` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.hotword_rule + + + +### fn inspect_job.inspect_config.rule_set.rules.hotword_rule.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.new` constructs a new object with attributes and blocks configured for the `hotword_rule` +Terraform sub block. + + + +**Args**: + - `hotword_regex` (`list[obj]`): Regular expression pattern defining what qualifies as a hotword. When `null`, the `hotword_regex` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.hotword_regex.new](#fn-inspect_jobinspect_jobinspect_configrule_setruleshotword_regexnew) constructor. + - `likelihood_adjustment` (`list[obj]`): Likelihood adjustment to apply to all matching findings. When `null`, the `likelihood_adjustment` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.likelihood_adjustment.new](#fn-inspect_jobinspect_jobinspect_configrule_setruleslikelihood_adjustmentnew) constructor. + - `proximity` (`list[obj]`): Proximity of the finding within which the entire hotword must reside. The total length of the window cannot +exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be +used to match substrings of the finding itself. For example, the certainty of a phone number regex +'(\d{3}) \d{3}-\d{4}' could be adjusted upwards if the area code is known to be the local area code of a company +office using the hotword regex '(xxx)', where 'xxx' is the area code in question. When `null`, the `proximity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.proximity.new](#fn-inspect_jobinspect_jobinspect_configrule_setrulesproximitynew) constructor. + +**Returns**: + - An attribute object that represents the `hotword_rule` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.hotword_rule.hotword_regex + + + +### fn inspect_job.inspect_config.rule_set.rules.hotword_rule.hotword_regex.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.hotword_regex.new` constructs a new object with attributes and blocks configured for the `hotword_regex` +Terraform sub block. + + + +**Args**: + - `group_indexes` (`list`): The index of the submatch to extract as findings. When not specified, +the entire match is returned. No more than 3 may be included. When `null`, the `group_indexes` field will be omitted from the resulting object. + - `pattern` (`string`): Pattern defining the regular expression. Its syntax +(https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. When `null`, the `pattern` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `hotword_regex` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.hotword_rule.likelihood_adjustment + + + +### fn inspect_job.inspect_config.rule_set.rules.hotword_rule.likelihood_adjustment.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.likelihood_adjustment.new` constructs a new object with attributes and blocks configured for the `likelihood_adjustment` +Terraform sub block. + + + +**Args**: + - `fixed_likelihood` (`string`): Set the likelihood of a finding to a fixed value. Either this or relative_likelihood can be set. Possible values: ["VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"] When `null`, the `fixed_likelihood` field will be omitted from the resulting object. + - `relative_likelihood` (`number`): Increase or decrease the likelihood by the specified number of levels. For example, +if a finding would be POSSIBLE without the detection rule and relativeLikelihood is 1, +then it is upgraded to LIKELY, while a value of -1 would downgrade it to UNLIKELY. +Likelihood may never drop below VERY_UNLIKELY or exceed VERY_LIKELY, so applying an +adjustment of 1 followed by an adjustment of -1 when base likelihood is VERY_LIKELY +will result in a final likelihood of LIKELY. Either this or fixed_likelihood can be set. When `null`, the `relative_likelihood` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `likelihood_adjustment` sub block. + + +## obj inspect_job.inspect_config.rule_set.rules.hotword_rule.proximity + + + +### fn inspect_job.inspect_config.rule_set.rules.hotword_rule.proximity.new + +```ts +new() +``` + + +`google-beta.google_data_loss_prevention_job_trigger.inspect_job.inspect_config.rule_set.rules.hotword_rule.proximity.new` constructs a new object with attributes and blocks configured for the `proximity` +Terraform sub block. + + + +**Args**: + - `window_after` (`number`): Number of characters after the finding to consider. Either this or window_before must be specified When `null`, the `window_after` field will be omitted from the resulting object. + - `window_before` (`number`): Number of characters before the finding to consider. Either this or window_after must be specified When `null`, the `window_before` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `proximity` sub block. + + ## obj inspect_job.storage_config @@ -710,13 +1534,13 @@ Terraform sub block. **Args**: - - `rows_limit` (`number`): Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. -If not set, or if set to 0, all rows will be scanned. Only one of rowsLimit and rowsLimitPercent can be + - `rows_limit` (`number`): Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. +If not set, or if set to 0, all rows will be scanned. Only one of rowsLimit and rowsLimitPercent can be specified. Cannot be used in conjunction with TimespanConfig. When `null`, the `rows_limit` field will be omitted from the resulting object. - - `rows_limit_percent` (`number`): Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. -Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of + - `rows_limit_percent` (`number`): Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. +Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rowsLimit and rowsLimitPercent can be specified. Cannot be used in conjunction with TimespanConfig. When `null`, the `rows_limit_percent` field will be omitted from the resulting object. - - `sample_method` (`string`): How to sample rows if not all rows are scanned. Meaningful only when used in conjunction with either + - `sample_method` (`string`): How to sample rows if not all rows are scanned. Meaningful only when used in conjunction with either rowsLimit or rowsLimitPercent. If not specified, rows are scanned in the order BigQuery reads them. Default value: "TOP" Possible values: ["TOP", "RANDOM_START"] When `null`, the `sample_method` field will be omitted from the resulting object. - `identifying_fields` (`list[obj]`): Specifies the BigQuery fields that will be returned with findings. If not specified, no identifying fields will be returned for findings. When `null`, the `identifying_fields` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_data_loss_prevention_job_trigger.inspect_job.storage_config.big_query_options.identifying_fields.new](#fn-inspect_jobinspect_jobstorage_configidentifying_fieldsnew) constructor. diff --git a/docs/4.x/google_database_migration_service_connection_profile.md b/docs/4.x/google_database_migration_service_connection_profile.md new file mode 100644 index 00000000..29a50abc --- /dev/null +++ b/docs/4.x/google_database_migration_service_connection_profile.md @@ -0,0 +1,778 @@ +--- +permalink: /google_database_migration_service_connection_profile/ +--- + +# google_database_migration_service_connection_profile + +`google_database_migration_service_connection_profile` represents the `google-beta_google_database_migration_service_connection_profile` 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 withAlloydb()`](#fn-withalloydb) +* [`fn withAlloydbMixin()`](#fn-withalloydbmixin) +* [`fn withCloudsql()`](#fn-withcloudsql) +* [`fn withCloudsqlMixin()`](#fn-withcloudsqlmixin) +* [`fn withConnectionProfileId()`](#fn-withconnectionprofileid) +* [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withMysql()`](#fn-withmysql) +* [`fn withMysqlMixin()`](#fn-withmysqlmixin) +* [`fn withPostgresql()`](#fn-withpostgresql) +* [`fn withPostgresqlMixin()`](#fn-withpostgresqlmixin) +* [`fn withProject()`](#fn-withproject) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj alloydb`](#obj-alloydb) + * [`fn new()`](#fn-alloydbnew) + * [`obj alloydb.settings`](#obj-alloydbsettings) + * [`fn new()`](#fn-alloydbsettingsnew) + * [`obj alloydb.settings.initial_user`](#obj-alloydbsettingsinitial_user) + * [`fn new()`](#fn-alloydbsettingsinitial_usernew) + * [`obj alloydb.settings.primary_instance_settings`](#obj-alloydbsettingsprimary_instance_settings) + * [`fn new()`](#fn-alloydbsettingsprimary_instance_settingsnew) + * [`obj alloydb.settings.primary_instance_settings.machine_config`](#obj-alloydbsettingsprimary_instance_settingsmachine_config) + * [`fn new()`](#fn-alloydbsettingsprimary_instance_settingsmachine_confignew) +* [`obj cloudsql`](#obj-cloudsql) + * [`fn new()`](#fn-cloudsqlnew) + * [`obj cloudsql.settings`](#obj-cloudsqlsettings) + * [`fn new()`](#fn-cloudsqlsettingsnew) + * [`obj cloudsql.settings.ip_config`](#obj-cloudsqlsettingsip_config) + * [`fn new()`](#fn-cloudsqlsettingsip_confignew) + * [`obj cloudsql.settings.ip_config.authorized_networks`](#obj-cloudsqlsettingsip_configauthorized_networks) + * [`fn new()`](#fn-cloudsqlsettingsip_configauthorized_networksnew) +* [`obj mysql`](#obj-mysql) + * [`fn new()`](#fn-mysqlnew) + * [`obj mysql.ssl`](#obj-mysqlssl) + * [`fn new()`](#fn-mysqlsslnew) +* [`obj postgresql`](#obj-postgresql) + * [`fn new()`](#fn-postgresqlnew) + * [`obj postgresql.ssl`](#obj-postgresqlssl) + * [`fn new()`](#fn-postgresqlsslnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.new` injects a new `google-beta_google_database_migration_service_connection_profile` 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-beta.google_database_migration_service_connection_profile.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_database_migration_service_connection_profile` using the reference: + + $._ref.google-beta_google_database_migration_service_connection_profile.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_database_migration_service_connection_profile.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. + - `connection_profile_id` (`string`): The ID of the connection profile. + - `display_name` (`string`): The connection profile display name. When `null`, the `display_name` field will be omitted from the resulting object. + - `labels` (`obj`): The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The location where the connection profile should reside. When `null`, the `location` 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. + - `alloydb` (`list[obj]`): Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. When `null`, the `alloydb` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.alloydb.new](#fn-alloydbnew) constructor. + - `cloudsql` (`list[obj]`): Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. When `null`, the `cloudsql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.cloudsql.new](#fn-cloudsqlnew) constructor. + - `mysql` (`list[obj]`): Specifies connection parameters required specifically for MySQL databases. When `null`, the `mysql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.mysql.new](#fn-mysqlnew) constructor. + - `postgresql` (`list[obj]`): Specifies connection parameters required specifically for PostgreSQL databases. When `null`, the `postgresql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.postgresql.new](#fn-postgresqlnew) 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-beta.google_database_migration_service_connection_profile.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_database_migration_service_connection_profile.newAttrs` constructs a new object with attributes and blocks configured for the `google_database_migration_service_connection_profile` +Terraform resource. + +Unlike [google-beta.google_database_migration_service_connection_profile.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**: + - `connection_profile_id` (`string`): The ID of the connection profile. + - `display_name` (`string`): The connection profile display name. When `null`, the `display_name` field will be omitted from the resulting object. + - `labels` (`obj`): The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The location where the connection profile should reside. When `null`, the `location` 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. + - `alloydb` (`list[obj]`): Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. When `null`, the `alloydb` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.alloydb.new](#fn-alloydbnew) constructor. + - `cloudsql` (`list[obj]`): Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. When `null`, the `cloudsql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.cloudsql.new](#fn-cloudsqlnew) constructor. + - `mysql` (`list[obj]`): Specifies connection parameters required specifically for MySQL databases. When `null`, the `mysql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.mysql.new](#fn-mysqlnew) constructor. + - `postgresql` (`list[obj]`): Specifies connection parameters required specifically for PostgreSQL databases. When `null`, the `postgresql` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.postgresql.new](#fn-postgresqlnew) 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-beta.google_database_migration_service_connection_profile.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 `google_database_migration_service_connection_profile` resource into the root Terraform configuration. + + +### fn withAlloydb + +```ts +withAlloydb() +``` + +`google-beta.list[obj].withAlloydb` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the alloydb 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-beta.list[obj].withAlloydbMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `alloydb` field. + + +### fn withAlloydbMixin + +```ts +withAlloydbMixin() +``` + +`google-beta.list[obj].withAlloydbMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the alloydb 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-beta.list[obj].withAlloydb](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `alloydb` field. + + +### fn withCloudsql + +```ts +withCloudsql() +``` + +`google-beta.list[obj].withCloudsql` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the cloudsql 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-beta.list[obj].withCloudsqlMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `cloudsql` field. + + +### fn withCloudsqlMixin + +```ts +withCloudsqlMixin() +``` + +`google-beta.list[obj].withCloudsqlMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the cloudsql 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-beta.list[obj].withCloudsql](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `cloudsql` field. + + +### fn withConnectionProfileId + +```ts +withConnectionProfileId() +``` + +`google-beta.string.withConnectionProfileId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the connection_profile_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `connection_profile_id` field. + + +### fn withDisplayName + +```ts +withDisplayName() +``` + +`google-beta.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 withLabels + +```ts +withLabels() +``` + +`google-beta.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-beta.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 withMysql + +```ts +withMysql() +``` + +`google-beta.list[obj].withMysql` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the mysql 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-beta.list[obj].withMysqlMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `mysql` field. + + +### fn withMysqlMixin + +```ts +withMysqlMixin() +``` + +`google-beta.list[obj].withMysqlMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the mysql 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-beta.list[obj].withMysql](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `mysql` field. + + +### fn withPostgresql + +```ts +withPostgresql() +``` + +`google-beta.list[obj].withPostgresql` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the postgresql 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-beta.list[obj].withPostgresqlMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `postgresql` field. + + +### fn withPostgresqlMixin + +```ts +withPostgresqlMixin() +``` + +`google-beta.list[obj].withPostgresqlMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the postgresql 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-beta.list[obj].withPostgresql](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `postgresql` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.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-beta.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-beta.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-beta.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-beta.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 alloydb + + + +### fn alloydb.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.alloydb.new` constructs a new object with attributes and blocks configured for the `alloydb` +Terraform sub block. + + + +**Args**: + - `cluster_id` (`string`): Required. The AlloyDB cluster ID that this connection profile is associated with. + - `settings` (`list[obj]`): Immutable. Metadata used to create the destination AlloyDB cluster. When `null`, the `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-beta.google_database_migration_service_connection_profile.alloydb.settings.new](#fn-alloydbsettingsnew) constructor. + +**Returns**: + - An attribute object that represents the `alloydb` sub block. + + +## obj alloydb.settings + + + +### fn alloydb.settings.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.alloydb.settings.new` constructs a new object with attributes and blocks configured for the `settings` +Terraform sub block. + + + +**Args**: + - `labels` (`obj`): Labels for the AlloyDB cluster created by DMS. When `null`, the `labels` field will be omitted from the resulting object. + - `vpc_network` (`string`): Required. 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/{project_number}/global/networks/{network_id}'. This is required to create a cluster. + - `initial_user` (`list[obj]`): Required. Input only. 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-beta.google_database_migration_service_connection_profile.alloydb.settings.initial_user.new](#fn-alloydballoydbinitial_usernew) constructor. + - `primary_instance_settings` (`list[obj]`): Settings for the cluster's primary instance When `null`, the `primary_instance_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-beta.google_database_migration_service_connection_profile.alloydb.settings.primary_instance_settings.new](#fn-alloydballoydbprimary_instance_settingsnew) constructor. + +**Returns**: + - An attribute object that represents the `settings` sub block. + + +## obj alloydb.settings.initial_user + + + +### fn alloydb.settings.initial_user.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.alloydb.settings.initial_user.new` constructs a new object with attributes and blocks configured for the `initial_user` +Terraform sub block. + + + +**Args**: + - `password` (`string`): The initial password for the user. + - `user` (`string`): The database username. + +**Returns**: + - An attribute object that represents the `initial_user` sub block. + + +## obj alloydb.settings.primary_instance_settings + + + +### fn alloydb.settings.primary_instance_settings.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.alloydb.settings.primary_instance_settings.new` constructs a new object with attributes and blocks configured for the `primary_instance_settings` +Terraform sub block. + + + +**Args**: + - `database_flags` (`obj`): Database flags to pass to AlloyDB when DMS is creating the AlloyDB cluster and instances. See the AlloyDB documentation for how these can be used. When `null`, the `database_flags` field will be omitted from the resulting object. + - `labels` (`obj`): Labels for the AlloyDB primary instance created by DMS. When `null`, the `labels` field will be omitted from the resulting object. + - `machine_config` (`list[obj]`): Configuration for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.alloydb.settings.primary_instance_settings.machine_config.new](#fn-alloydballoydbsettingsmachine_confignew) constructor. + +**Returns**: + - An attribute object that represents the `primary_instance_settings` sub block. + + +## obj alloydb.settings.primary_instance_settings.machine_config + + + +### fn alloydb.settings.primary_instance_settings.machine_config.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.alloydb.settings.primary_instance_settings.machine_config.new` constructs a new object with attributes and blocks configured for the `machine_config` +Terraform sub block. + + + +**Args**: + - `cpu_count` (`number`): The number of CPU's in the VM instance. + +**Returns**: + - An attribute object that represents the `machine_config` sub block. + + +## obj cloudsql + + + +### fn cloudsql.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.cloudsql.new` constructs a new object with attributes and blocks configured for the `cloudsql` +Terraform sub block. + + + +**Args**: + - `settings` (`list[obj]`): Immutable. Metadata used to create the destination Cloud SQL database. When `null`, the `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-beta.google_database_migration_service_connection_profile.cloudsql.settings.new](#fn-cloudsqlsettingsnew) constructor. + +**Returns**: + - An attribute object that represents the `cloudsql` sub block. + + +## obj cloudsql.settings + + + +### fn cloudsql.settings.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.cloudsql.settings.new` constructs a new object with attributes and blocks configured for the `settings` +Terraform sub block. + + + +**Args**: + - `activation_policy` (`string`): The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Possible values: ["ALWAYS", "NEVER"] When `null`, the `activation_policy` field will be omitted from the resulting object. + - `auto_storage_increase` (`bool`): If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. +If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB. When `null`, the `auto_storage_increase` field will be omitted from the resulting object. + - `cmek_key_name` (`string`): The KMS key name used for the csql instance. When `null`, the `cmek_key_name` field will be omitted from the resulting object. + - `collation` (`string`): The Cloud SQL default instance level collation. When `null`, the `collation` field will be omitted from the resulting object. + - `data_disk_size_gb` (`string`): The storage capacity available to the database, in GB. The minimum (and default) size is 10GB. When `null`, the `data_disk_size_gb` field will be omitted from the resulting object. + - `data_disk_type` (`string`): The type of storage. Possible values: ["PD_SSD", "PD_HDD"] When `null`, the `data_disk_type` field will be omitted from the resulting object. + - `database_flags` (`obj`): The database flags passed to the Cloud SQL instance at startup. When `null`, the `database_flags` field will be omitted from the resulting object. + - `database_version` (`string`): The database engine type and version. +Currently supported values located at https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.connectionProfiles#sqldatabaseversion When `null`, the `database_version` field will be omitted from the resulting object. + - `root_password` (`string`): Input only. Initial root password. When `null`, the `root_password` field will be omitted from the resulting object. + - `source_id` (`string`): The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID + - `storage_auto_resize_limit` (`string`): The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. When `null`, the `storage_auto_resize_limit` field will be omitted from the resulting object. + - `tier` (`string`): The tier (or machine type) for this instance, for example: db-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). +For more information, see https://cloud.google.com/sql/docs/mysql/instance-settings When `null`, the `tier` field will be omitted from the resulting object. + - `user_labels` (`obj`): The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. When `null`, the `user_labels` field will be omitted from the resulting object. + - `zone` (`string`): The Google Cloud Platform zone where your Cloud SQL datdabse instance is located. When `null`, the `zone` field will be omitted from the resulting object. + - `ip_config` (`list[obj]`): The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled. When `null`, the `ip_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-beta.google_database_migration_service_connection_profile.cloudsql.settings.ip_config.new](#fn-cloudsqlcloudsqlip_confignew) constructor. + +**Returns**: + - An attribute object that represents the `settings` sub block. + + +## obj cloudsql.settings.ip_config + + + +### fn cloudsql.settings.ip_config.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.cloudsql.settings.ip_config.new` constructs a new object with attributes and blocks configured for the `ip_config` +Terraform sub block. + + + +**Args**: + - `enable_ipv4` (`bool`): Whether the instance should be assigned an IPv4 address or not. When `null`, the `enable_ipv4` field will be omitted from the resulting object. + - `private_network` (`string`): The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. +This setting can be updated, but it cannot be removed after it is set. When `null`, the `private_network` field will be omitted from the resulting object. + - `require_ssl` (`bool`): Whether SSL connections over IP should be enforced or not. When `null`, the `require_ssl` field will be omitted from the resulting object. + - `authorized_networks` (`list[obj]`): The list of external networks that are allowed to connect to the instance using the IP. When `null`, the `authorized_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-beta.google_database_migration_service_connection_profile.cloudsql.settings.ip_config.authorized_networks.new](#fn-cloudsqlcloudsqlsettingsauthorized_networksnew) constructor. + +**Returns**: + - An attribute object that represents the `ip_config` sub block. + + +## obj cloudsql.settings.ip_config.authorized_networks + + + +### fn cloudsql.settings.ip_config.authorized_networks.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.cloudsql.settings.ip_config.authorized_networks.new` constructs a new object with attributes and blocks configured for the `authorized_networks` +Terraform sub block. + + + +**Args**: + - `expire_time` (`string`): The time when this access control entry expires in RFC 3339 format. When `null`, the `expire_time` field will be omitted from the resulting object. + - `label` (`string`): A label to identify this entry. When `null`, the `label` field will be omitted from the resulting object. + - `ttl` (`string`): Input only. The time-to-leave of this access control entry. When `null`, the `ttl` field will be omitted from the resulting object. + - `value` (`string`): The allowlisted value for the access control list. + +**Returns**: + - An attribute object that represents the `authorized_networks` sub block. + + +## obj mysql + + + +### fn mysql.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.mysql.new` constructs a new object with attributes and blocks configured for the `mysql` +Terraform sub block. + + + +**Args**: + - `cloud_sql_id` (`string`): If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. When `null`, the `cloud_sql_id` field will be omitted from the resulting object. + - `host` (`string`): Required. The IP or hostname of the source MySQL database. + - `password` (`string`): Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. +This field is not returned on request, and the value is encrypted when stored in Database Migration Service. + - `port` (`number`): Required. The network port of the source MySQL database. + - `username` (`string`): Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. + - `ssl` (`list[obj]`): SSL configuration for the destination to connect to the source database. When `null`, the `ssl` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.mysql.ssl.new](#fn-mysqlsslnew) constructor. + +**Returns**: + - An attribute object that represents the `mysql` sub block. + + +## obj mysql.ssl + + + +### fn mysql.ssl.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.mysql.ssl.new` constructs a new object with attributes and blocks configured for the `ssl` +Terraform sub block. + + + +**Args**: + - `ca_certificate` (`string`): Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. +The replica will use this certificate to verify it's connecting to the right host. + - `client_certificate` (`string`): Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server. +If this field is used then the 'clientKey' field is mandatory When `null`, the `client_certificate` field will be omitted from the resulting object. + - `client_key` (`string`): Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. +If this field is used then the 'clientCertificate' field is mandatory. When `null`, the `client_key` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `ssl` sub block. + + +## obj postgresql + + + +### fn postgresql.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.postgresql.new` constructs a new object with attributes and blocks configured for the `postgresql` +Terraform sub block. + + + +**Args**: + - `cloud_sql_id` (`string`): If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. When `null`, the `cloud_sql_id` field will be omitted from the resulting object. + - `host` (`string`): Required. The IP or hostname of the source MySQL database. + - `password` (`string`): Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. +This field is not returned on request, and the value is encrypted when stored in Database Migration Service. + - `port` (`number`): Required. The network port of the source MySQL database. + - `username` (`string`): Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. + - `ssl` (`list[obj]`): SSL configuration for the destination to connect to the source database. When `null`, the `ssl` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_database_migration_service_connection_profile.postgresql.ssl.new](#fn-postgresqlsslnew) constructor. + +**Returns**: + - An attribute object that represents the `postgresql` sub block. + + +## obj postgresql.ssl + + + +### fn postgresql.ssl.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.postgresql.ssl.new` constructs a new object with attributes and blocks configured for the `ssl` +Terraform sub block. + + + +**Args**: + - `ca_certificate` (`string`): Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. +The replica will use this certificate to verify it's connecting to the right host. + - `client_certificate` (`string`): Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server. +If this field is used then the 'clientKey' field is mandatory When `null`, the `client_certificate` field will be omitted from the resulting object. + - `client_key` (`string`): Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. +If this field is used then the 'clientCertificate' field is mandatory. When `null`, the `client_key` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `ssl` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_database_migration_service_connection_profile.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/google_dialogflow_agent.md b/docs/4.x/google_dialogflow_agent.md index 2ed9939a..d3018c7d 100644 --- a/docs/4.x/google_dialogflow_agent.md +++ b/docs/4.x/google_dialogflow_agent.md @@ -62,7 +62,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - `api_version` (`string`): API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query -different service endpoints for different API versions. However, bots connectors and webhook calls will follow +different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version. * API_VERSION_V1: Legacy V1 API. * API_VERSION_V2: V2 API. @@ -72,10 +72,10 @@ into this field, the Dialogflow will save the image in the backend. The address from the API will be shown in the [avatarUriBackend] field. When `null`, the `avatar_uri` field will be omitted from the resulting object. - `classification_threshold` (`number`): To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold -value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be -triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the +value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be +triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. When `null`, the `classification_threshold` field will be omitted from the resulting object. - - `default_language_code` (`string`): The default language of the agent as a language tag. [See Language Support](https://cloud.google.com/dialogflow/docs/reference/language) + - `default_language_code` (`string`): The default language of the agent as a language tag. [See Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be updated after creation. - `description` (`string`): The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. When `null`, the `description` field will be omitted from the resulting object. - `display_name` (`string`): The name of this agent. @@ -91,7 +91,7 @@ using @sys.any or very large developer entities. Possible values: ["MATCH_MO * TIER_STANDARD: Standard tier. * TIER_ENTERPRISE: Enterprise tier (Essentials). * TIER_ENTERPRISE_PLUS: Enterprise tier (Plus). -NOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between +NOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between the Terraform state and Dialogflow if the agent tier is changed outside of Terraform. Possible values: ["TIER_STANDARD", "TIER_ENTERPRISE", "TIER_ENTERPRISE_PLUS"] When `null`, the `tier` field will be omitted from the resulting object. - `time_zone` (`string`): The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. @@ -120,7 +120,7 @@ injecting into a complete block. **Args**: - `api_version` (`string`): API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query -different service endpoints for different API versions. However, bots connectors and webhook calls will follow +different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version. * API_VERSION_V1: Legacy V1 API. * API_VERSION_V2: V2 API. @@ -130,10 +130,10 @@ into this field, the Dialogflow will save the image in the backend. The address from the API will be shown in the [avatarUriBackend] field. When `null`, the `avatar_uri` field will be omitted from the resulting object. - `classification_threshold` (`number`): To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold -value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be -triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the +value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be +triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. When `null`, the `classification_threshold` field will be omitted from the resulting object. - - `default_language_code` (`string`): The default language of the agent as a language tag. [See Language Support](https://cloud.google.com/dialogflow/docs/reference/language) + - `default_language_code` (`string`): The default language of the agent as a language tag. [See Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be updated after creation. - `description` (`string`): The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. When `null`, the `description` field will be omitted from the resulting object. - `display_name` (`string`): The name of this agent. @@ -149,7 +149,7 @@ using @sys.any or very large developer entities. Possible values: ["MATCH_MO * TIER_STANDARD: Standard tier. * TIER_ENTERPRISE: Enterprise tier (Essentials). * TIER_ENTERPRISE_PLUS: Enterprise tier (Plus). -NOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between +NOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between the Terraform state and Dialogflow if the agent tier is changed outside of Terraform. Possible values: ["TIER_STANDARD", "TIER_ENTERPRISE", "TIER_ENTERPRISE_PLUS"] When `null`, the `tier` field will be omitted from the resulting object. - `time_zone` (`string`): The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. diff --git a/docs/4.x/google_dialogflow_intent.md b/docs/4.x/google_dialogflow_intent.md index 1bbe59fc..2fcc7230 100644 --- a/docs/4.x/google_dialogflow_intent.md +++ b/docs/4.x/google_dialogflow_intent.md @@ -67,7 +67,7 @@ Note: The action name must not contain whitespaces. When `null`, the `action` fi (i.e. default platform). Possible values: ["FACEBOOK", "SLACK", "TELEGRAM", "KIK", "SKYPE", "LINE", "VIBER", "ACTIONS_ON_GOOGLE", "GOOGLE_HANGOUTS"] When `null`, the `default_response_platforms` field will be omitted from the resulting object. - `display_name` (`string`): The name of this intent to be displayed on the console. - `events` (`list`): The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of -the contexts must be present in the active user session for an event to trigger this intent. See the +the contexts must be present in the active user session for an event to trigger this intent. See the [events reference](https://cloud.google.com/dialogflow/docs/events-overview) for more details. When `null`, the `events` field will be omitted from the resulting object. - `input_context_names` (`list`): The list of context names required for this intent to be triggered. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>. When `null`, the `input_context_names` field will be omitted from the resulting object. @@ -117,7 +117,7 @@ Note: The action name must not contain whitespaces. When `null`, the `action` fi (i.e. default platform). Possible values: ["FACEBOOK", "SLACK", "TELEGRAM", "KIK", "SKYPE", "LINE", "VIBER", "ACTIONS_ON_GOOGLE", "GOOGLE_HANGOUTS"] When `null`, the `default_response_platforms` field will be omitted from the resulting object. - `display_name` (`string`): The name of this intent to be displayed on the console. - `events` (`list`): The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of -the contexts must be present in the active user session for an event to trigger this intent. See the +the contexts must be present in the active user session for an event to trigger this intent. See the [events reference](https://cloud.google.com/dialogflow/docs/events-overview) for more details. When `null`, the `events` field will be omitted from the resulting object. - `input_context_names` (`list`): The list of context names required for this intent to be triggered. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>. When `null`, the `input_context_names` field will be omitted from the resulting object. diff --git a/docs/4.x/google_dns_managed_zone.md b/docs/4.x/google_dns_managed_zone.md index 0a731487..435685a9 100644 --- a/docs/4.x/google_dns_managed_zone.md +++ b/docs/4.x/google_dns_managed_zone.md @@ -781,8 +781,8 @@ Terraform sub block. **Args**: - - `gke_cluster_name` (`string`): The resource name of the cluster to bind this ManagedZone to. -This should be specified in the format like + - `gke_cluster_name` (`string`): The resource name of the cluster to bind this ManagedZone to. +This should be specified in the format like 'projects/*/locations/*/clusters/*' **Returns**: diff --git a/docs/4.x/google_dns_response_policy.md b/docs/4.x/google_dns_response_policy.md index ffdfbab3..f508e70d 100644 --- a/docs/4.x/google_dns_response_policy.md +++ b/docs/4.x/google_dns_response_policy.md @@ -275,8 +275,8 @@ Terraform sub block. **Args**: - - `gke_cluster_name` (`string`): The resource name of the cluster to bind this ManagedZone to. -This should be specified in the format like + - `gke_cluster_name` (`string`): The resource name of the cluster to bind this ManagedZone to. +This should be specified in the format like 'projects/*/locations/*/clusters/*' **Returns**: diff --git a/docs/4.x/google_firebase_apple_app.md b/docs/4.x/google_firebase_apple_app.md index 0d7434ce..14de1158 100644 --- a/docs/4.x/google_firebase_apple_app.md +++ b/docs/4.x/google_firebase_apple_app.md @@ -56,7 +56,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - `app_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object. - - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore. When `null`, the `bundle_id` field will be omitted from the resulting object. + - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore. - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the Apple to be untracked from terraform state rather than deleted upon 'terraform destroy'. This is useful because the Apple may be serving traffic. Set to 'DELETE' to delete the Apple. Defaults to 'DELETE'. When `null`, the `deletion_policy` field will be omitted from the resulting object. @@ -88,7 +88,7 @@ injecting into a complete block. **Args**: - `app_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object. - - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore. When `null`, the `bundle_id` field will be omitted from the resulting object. + - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore. - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the Apple to be untracked from terraform state rather than deleted upon 'terraform destroy'. This is useful because the Apple may be serving traffic. Set to 'DELETE' to delete the Apple. Defaults to 'DELETE'. When `null`, the `deletion_policy` field will be omitted from the resulting object. diff --git a/docs/4.x/google_firebase_database_instance.md b/docs/4.x/google_firebase_database_instance.md index 0284b782..fb49f466 100644 --- a/docs/4.x/google_firebase_database_instance.md +++ b/docs/4.x/google_firebase_database_instance.md @@ -55,7 +55,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - `desired_state` (`string`): The intended database state. When `null`, the `desired_state` field will be omitted from the resulting object. - - `instance_id` (`string`): The globally unique identifier of the Firebase Realtime Database instance. + - `instance_id` (`string`): The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `region` (`string`): A reference to the region where the Firebase Realtime database resides. @@ -89,7 +89,7 @@ injecting into a complete block. **Args**: - `desired_state` (`string`): The intended database state. When `null`, the `desired_state` field will be omitted from the resulting object. - - `instance_id` (`string`): The globally unique identifier of the Firebase Realtime Database instance. + - `instance_id` (`string`): The globally unique identifier of the Firebase Realtime Database instance. Instance IDs cannot be reused after deletion. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `region` (`string`): A reference to the region where the Firebase Realtime database resides. diff --git a/docs/4.x/google_gke_hub_membership.md b/docs/4.x/google_gke_hub_membership.md index ee52f0e9..15bdcbb2 100644 --- a/docs/4.x/google_gke_hub_membership.md +++ b/docs/4.x/google_gke_hub_membership.md @@ -300,7 +300,7 @@ Terraform sub block. **Args**: - - `issuer` (`string`): A JSON Web Token (JWT) issuer URI. 'issuer' must start with 'https://' and // be a valid + - `issuer` (`string`): A JSON Web Token (JWT) issuer URI. 'issuer' must start with 'https://' and // be a valid with length <2000 characters. For example: 'https://container.googleapis.com/v1/projects/my-project/locations/us-west1/clusters/my-cluster' (must be 'locations' rather than 'zones'). If the cluster is provisioned with Terraform, this is '"https://container.googleapis.com/v1/${google_container_cluster.my-cluster.id}"'. **Returns**: diff --git a/docs/4.x/google_gkeonprem_vmware_cluster.md b/docs/4.x/google_gkeonprem_vmware_cluster.md new file mode 100644 index 00000000..fca6fe06 --- /dev/null +++ b/docs/4.x/google_gkeonprem_vmware_cluster.md @@ -0,0 +1,1289 @@ +--- +permalink: /google_gkeonprem_vmware_cluster/ +--- + +# google_gkeonprem_vmware_cluster + +`google_gkeonprem_vmware_cluster` represents the `google-beta_google_gkeonprem_vmware_cluster` 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 withAdminClusterMembership()`](#fn-withadminclustermembership) +* [`fn withAnnotations()`](#fn-withannotations) +* [`fn withAntiAffinityGroups()`](#fn-withantiaffinitygroups) +* [`fn withAntiAffinityGroupsMixin()`](#fn-withantiaffinitygroupsmixin) +* [`fn withAuthorization()`](#fn-withauthorization) +* [`fn withAuthorizationMixin()`](#fn-withauthorizationmixin) +* [`fn withAutoRepairConfig()`](#fn-withautorepairconfig) +* [`fn withAutoRepairConfigMixin()`](#fn-withautorepairconfigmixin) +* [`fn withControlPlaneNode()`](#fn-withcontrolplanenode) +* [`fn withControlPlaneNodeMixin()`](#fn-withcontrolplanenodemixin) +* [`fn withDataplaneV2()`](#fn-withdataplanev2) +* [`fn withDataplaneV2Mixin()`](#fn-withdataplanev2mixin) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withEnableControlPlaneV2()`](#fn-withenablecontrolplanev2) +* [`fn withLoadBalancer()`](#fn-withloadbalancer) +* [`fn withLoadBalancerMixin()`](#fn-withloadbalancermixin) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withName()`](#fn-withname) +* [`fn withNetworkConfig()`](#fn-withnetworkconfig) +* [`fn withNetworkConfigMixin()`](#fn-withnetworkconfigmixin) +* [`fn withOnPremVersion()`](#fn-withonpremversion) +* [`fn withProject()`](#fn-withproject) +* [`fn withStorage()`](#fn-withstorage) +* [`fn withStorageMixin()`](#fn-withstoragemixin) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withVmTrackingEnabled()`](#fn-withvmtrackingenabled) +* [`obj anti_affinity_groups`](#obj-anti_affinity_groups) + * [`fn new()`](#fn-anti_affinity_groupsnew) +* [`obj authorization`](#obj-authorization) + * [`fn new()`](#fn-authorizationnew) + * [`obj authorization.admin_users`](#obj-authorizationadmin_users) + * [`fn new()`](#fn-authorizationadmin_usersnew) +* [`obj auto_repair_config`](#obj-auto_repair_config) + * [`fn new()`](#fn-auto_repair_confignew) +* [`obj control_plane_node`](#obj-control_plane_node) + * [`fn new()`](#fn-control_plane_nodenew) + * [`obj control_plane_node.auto_resize_config`](#obj-control_plane_nodeauto_resize_config) + * [`fn new()`](#fn-control_plane_nodeauto_resize_confignew) +* [`obj dataplane_v2`](#obj-dataplane_v2) + * [`fn new()`](#fn-dataplane_v2new) +* [`obj load_balancer`](#obj-load_balancer) + * [`fn new()`](#fn-load_balancernew) + * [`obj load_balancer.f5_config`](#obj-load_balancerf5_config) + * [`fn new()`](#fn-load_balancerf5_confignew) + * [`obj load_balancer.manual_lb_config`](#obj-load_balancermanual_lb_config) + * [`fn new()`](#fn-load_balancermanual_lb_confignew) + * [`obj load_balancer.metal_lb_config`](#obj-load_balancermetal_lb_config) + * [`fn new()`](#fn-load_balancermetal_lb_confignew) + * [`obj load_balancer.metal_lb_config.address_pools`](#obj-load_balancermetal_lb_configaddress_pools) + * [`fn new()`](#fn-load_balancermetal_lb_configaddress_poolsnew) + * [`obj load_balancer.vip_config`](#obj-load_balancervip_config) + * [`fn new()`](#fn-load_balancervip_confignew) +* [`obj network_config`](#obj-network_config) + * [`fn new()`](#fn-network_confignew) + * [`obj network_config.control_plane_v2_config`](#obj-network_configcontrol_plane_v2_config) + * [`fn new()`](#fn-network_configcontrol_plane_v2_confignew) + * [`obj network_config.control_plane_v2_config.control_plane_ip_block`](#obj-network_configcontrol_plane_v2_configcontrol_plane_ip_block) + * [`fn new()`](#fn-network_configcontrol_plane_v2_configcontrol_plane_ip_blocknew) + * [`obj network_config.control_plane_v2_config.control_plane_ip_block.ips`](#obj-network_configcontrol_plane_v2_configcontrol_plane_ip_blockips) + * [`fn new()`](#fn-network_configcontrol_plane_v2_configcontrol_plane_ip_blockipsnew) + * [`obj network_config.dhcp_ip_config`](#obj-network_configdhcp_ip_config) + * [`fn new()`](#fn-network_configdhcp_ip_confignew) + * [`obj network_config.host_config`](#obj-network_confighost_config) + * [`fn new()`](#fn-network_confighost_confignew) + * [`obj network_config.static_ip_config`](#obj-network_configstatic_ip_config) + * [`fn new()`](#fn-network_configstatic_ip_confignew) + * [`obj network_config.static_ip_config.ip_blocks`](#obj-network_configstatic_ip_configip_blocks) + * [`fn new()`](#fn-network_configstatic_ip_configip_blocksnew) + * [`obj network_config.static_ip_config.ip_blocks.ips`](#obj-network_configstatic_ip_configip_blocksips) + * [`fn new()`](#fn-network_configstatic_ip_configip_blocksipsnew) +* [`obj storage`](#obj-storage) + * [`fn new()`](#fn-storagenew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.new` injects a new `google-beta_google_gkeonprem_vmware_cluster` 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-beta.google_gkeonprem_vmware_cluster.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_gkeonprem_vmware_cluster` using the reference: + + $._ref.google-beta_google_gkeonprem_vmware_cluster.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_gkeonprem_vmware_cluster.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. + - `admin_cluster_membership` (`string`): The admin cluster this VMware User Cluster belongs to. +This is the full resource name of the admin cluster's hub membership. +In the future, references to other resource types might be allowed if +admin clusters are modeled as their own resources. + - `annotations` (`obj`): Annotations on the VMware User Cluster. +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. + - `description` (`string`): A human readable description of this VMware User Cluster. When `null`, the `description` field will be omitted from the resulting object. + - `enable_control_plane_v2` (`bool`): Enable control plane V2. Default to false. When `null`, the `enable_control_plane_v2` field will be omitted from the resulting object. + - `location` (`string`): The location of the resource. + - `name` (`string`): The VMware cluster name. + - `on_prem_version` (`string`): The Anthos clusters on the VMware version for your user cluster. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `vm_tracking_enabled` (`bool`): Enable VM tracking. When `null`, the `vm_tracking_enabled` field will be omitted from the resulting object. + - `anti_affinity_groups` (`list[obj]`): AAGConfig specifies whether to spread VMware User Cluster nodes across at +least three physical hosts in the datacenter. When `null`, the `anti_affinity_groups` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.anti_affinity_groups.new](#fn-anti_affinity_groupsnew) constructor. + - `authorization` (`list[obj]`): RBAC policy that will be applied and managed by GKE On-Prem. When `null`, the `authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.authorization.new](#fn-authorizationnew) constructor. + - `auto_repair_config` (`list[obj]`): Configuration for auto repairing. When `null`, the `auto_repair_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-beta.google_gkeonprem_vmware_cluster.auto_repair_config.new](#fn-auto_repair_confignew) constructor. + - `control_plane_node` (`list[obj]`): VMware User Cluster control plane nodes must have either 1 or 3 replicas. When `null`, the `control_plane_node` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.control_plane_node.new](#fn-control_plane_nodenew) constructor. + - `dataplane_v2` (`list[obj]`): VmwareDataplaneV2Config specifies configuration for Dataplane V2. When `null`, the `dataplane_v2` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.dataplane_v2.new](#fn-dataplane_v2new) constructor. + - `load_balancer` (`list[obj]`): Load Balancer configuration. When `null`, the `load_balancer` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.load_balancer.new](#fn-load_balancernew) constructor. + - `network_config` (`list[obj]`): The VMware User Cluster 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-beta.google_gkeonprem_vmware_cluster.network_config.new](#fn-network_confignew) constructor. + - `storage` (`list[obj]`): Storage configuration. When `null`, the `storage` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.storage.new](#fn-storagenew) 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-beta.google_gkeonprem_vmware_cluster.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `google_gkeonprem_vmware_cluster` +Terraform resource. + +Unlike [google-beta.google_gkeonprem_vmware_cluster.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**: + - `admin_cluster_membership` (`string`): The admin cluster this VMware User Cluster belongs to. +This is the full resource name of the admin cluster's hub membership. +In the future, references to other resource types might be allowed if +admin clusters are modeled as their own resources. + - `annotations` (`obj`): Annotations on the VMware User Cluster. +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. + - `description` (`string`): A human readable description of this VMware User Cluster. When `null`, the `description` field will be omitted from the resulting object. + - `enable_control_plane_v2` (`bool`): Enable control plane V2. Default to false. When `null`, the `enable_control_plane_v2` field will be omitted from the resulting object. + - `location` (`string`): The location of the resource. + - `name` (`string`): The VMware cluster name. + - `on_prem_version` (`string`): The Anthos clusters on the VMware version for your user cluster. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `vm_tracking_enabled` (`bool`): Enable VM tracking. When `null`, the `vm_tracking_enabled` field will be omitted from the resulting object. + - `anti_affinity_groups` (`list[obj]`): AAGConfig specifies whether to spread VMware User Cluster nodes across at +least three physical hosts in the datacenter. When `null`, the `anti_affinity_groups` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.anti_affinity_groups.new](#fn-anti_affinity_groupsnew) constructor. + - `authorization` (`list[obj]`): RBAC policy that will be applied and managed by GKE On-Prem. When `null`, the `authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.authorization.new](#fn-authorizationnew) constructor. + - `auto_repair_config` (`list[obj]`): Configuration for auto repairing. When `null`, the `auto_repair_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-beta.google_gkeonprem_vmware_cluster.auto_repair_config.new](#fn-auto_repair_confignew) constructor. + - `control_plane_node` (`list[obj]`): VMware User Cluster control plane nodes must have either 1 or 3 replicas. When `null`, the `control_plane_node` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.control_plane_node.new](#fn-control_plane_nodenew) constructor. + - `dataplane_v2` (`list[obj]`): VmwareDataplaneV2Config specifies configuration for Dataplane V2. When `null`, the `dataplane_v2` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.dataplane_v2.new](#fn-dataplane_v2new) constructor. + - `load_balancer` (`list[obj]`): Load Balancer configuration. When `null`, the `load_balancer` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.load_balancer.new](#fn-load_balancernew) constructor. + - `network_config` (`list[obj]`): The VMware User Cluster 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-beta.google_gkeonprem_vmware_cluster.network_config.new](#fn-network_confignew) constructor. + - `storage` (`list[obj]`): Storage configuration. When `null`, the `storage` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.storage.new](#fn-storagenew) 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-beta.google_gkeonprem_vmware_cluster.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 `google_gkeonprem_vmware_cluster` resource into the root Terraform configuration. + + +### fn withAdminClusterMembership + +```ts +withAdminClusterMembership() +``` + +`google-beta.string.withAdminClusterMembership` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the admin_cluster_membership field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `admin_cluster_membership` field. + + +### fn withAnnotations + +```ts +withAnnotations() +``` + +`google-beta.obj.withAnnotations` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the annotations field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `annotations` field. + + +### fn withAntiAffinityGroups + +```ts +withAntiAffinityGroups() +``` + +`google-beta.list[obj].withAntiAffinityGroups` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the anti_affinity_groups 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-beta.list[obj].withAntiAffinityGroupsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `anti_affinity_groups` field. + + +### fn withAntiAffinityGroupsMixin + +```ts +withAntiAffinityGroupsMixin() +``` + +`google-beta.list[obj].withAntiAffinityGroupsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the anti_affinity_groups 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-beta.list[obj].withAntiAffinityGroups](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `anti_affinity_groups` field. + + +### fn withAuthorization + +```ts +withAuthorization() +``` + +`google-beta.list[obj].withAuthorization` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the authorization 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-beta.list[obj].withAuthorizationMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `authorization` field. + + +### fn withAuthorizationMixin + +```ts +withAuthorizationMixin() +``` + +`google-beta.list[obj].withAuthorizationMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the authorization 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-beta.list[obj].withAuthorization](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `authorization` field. + + +### fn withAutoRepairConfig + +```ts +withAutoRepairConfig() +``` + +`google-beta.list[obj].withAutoRepairConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the auto_repair_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-beta.list[obj].withAutoRepairConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `auto_repair_config` field. + + +### fn withAutoRepairConfigMixin + +```ts +withAutoRepairConfigMixin() +``` + +`google-beta.list[obj].withAutoRepairConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the auto_repair_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-beta.list[obj].withAutoRepairConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `auto_repair_config` field. + + +### fn withControlPlaneNode + +```ts +withControlPlaneNode() +``` + +`google-beta.list[obj].withControlPlaneNode` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the control_plane_node 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-beta.list[obj].withControlPlaneNodeMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `control_plane_node` field. + + +### fn withControlPlaneNodeMixin + +```ts +withControlPlaneNodeMixin() +``` + +`google-beta.list[obj].withControlPlaneNodeMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the control_plane_node 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-beta.list[obj].withControlPlaneNode](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `control_plane_node` field. + + +### fn withDataplaneV2 + +```ts +withDataplaneV2() +``` + +`google-beta.list[obj].withDataplaneV2` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the dataplane_v2 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-beta.list[obj].withDataplaneV2Mixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `dataplane_v2` field. + + +### fn withDataplaneV2Mixin + +```ts +withDataplaneV2Mixin() +``` + +`google-beta.list[obj].withDataplaneV2Mixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the dataplane_v2 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-beta.list[obj].withDataplaneV2](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `dataplane_v2` field. + + +### fn withDescription + +```ts +withDescription() +``` + +`google-beta.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 withEnableControlPlaneV2 + +```ts +withEnableControlPlaneV2() +``` + +`google-beta.bool.withEnableControlPlaneV2` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the enable_control_plane_v2 field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `enable_control_plane_v2` field. + + +### fn withLoadBalancer + +```ts +withLoadBalancer() +``` + +`google-beta.list[obj].withLoadBalancer` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the load_balancer 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-beta.list[obj].withLoadBalancerMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `load_balancer` field. + + +### fn withLoadBalancerMixin + +```ts +withLoadBalancerMixin() +``` + +`google-beta.list[obj].withLoadBalancerMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the load_balancer 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-beta.list[obj].withLoadBalancer](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `load_balancer` field. + + +### fn withLocation + +```ts +withLocation() +``` + +`google-beta.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-beta.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 withNetworkConfig + +```ts +withNetworkConfig() +``` + +`google-beta.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-beta.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-beta.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-beta.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 withOnPremVersion + +```ts +withOnPremVersion() +``` + +`google-beta.string.withOnPremVersion` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the on_prem_version field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `on_prem_version` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.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 withStorage + +```ts +withStorage() +``` + +`google-beta.list[obj].withStorage` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the storage 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-beta.list[obj].withStorageMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `storage` field. + + +### fn withStorageMixin + +```ts +withStorageMixin() +``` + +`google-beta.list[obj].withStorageMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the storage 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-beta.list[obj].withStorage](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `storage` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.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-beta.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-beta.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-beta.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 withVmTrackingEnabled + +```ts +withVmTrackingEnabled() +``` + +`google-beta.bool.withVmTrackingEnabled` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the vm_tracking_enabled field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `vm_tracking_enabled` field. + + +## obj anti_affinity_groups + + + +### fn anti_affinity_groups.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.anti_affinity_groups.new` constructs a new object with attributes and blocks configured for the `anti_affinity_groups` +Terraform sub block. + + + +**Args**: + - `aag_config_disabled` (`bool`): Spread nodes across at least three physical hosts (requires at least three +hosts). +Enabled by default. + +**Returns**: + - An attribute object that represents the `anti_affinity_groups` sub block. + + +## obj authorization + + + +### fn authorization.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.authorization.new` constructs a new object with attributes and blocks configured for the `authorization` +Terraform sub block. + + + +**Args**: + - `admin_users` (`list[obj]`): Users that will be granted the cluster-admin role on the cluster, providing +full access to the cluster. When `null`, the `admin_users` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.authorization.admin_users.new](#fn-authorizationadmin_usersnew) constructor. + +**Returns**: + - An attribute object that represents the `authorization` sub block. + + +## obj authorization.admin_users + + + +### fn authorization.admin_users.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.authorization.admin_users.new` constructs a new object with attributes and blocks configured for the `admin_users` +Terraform sub block. + + + +**Args**: + - `username` (`string`): The name of the user, e.g. 'my-gcp-id@gmail.com'. + +**Returns**: + - An attribute object that represents the `admin_users` sub block. + + +## obj auto_repair_config + + + +### fn auto_repair_config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.auto_repair_config.new` constructs a new object with attributes and blocks configured for the `auto_repair_config` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Whether auto repair is enabled. + +**Returns**: + - An attribute object that represents the `auto_repair_config` sub block. + + +## obj control_plane_node + + + +### fn control_plane_node.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.control_plane_node.new` constructs a new object with attributes and blocks configured for the `control_plane_node` +Terraform sub block. + + + +**Args**: + - `cpus` (`number`): The number of CPUs for each admin cluster node that serve as control planes +for this VMware User Cluster. (default: 4 CPUs) When `null`, the `cpus` field will be omitted from the resulting object. + - `memory` (`number`): The megabytes of memory for each admin cluster node that serves as a +control plane for this VMware User Cluster (default: 8192 MB memory). When `null`, the `memory` field will be omitted from the resulting object. + - `replicas` (`number`): The number of control plane nodes for this VMware User Cluster. +(default: 1 replica). When `null`, the `replicas` field will be omitted from the resulting object. + - `auto_resize_config` (`list[obj]`): AutoResizeConfig provides auto resizing configurations. When `null`, the `auto_resize_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-beta.google_gkeonprem_vmware_cluster.control_plane_node.auto_resize_config.new](#fn-control_plane_nodeauto_resize_confignew) constructor. + +**Returns**: + - An attribute object that represents the `control_plane_node` sub block. + + +## obj control_plane_node.auto_resize_config + + + +### fn control_plane_node.auto_resize_config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.control_plane_node.auto_resize_config.new` constructs a new object with attributes and blocks configured for the `auto_resize_config` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Whether to enable control plane node auto resizing. + +**Returns**: + - An attribute object that represents the `auto_resize_config` sub block. + + +## obj dataplane_v2 + + + +### fn dataplane_v2.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.dataplane_v2.new` constructs a new object with attributes and blocks configured for the `dataplane_v2` +Terraform sub block. + + + +**Args**: + - `advanced_networking` (`bool`): Enable advanced networking which requires dataplane_v2_enabled to be set true. When `null`, the `advanced_networking` field will be omitted from the resulting object. + - `dataplane_v2_enabled` (`bool`): Enables Dataplane V2. When `null`, the `dataplane_v2_enabled` field will be omitted from the resulting object. + - `windows_dataplane_v2_enabled` (`bool`): Enable Dataplane V2 for clusters with Windows nodes. When `null`, the `windows_dataplane_v2_enabled` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `dataplane_v2` sub block. + + +## obj load_balancer + + + +### fn load_balancer.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.load_balancer.new` constructs a new object with attributes and blocks configured for the `load_balancer` +Terraform sub block. + + + +**Args**: + - `f5_config` (`list[obj]`): Configuration for F5 Big IP typed load balancers. When `null`, the `f5_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-beta.google_gkeonprem_vmware_cluster.load_balancer.f5_config.new](#fn-load_balancerf5_confignew) constructor. + - `manual_lb_config` (`list[obj]`): Manually configured load balancers. When `null`, the `manual_lb_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-beta.google_gkeonprem_vmware_cluster.load_balancer.manual_lb_config.new](#fn-load_balancermanual_lb_confignew) constructor. + - `metal_lb_config` (`list[obj]`): Configuration for MetalLB typed load balancers. When `null`, the `metal_lb_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-beta.google_gkeonprem_vmware_cluster.load_balancer.metal_lb_config.new](#fn-load_balancermetal_lb_confignew) constructor. + - `vip_config` (`list[obj]`): The VIPs used by the load balancer. When `null`, the `vip_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-beta.google_gkeonprem_vmware_cluster.load_balancer.vip_config.new](#fn-load_balancervip_confignew) constructor. + +**Returns**: + - An attribute object that represents the `load_balancer` sub block. + + +## obj load_balancer.f5_config + + + +### fn load_balancer.f5_config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.load_balancer.f5_config.new` constructs a new object with attributes and blocks configured for the `f5_config` +Terraform sub block. + + + +**Args**: + - `address` (`string`): The load balancer's IP address. When `null`, the `address` field will be omitted from the resulting object. + - `partition` (`string`): he preexisting partition to be used by the load balancer. T +his partition is usually created for the admin cluster for example: +'my-f5-admin-partition'. When `null`, the `partition` field will be omitted from the resulting object. + - `snat_pool` (`string`): The pool name. Only necessary, if using SNAT. When `null`, the `snat_pool` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `f5_config` sub block. + + +## obj load_balancer.manual_lb_config + + + +### fn load_balancer.manual_lb_config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.load_balancer.manual_lb_config.new` constructs a new object with attributes and blocks configured for the `manual_lb_config` +Terraform sub block. + + + +**Args**: + - `control_plane_node_port` (`number`): NodePort for control plane service. The Kubernetes API server in the admin +cluster is implemented as a Service of type NodePort (ex. 30968). When `null`, the `control_plane_node_port` field will be omitted from the resulting object. + - `ingress_http_node_port` (`number`): NodePort for ingress service's http. The ingress service in the admin +cluster is implemented as a Service of type NodePort (ex. 32527). When `null`, the `ingress_http_node_port` field will be omitted from the resulting object. + - `ingress_https_node_port` (`number`): NodePort for ingress service's https. The ingress service in the admin +cluster is implemented as a Service of type NodePort (ex. 30139). When `null`, the `ingress_https_node_port` field will be omitted from the resulting object. + - `konnectivity_server_node_port` (`number`): NodePort for konnectivity server service running as a sidecar in each +kube-apiserver pod (ex. 30564). When `null`, the `konnectivity_server_node_port` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `manual_lb_config` sub block. + + +## obj load_balancer.metal_lb_config + + + +### fn load_balancer.metal_lb_config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.load_balancer.metal_lb_config.new` constructs a new object with attributes and blocks configured for the `metal_lb_config` +Terraform sub block. + + + +**Args**: + - `address_pools` (`list[obj]`): AddressPools is a list of non-overlapping IP pools used by load balancer +typed services. All addresses must be routable to load balancer nodes. +IngressVIP must be included in the pools. When `null`, the `address_pools` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.load_balancer.metal_lb_config.address_pools.new](#fn-load_balancerload_balanceraddress_poolsnew) constructor. + +**Returns**: + - An attribute object that represents the `metal_lb_config` sub block. + + +## obj load_balancer.metal_lb_config.address_pools + + + +### fn load_balancer.metal_lb_config.address_pools.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.load_balancer.metal_lb_config.address_pools.new` constructs a new object with attributes and blocks configured for the `address_pools` +Terraform sub block. + + + +**Args**: + - `addresses` (`list`): The addresses that are part of this pool. Each address +must be either in the CIDR form (1.2.3.0/24) or range +form (1.2.3.1-1.2.3.5). + - `avoid_buggy_ips` (`bool`): If true, avoid using IPs ending in .0 or .255. +This avoids buggy consumer devices mistakenly dropping IPv4 traffic for +those special IP addresses. When `null`, the `avoid_buggy_ips` field will be omitted from the resulting object. + - `manual_assign` (`bool`): If true, prevent IP addresses from being automatically assigned. When `null`, the `manual_assign` field will be omitted from the resulting object. + - `pool` (`string`): The name of the address pool. + +**Returns**: + - An attribute object that represents the `address_pools` sub block. + + +## obj load_balancer.vip_config + + + +### fn load_balancer.vip_config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.load_balancer.vip_config.new` constructs a new object with attributes and blocks configured for the `vip_config` +Terraform sub block. + + + +**Args**: + - `control_plane_vip` (`string`): The VIP which you previously set aside for the Kubernetes API of this cluster. When `null`, the `control_plane_vip` field will be omitted from the resulting object. + - `ingress_vip` (`string`): The VIP which you previously set aside for ingress traffic into this cluster. When `null`, the `ingress_vip` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `vip_config` sub block. + + +## obj network_config + + + +### fn network_config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.network_config.new` constructs a new object with attributes and blocks configured for the `network_config` +Terraform sub block. + + + +**Args**: + - `pod_address_cidr_blocks` (`list`): All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. +Only a single range is supported. This field cannot be changed after creation. + - `service_address_cidr_blocks` (`list`): All services in the cluster are assigned an RFC1918 IPv4 address +from these ranges. Only a single range is supported.. This field +cannot be changed after creation. + - `control_plane_v2_config` (`list[obj]`): Configuration for control plane V2 mode. When `null`, the `control_plane_v2_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-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.new](#fn-network_configcontrol_plane_v2_confignew) constructor. + - `dhcp_ip_config` (`list[obj]`): Configuration settings for a DHCP IP configuration. When `null`, the `dhcp_ip_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-beta.google_gkeonprem_vmware_cluster.network_config.dhcp_ip_config.new](#fn-network_configdhcp_ip_confignew) constructor. + - `host_config` (`list[obj]`): Represents common network settings irrespective of the host's IP address. When `null`, the `host_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-beta.google_gkeonprem_vmware_cluster.network_config.host_config.new](#fn-network_confighost_confignew) constructor. + - `static_ip_config` (`list[obj]`): Configuration settings for a static IP configuration. When `null`, the `static_ip_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-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.new](#fn-network_configstatic_ip_confignew) constructor. + +**Returns**: + - An attribute object that represents the `network_config` sub block. + + +## obj network_config.control_plane_v2_config + + + +### fn network_config.control_plane_v2_config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.new` constructs a new object with attributes and blocks configured for the `control_plane_v2_config` +Terraform sub block. + + + +**Args**: + - `control_plane_ip_block` (`list[obj]`): Static IP addresses for the control plane nodes. When `null`, the `control_plane_ip_block` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.control_plane_ip_block.new](#fn-network_confignetwork_configcontrol_plane_ip_blocknew) constructor. + +**Returns**: + - An attribute object that represents the `control_plane_v2_config` sub block. + + +## obj network_config.control_plane_v2_config.control_plane_ip_block + + + +### fn network_config.control_plane_v2_config.control_plane_ip_block.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.control_plane_ip_block.new` constructs a new object with attributes and blocks configured for the `control_plane_ip_block` +Terraform sub block. + + + +**Args**: + - `gateway` (`string`): The network gateway used by the VMware User Cluster. When `null`, the `gateway` field will be omitted from the resulting object. + - `netmask` (`string`): The netmask used by the VMware User Cluster. When `null`, the `netmask` field will be omitted from the resulting object. + - `ips` (`list[obj]`): The node's network configurations used by the VMware User Cluster. When `null`, the `ips` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.control_plane_ip_block.ips.new](#fn-network_confignetwork_configcontrol_plane_v2_configipsnew) constructor. + +**Returns**: + - An attribute object that represents the `control_plane_ip_block` sub block. + + +## obj network_config.control_plane_v2_config.control_plane_ip_block.ips + + + +### fn network_config.control_plane_v2_config.control_plane_ip_block.ips.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.network_config.control_plane_v2_config.control_plane_ip_block.ips.new` constructs a new object with attributes and blocks configured for the `ips` +Terraform sub block. + + + +**Args**: + - `hostname` (`string`): Hostname of the machine. VM's name will be used if this field is empty. When `null`, the `hostname` field will be omitted from the resulting object. + - `ip` (`string`): IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24). When `null`, the `ip` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `ips` sub block. + + +## obj network_config.dhcp_ip_config + + + +### fn network_config.dhcp_ip_config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.network_config.dhcp_ip_config.new` constructs a new object with attributes and blocks configured for the `dhcp_ip_config` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): enabled is a flag to mark if DHCP IP allocation is +used for VMware user clusters. + +**Returns**: + - An attribute object that represents the `dhcp_ip_config` sub block. + + +## obj network_config.host_config + + + +### fn network_config.host_config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.network_config.host_config.new` constructs a new object with attributes and blocks configured for the `host_config` +Terraform sub block. + + + +**Args**: + - `dns_search_domains` (`list`): DNS search domains. When `null`, the `dns_search_domains` field will be omitted from the resulting object. + - `dns_servers` (`list`): DNS servers. When `null`, the `dns_servers` field will be omitted from the resulting object. + - `ntp_servers` (`list`): NTP servers. When `null`, the `ntp_servers` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `host_config` sub block. + + +## obj network_config.static_ip_config + + + +### fn network_config.static_ip_config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.new` constructs a new object with attributes and blocks configured for the `static_ip_config` +Terraform sub block. + + + +**Args**: + - `ip_blocks` (`list[obj]`): Represents the configuration values for static IP allocation to nodes. When `null`, the `ip_blocks` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.ip_blocks.new](#fn-network_confignetwork_configip_blocksnew) constructor. + +**Returns**: + - An attribute object that represents the `static_ip_config` sub block. + + +## obj network_config.static_ip_config.ip_blocks + + + +### fn network_config.static_ip_config.ip_blocks.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.ip_blocks.new` constructs a new object with attributes and blocks configured for the `ip_blocks` +Terraform sub block. + + + +**Args**: + - `gateway` (`string`): The network gateway used by the VMware User Cluster. + - `netmask` (`string`): The netmask used by the VMware User Cluster. + - `ips` (`list[obj]`): The node's network configurations used by the VMware User Cluster. When `null`, the `ips` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.ip_blocks.ips.new](#fn-network_confignetwork_configstatic_ip_configipsnew) constructor. + +**Returns**: + - An attribute object that represents the `ip_blocks` sub block. + + +## obj network_config.static_ip_config.ip_blocks.ips + + + +### fn network_config.static_ip_config.ip_blocks.ips.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.network_config.static_ip_config.ip_blocks.ips.new` constructs a new object with attributes and blocks configured for the `ips` +Terraform sub block. + + + +**Args**: + - `hostname` (`string`): Hostname of the machine. VM's name will be used if this field is empty. + - `ip` (`string`): IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24). + +**Returns**: + - An attribute object that represents the `ips` sub block. + + +## obj storage + + + +### fn storage.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.storage.new` constructs a new object with attributes and blocks configured for the `storage` +Terraform sub block. + + + +**Args**: + - `vsphere_csi_disabled` (`bool`): Whether or not to deploy vSphere CSI components in the VMware User Cluster. +Enabled by default. + +**Returns**: + - An attribute object that represents the `storage` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_cluster.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/google_gkeonprem_vmware_node_pool.md b/docs/4.x/google_gkeonprem_vmware_node_pool.md new file mode 100644 index 00000000..dbbe3a8b --- /dev/null +++ b/docs/4.x/google_gkeonprem_vmware_node_pool.md @@ -0,0 +1,443 @@ +--- +permalink: /google_gkeonprem_vmware_node_pool/ +--- + +# google_gkeonprem_vmware_node_pool + +`google_gkeonprem_vmware_node_pool` represents the `google-beta_google_gkeonprem_vmware_node_pool` 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 withAnnotations()`](#fn-withannotations) +* [`fn withConfig()`](#fn-withconfig) +* [`fn withConfigMixin()`](#fn-withconfigmixin) +* [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withName()`](#fn-withname) +* [`fn withNodePoolAutoscaling()`](#fn-withnodepoolautoscaling) +* [`fn withNodePoolAutoscalingMixin()`](#fn-withnodepoolautoscalingmixin) +* [`fn withProject()`](#fn-withproject) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withVmwareCluster()`](#fn-withvmwarecluster) +* [`obj config`](#obj-config) + * [`fn new()`](#fn-confignew) + * [`obj config.taints`](#obj-configtaints) + * [`fn new()`](#fn-configtaintsnew) +* [`obj node_pool_autoscaling`](#obj-node_pool_autoscaling) + * [`fn new()`](#fn-node_pool_autoscalingnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_node_pool.new` injects a new `google-beta_google_gkeonprem_vmware_node_pool` 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-beta.google_gkeonprem_vmware_node_pool.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_gkeonprem_vmware_node_pool` using the reference: + + $._ref.google-beta_google_gkeonprem_vmware_node_pool.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_gkeonprem_vmware_node_pool.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. + - `annotations` (`obj`): 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. + - `display_name` (`string`): The display name for the node pool. When `null`, the `display_name` field will be omitted from the resulting object. + - `location` (`string`): The location of the resource. + - `name` (`string`): The vmware node pool name. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `vmware_cluster` (`string`): The cluster this node pool belongs to. + - `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-beta.google_gkeonprem_vmware_node_pool.config.new](#fn-confignew) constructor. + - `node_pool_autoscaling` (`list[obj]`): Node Pool autoscaling config for the node pool. When `null`, the `node_pool_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-beta.google_gkeonprem_vmware_node_pool.node_pool_autoscaling.new](#fn-node_pool_autoscalingnew) 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-beta.google_gkeonprem_vmware_node_pool.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_gkeonprem_vmware_node_pool.newAttrs` constructs a new object with attributes and blocks configured for the `google_gkeonprem_vmware_node_pool` +Terraform resource. + +Unlike [google-beta.google_gkeonprem_vmware_node_pool.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**: + - `annotations` (`obj`): 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. + - `display_name` (`string`): The display name for the node pool. When `null`, the `display_name` field will be omitted from the resulting object. + - `location` (`string`): The location of the resource. + - `name` (`string`): The vmware node pool name. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `vmware_cluster` (`string`): The cluster this node pool belongs to. + - `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-beta.google_gkeonprem_vmware_node_pool.config.new](#fn-confignew) constructor. + - `node_pool_autoscaling` (`list[obj]`): Node Pool autoscaling config for the node pool. When `null`, the `node_pool_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-beta.google_gkeonprem_vmware_node_pool.node_pool_autoscaling.new](#fn-node_pool_autoscalingnew) 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-beta.google_gkeonprem_vmware_node_pool.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 `google_gkeonprem_vmware_node_pool` resource into the root Terraform configuration. + + +### fn withAnnotations + +```ts +withAnnotations() +``` + +`google-beta.obj.withAnnotations` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the annotations field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `annotations` field. + + +### fn withConfig + +```ts +withConfig() +``` + +`google-beta.list[obj].withConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the 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-beta.list[obj].withConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `config` field. + + +### fn withConfigMixin + +```ts +withConfigMixin() +``` + +`google-beta.list[obj].withConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the 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-beta.list[obj].withConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `config` field. + + +### fn withDisplayName + +```ts +withDisplayName() +``` + +`google-beta.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 withLocation + +```ts +withLocation() +``` + +`google-beta.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-beta.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 withNodePoolAutoscaling + +```ts +withNodePoolAutoscaling() +``` + +`google-beta.list[obj].withNodePoolAutoscaling` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the node_pool_autoscaling 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-beta.list[obj].withNodePoolAutoscalingMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `node_pool_autoscaling` field. + + +### fn withNodePoolAutoscalingMixin + +```ts +withNodePoolAutoscalingMixin() +``` + +`google-beta.list[obj].withNodePoolAutoscalingMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the node_pool_autoscaling 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-beta.list[obj].withNodePoolAutoscaling](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `node_pool_autoscaling` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.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-beta.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-beta.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-beta.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-beta.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 withVmwareCluster + +```ts +withVmwareCluster() +``` + +`google-beta.string.withVmwareCluster` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the vmware_cluster field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `vmware_cluster` field. + + +## obj config + + + +### fn config.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_node_pool.config.new` constructs a new object with attributes and blocks configured for the `config` +Terraform sub block. + + + +**Args**: + - `boot_disk_size_gb` (`number`): VMware disk size to be used during creation. When `null`, the `boot_disk_size_gb` field will be omitted from the resulting object. + - `cpus` (`number`): The number of CPUs for each node in the node pool. When `null`, the `cpus` field will be omitted from the resulting object. + - `enable_load_balancer` (`bool`): Allow node pool traffic to be load balanced. Only works for clusters with +MetalLB load balancers. When `null`, the `enable_load_balancer` field will be omitted from the resulting object. + - `image` (`string`): The OS image name in vCenter, only valid when using Windows. When `null`, the `image` field will be omitted from the resulting object. + - `image_type` (`string`): The OS image to be used for each node in a node pool. +Currently 'cos', 'ubuntu', 'ubuntu_containerd' and 'windows' are supported. + - `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. +In case of conflict in label keys, the applied set may differ depending on +the Kubernetes version -- it's best to assume the behavior is undefined +and conflicts should be avoided. When `null`, the `labels` field will be omitted from the resulting object. + - `memory_mb` (`number`): The megabytes of memory for each node in the node pool. When `null`, the `memory_mb` field will be omitted from the resulting object. + - `replicas` (`number`): The number of nodes in the node pool. When `null`, the `replicas` field will be omitted from the resulting object. + - `taints` (`list[obj]`): The initial taints assigned to nodes of this node pool. When `null`, the `taints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gkeonprem_vmware_node_pool.config.taints.new](#fn-configtaintsnew) constructor. + +**Returns**: + - An attribute object that represents the `config` sub block. + + +## obj config.taints + + + +### fn config.taints.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_node_pool.config.taints.new` constructs a new object with attributes and blocks configured for the `taints` +Terraform sub block. + + + +**Args**: + - `effect` (`string`): Available taint effects. Possible values: ["EFFECT_UNSPECIFIED", "NO_SCHEDULE", "PREFER_NO_SCHEDULE", "NO_EXECUTE"] When `null`, the `effect` field will be omitted from the resulting object. + - `key` (`string`): Key associated with the effect. + - `value` (`string`): Value associated with the effect. + +**Returns**: + - An attribute object that represents the `taints` sub block. + + +## obj node_pool_autoscaling + + + +### fn node_pool_autoscaling.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_node_pool.node_pool_autoscaling.new` constructs a new object with attributes and blocks configured for the `node_pool_autoscaling` +Terraform sub block. + + + +**Args**: + - `max_replicas` (`number`): Maximum number of replicas in the NodePool. + - `min_replicas` (`number`): Minimum number of replicas in the NodePool. + +**Returns**: + - An attribute object that represents the `node_pool_autoscaling` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_gkeonprem_vmware_node_pool.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/google_healthcare_fhir_store.md b/docs/4.x/google_healthcare_fhir_store.md index cf91e47e..b8aa9fee 100644 --- a/docs/4.x/google_healthcare_fhir_store.md +++ b/docs/4.x/google_healthcare_fhir_store.md @@ -538,9 +538,9 @@ was published. Notifications are only sent if the topic is non-empty. Topic name project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail. - `send_full_resource` (`bool`): Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. -Note that setting this to true does not guarantee that all resources will be sent in the format of +Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be -sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether +sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. When `null`, the `send_full_resource` field will be omitted from the resulting object. **Returns**: diff --git a/docs/4.x/google_iam_workforce_pool.md b/docs/4.x/google_iam_workforce_pool.md index 757c4569..3f0c9fa9 100644 --- a/docs/4.x/google_iam_workforce_pool.md +++ b/docs/4.x/google_iam_workforce_pool.md @@ -63,7 +63,7 @@ or use existing tokens to access resources. If the pool is re-enabled, existing - `location` (`string`): The location for the resource. - `parent` (`string`): Immutable. The resource name of the parent. Format: 'organizations/{org-id}'. - `session_duration` (`string`): Duration that the Google Cloud access tokens, console sign-in sessions, -and 'gcloud' sign-in sessions from this pool are valid. +and 'gcloud' sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If 'sessionDuration' is not configured, minted credentials have a default duration of one hour (3600s). A duration in seconds with up to nine fractional digits, ending with ''s''. Example: "'3.5s'". When `null`, the `session_duration` field will be omitted from the resulting object. @@ -101,7 +101,7 @@ or use existing tokens to access resources. If the pool is re-enabled, existing - `location` (`string`): The location for the resource. - `parent` (`string`): Immutable. The resource name of the parent. Format: 'organizations/{org-id}'. - `session_duration` (`string`): Duration that the Google Cloud access tokens, console sign-in sessions, -and 'gcloud' sign-in sessions from this pool are valid. +and 'gcloud' sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If 'sessionDuration' is not configured, minted credentials have a default duration of one hour (3600s). A duration in seconds with up to nine fractional digits, ending with ''s''. Example: "'3.5s'". When `null`, the `session_duration` field will be omitted from the resulting object. diff --git a/docs/4.x/google_iam_workforce_pool_provider.md b/docs/4.x/google_iam_workforce_pool_provider.md index 18d5b77c..4ca0d752 100644 --- a/docs/4.x/google_iam_workforce_pool_provider.md +++ b/docs/4.x/google_iam_workforce_pool_provider.md @@ -578,9 +578,9 @@ The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. -3) For each signing key: - a) Valid from should be no more than 7 days from now. - b) Valid to should be no more than 10 years in the future. +3) For each signing key: + a) Valid from should be no more than 7 days from now. + b) Valid to should be no more than 10 years in the future. 4) Up to 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at least one non-expired signing key diff --git a/docs/4.x/google_identity_platform_project_default_config.md b/docs/4.x/google_identity_platform_project_default_config.md index 9f8de187..5009fd26 100644 --- a/docs/4.x/google_identity_platform_project_default_config.md +++ b/docs/4.x/google_identity_platform_project_default_config.md @@ -250,8 +250,8 @@ Terraform sub block. **Args**: - `enabled` (`bool`): Whether email auth is enabled for the project or not. When `null`, the `enabled` field will be omitted from the resulting object. - - `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 + - `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**: diff --git a/docs/4.x/google_kms_crypto_key.md b/docs/4.x/google_kms_crypto_key.md index 8f117a85..a6752a5f 100644 --- a/docs/4.x/google_kms_crypto_key.md +++ b/docs/4.x/google_kms_crypto_key.md @@ -75,7 +75,7 @@ for possible inputs. Default value: "ENCRYPT_DECRYPT" Possible values: [ The first rotation will take place after the specified period. The rotation period has the format of a decimal number with up to 9 fractional digits, followed by the letter 's' (seconds). It must be greater than a day (ie, 86400). When `null`, the `rotation_period` field will be omitted from the resulting object. - - `skip_initial_version_creation` (`bool`): If set to true, the request will create a CryptoKey without any CryptoKeyVersions. + - `skip_initial_version_creation` (`bool`): If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must use the 'google_kms_key_ring_import_job' resource to import the CryptoKeyVersion. When `null`, the `skip_initial_version_creation` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.timeouts.new](#fn-timeoutsnew) constructor. - `version_template` (`list[obj]`): A template describing settings for new crypto key versions. When `null`, the `version_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.version_template.new](#fn-version_templatenew) constructor. @@ -116,7 +116,7 @@ for possible inputs. Default value: "ENCRYPT_DECRYPT" Possible values: [ The first rotation will take place after the specified period. The rotation period has the format of a decimal number with up to 9 fractional digits, followed by the letter 's' (seconds). It must be greater than a day (ie, 86400). When `null`, the `rotation_period` field will be omitted from the resulting object. - - `skip_initial_version_creation` (`bool`): If set to true, the request will create a CryptoKey without any CryptoKeyVersions. + - `skip_initial_version_creation` (`bool`): If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must use the 'google_kms_key_ring_import_job' resource to import the CryptoKeyVersion. When `null`, the `skip_initial_version_creation` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.timeouts.new](#fn-timeoutsnew) constructor. - `version_template` (`list[obj]`): A template describing settings for new crypto key versions. When `null`, the `version_template` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_kms_crypto_key.version_template.new](#fn-version_templatenew) constructor. diff --git a/docs/4.x/google_logging_metric.md b/docs/4.x/google_logging_metric.md index 78363f8d..3a9dcc5d 100644 --- a/docs/4.x/google_logging_metric.md +++ b/docs/4.x/google_logging_metric.md @@ -518,8 +518,8 @@ Terraform sub block. **Args**: - - `display_name` (`string`): A concise name for the metric, which can be displayed in user interfaces. Use sentence case -without an ending period, for example "Request count". This field is optional but it is + - `display_name` (`string`): A concise name for the metric, which can be displayed in user interfaces. Use sentence case +without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. When `null`, the `display_name` field will be omitted from the resulting object. - `metric_kind` (`string`): Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metricKind and valueType might not be supported. diff --git a/docs/4.x/google_monitoring_service.md b/docs/4.x/google_monitoring_service.md index f7c194a6..d77365ba 100644 --- a/docs/4.x/google_monitoring_service.md +++ b/docs/4.x/google_monitoring_service.md @@ -267,9 +267,9 @@ Terraform sub block. **Args**: - - `service_labels` (`obj`): Labels that specify the resource that emits the monitoring data + - `service_labels` (`obj`): Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this 'Service'. When `null`, the `service_labels` field will be omitted from the resulting object. - - `service_type` (`string`): The type of service that this basic service defines, e.g. + - `service_type` (`string`): The type of service that this basic service defines, e.g. APP_ENGINE service type When `null`, the `service_type` field will be omitted from the resulting object. **Returns**: diff --git a/docs/4.x/google_network_security_address_group.md b/docs/4.x/google_network_security_address_group.md new file mode 100644 index 00000000..d923c135 --- /dev/null +++ b/docs/4.x/google_network_security_address_group.md @@ -0,0 +1,296 @@ +--- +permalink: /google_network_security_address_group/ +--- + +# google_network_security_address_group + +`google_network_security_address_group` represents the `google-beta_google_network_security_address_group` 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 withCapacity()`](#fn-withcapacity) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withItems()`](#fn-withitems) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withName()`](#fn-withname) +* [`fn withParent()`](#fn-withparent) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withType()`](#fn-withtype) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_network_security_address_group.new` injects a new `google-beta_google_network_security_address_group` 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-beta.google_network_security_address_group.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_network_security_address_group` using the reference: + + $._ref.google-beta_google_network_security_address_group.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_network_security_address_group.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. + - `capacity` (`number`): Capacity of the Address Group. + - `description` (`string`): Free-text description of the resource. When `null`, the `description` field will be omitted from the resulting object. + - `items` (`list`): List of items. When `null`, the `items` field will be omitted from the resulting object. + - `labels` (`obj`): Set of label tags associated with the AddressGroup resource. +An object containing 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 location of the gateway security policy. +The default value is 'global'. + - `name` (`string`): Name of the AddressGroup resource. + - `parent` (`string`): The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}. When `null`, the `parent` field will be omitted from the resulting object. + - `type` (`string`): The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values: ["IPV4", "IPV6"] + - `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-beta.google_network_security_address_group.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_network_security_address_group.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_security_address_group` +Terraform resource. + +Unlike [google-beta.google_network_security_address_group.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**: + - `capacity` (`number`): Capacity of the Address Group. + - `description` (`string`): Free-text description of the resource. When `null`, the `description` field will be omitted from the resulting object. + - `items` (`list`): List of items. When `null`, the `items` field will be omitted from the resulting object. + - `labels` (`obj`): Set of label tags associated with the AddressGroup resource. +An object containing 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 location of the gateway security policy. +The default value is 'global'. + - `name` (`string`): Name of the AddressGroup resource. + - `parent` (`string`): The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}. When `null`, the `parent` field will be omitted from the resulting object. + - `type` (`string`): The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values: ["IPV4", "IPV6"] + - `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-beta.google_network_security_address_group.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 `google_network_security_address_group` resource into the root Terraform configuration. + + +### fn withCapacity + +```ts +withCapacity() +``` + +`google-beta.number.withCapacity` constructs a mixin object that can be merged into the `number` +Terraform resource block to set or update the capacity field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`number`): The value to set for the `capacity` field. + + +### fn withDescription + +```ts +withDescription() +``` + +`google-beta.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 withItems + +```ts +withItems() +``` + +`google-beta.list.withItems` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the items field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `items` field. + + +### fn withLabels + +```ts +withLabels() +``` + +`google-beta.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-beta.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-beta.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 withParent + +```ts +withParent() +``` + +`google-beta.string.withParent` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the parent field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `parent` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.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-beta.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-beta.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-beta.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withType + +```ts +withType() +``` + +`google-beta.string.withType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `type` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_network_security_address_group.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/google_network_security_authorization_policy.md b/docs/4.x/google_network_security_authorization_policy.md new file mode 100644 index 00000000..97edc1c6 --- /dev/null +++ b/docs/4.x/google_network_security_authorization_policy.md @@ -0,0 +1,410 @@ +--- +permalink: /google_network_security_authorization_policy/ +--- + +# google_network_security_authorization_policy + +`google_network_security_authorization_policy` represents the `google-beta_google_network_security_authorization_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 withAction()`](#fn-withaction) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withRules()`](#fn-withrules) +* [`fn withRulesMixin()`](#fn-withrulesmixin) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj rules`](#obj-rules) + * [`fn new()`](#fn-rulesnew) + * [`obj rules.destinations`](#obj-rulesdestinations) + * [`fn new()`](#fn-rulesdestinationsnew) + * [`obj rules.destinations.http_header_match`](#obj-rulesdestinationshttp_header_match) + * [`fn new()`](#fn-rulesdestinationshttp_header_matchnew) + * [`obj rules.sources`](#obj-rulessources) + * [`fn new()`](#fn-rulessourcesnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_network_security_authorization_policy.new` injects a new `google-beta_google_network_security_authorization_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-beta.google_network_security_authorization_policy.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_network_security_authorization_policy` using the reference: + + $._ref.google-beta_google_network_security_authorization_policy.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_network_security_authorization_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. + - `action` (`string`): The action to take when a rule match is found. Possible values are "ALLOW" or "DENY". Possible values: ["ALLOW", "DENY"] + - `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`): Set of label tags associated with the AuthorizationPolicy resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The location of the authorization policy. +The default value is 'global'. When `null`, the `location` field will be omitted from the resulting object. + - `name` (`string`): Name of the AuthorizationPolicy resource. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `rules` (`list[obj]`): List of rules to match. Note that at least one of the rules must match in order for the action specified in the 'action' field to be taken. +A rule is a match if there is a matching source and destination. If left blank, the action specified in the action field will be applied on every request. When `null`, the `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-beta.google_network_security_authorization_policy.rules.new](#fn-rulesnew) 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-beta.google_network_security_authorization_policy.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_network_security_authorization_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_security_authorization_policy` +Terraform resource. + +Unlike [google-beta.google_network_security_authorization_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**: + - `action` (`string`): The action to take when a rule match is found. Possible values are "ALLOW" or "DENY". Possible values: ["ALLOW", "DENY"] + - `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`): Set of label tags associated with the AuthorizationPolicy resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The location of the authorization policy. +The default value is 'global'. When `null`, the `location` field will be omitted from the resulting object. + - `name` (`string`): Name of the AuthorizationPolicy resource. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `rules` (`list[obj]`): List of rules to match. Note that at least one of the rules must match in order for the action specified in the 'action' field to be taken. +A rule is a match if there is a matching source and destination. If left blank, the action specified in the action field will be applied on every request. When `null`, the `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-beta.google_network_security_authorization_policy.rules.new](#fn-rulesnew) 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-beta.google_network_security_authorization_policy.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_network_security_authorization_policy` resource into the root Terraform configuration. + + +### fn withAction + +```ts +withAction() +``` + +`google-beta.string.withAction` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the action field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `action` field. + + +### fn withDescription + +```ts +withDescription() +``` + +`google-beta.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-beta.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-beta.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-beta.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-beta.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 withRules + +```ts +withRules() +``` + +`google-beta.list[obj].withRules` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the rules 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-beta.list[obj].withRulesMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `rules` field. + + +### fn withRulesMixin + +```ts +withRulesMixin() +``` + +`google-beta.list[obj].withRulesMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the rules 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-beta.list[obj].withRules](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `rules` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.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-beta.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-beta.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-beta.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 rules + + + +### fn rules.new + +```ts +new() +``` + + +`google-beta.google_network_security_authorization_policy.rules.new` constructs a new object with attributes and blocks configured for the `rules` +Terraform sub block. + + + +**Args**: + - `destinations` (`list[obj]`): List of attributes for the traffic destination. All of the destinations must match. A destination is a match if a request matches all the specified hosts, ports, methods and headers. +If not set, the action specified in the 'action' field will be applied without any rule checks for the destination. When `null`, the `destinations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_authorization_policy.rules.destinations.new](#fn-rulesdestinationsnew) constructor. + - `sources` (`list[obj]`): List of attributes for the traffic source. All of the sources must match. A source is a match if both principals and ipBlocks match. +If not set, the action specified in the 'action' field will be applied without any rule checks for the source. When `null`, the `sources` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_authorization_policy.rules.sources.new](#fn-rulessourcesnew) constructor. + +**Returns**: + - An attribute object that represents the `rules` sub block. + + +## obj rules.destinations + + + +### fn rules.destinations.new + +```ts +new() +``` + + +`google-beta.google_network_security_authorization_policy.rules.destinations.new` constructs a new object with attributes and blocks configured for the `destinations` +Terraform sub block. + + + +**Args**: + - `hosts` (`list`): List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example "*.myorg.com") or a presence (any) match "*". + - `methods` (`list`): A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services. + - `ports` (`list`): List of destination ports to match. At least one port should match. + - `http_header_match` (`list[obj]`): Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. +Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. When `null`, the `http_header_match` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_authorization_policy.rules.destinations.http_header_match.new](#fn-rulesruleshttp_header_matchnew) constructor. + +**Returns**: + - An attribute object that represents the `destinations` sub block. + + +## obj rules.destinations.http_header_match + + + +### fn rules.destinations.http_header_match.new + +```ts +new() +``` + + +`google-beta.google_network_security_authorization_policy.rules.destinations.http_header_match.new` constructs a new object with attributes and blocks configured for the `http_header_match` +Terraform sub block. + + + +**Args**: + - `header_name` (`string`): The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". + - `regex_match` (`string`): The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier. + +**Returns**: + - An attribute object that represents the `http_header_match` sub block. + + +## obj rules.sources + + + +### fn rules.sources.new + +```ts +new() +``` + + +`google-beta.google_network_security_authorization_policy.rules.sources.new` constructs a new object with attributes and blocks configured for the `sources` +Terraform sub block. + + + +**Args**: + - `ip_blocks` (`list`): List of CIDR ranges to match based on source IP address. At least one IP block should match. Single IP (e.g., "1.2.3.4") and CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on source IP alone should be avoided. +The IP addresses of any load balancers or proxies should be considered untrusted. When `null`, the `ip_blocks` field will be omitted from the resulting object. + - `principals` (`list`): List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, "*/service-account") or a presence match "*". +Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. When `null`, the `principals` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `sources` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_network_security_authorization_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `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/google_network_security_client_tls_policy.md b/docs/4.x/google_network_security_client_tls_policy.md new file mode 100644 index 00000000..f8ecb902 --- /dev/null +++ b/docs/4.x/google_network_security_client_tls_policy.md @@ -0,0 +1,490 @@ +--- +permalink: /google_network_security_client_tls_policy/ +--- + +# google_network_security_client_tls_policy + +`google_network_security_client_tls_policy` represents the `google-beta_google_network_security_client_tls_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 withClientCertificate()`](#fn-withclientcertificate) +* [`fn withClientCertificateMixin()`](#fn-withclientcertificatemixin) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withServerValidationCa()`](#fn-withservervalidationca) +* [`fn withServerValidationCaMixin()`](#fn-withservervalidationcamixin) +* [`fn withSni()`](#fn-withsni) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj client_certificate`](#obj-client_certificate) + * [`fn new()`](#fn-client_certificatenew) + * [`obj client_certificate.certificate_provider_instance`](#obj-client_certificatecertificate_provider_instance) + * [`fn new()`](#fn-client_certificatecertificate_provider_instancenew) + * [`obj client_certificate.grpc_endpoint`](#obj-client_certificategrpc_endpoint) + * [`fn new()`](#fn-client_certificategrpc_endpointnew) +* [`obj server_validation_ca`](#obj-server_validation_ca) + * [`fn new()`](#fn-server_validation_canew) + * [`obj server_validation_ca.certificate_provider_instance`](#obj-server_validation_cacertificate_provider_instance) + * [`fn new()`](#fn-server_validation_cacertificate_provider_instancenew) + * [`obj server_validation_ca.grpc_endpoint`](#obj-server_validation_cagrpc_endpoint) + * [`fn new()`](#fn-server_validation_cagrpc_endpointnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_network_security_client_tls_policy.new` injects a new `google-beta_google_network_security_client_tls_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-beta.google_network_security_client_tls_policy.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_network_security_client_tls_policy` using the reference: + + $._ref.google-beta_google_network_security_client_tls_policy.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_network_security_client_tls_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. + - `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`): Set of label tags associated with the ClientTlsPolicy resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The location of the client tls policy. +The default value is 'global'. When `null`, the `location` field will be omitted from the resulting object. + - `name` (`string`): Name of the ClientTlsPolicy resource. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `sni` (`string`): Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com". When `null`, the `sni` field will be omitted from the resulting object. + - `client_certificate` (`list[obj]`): Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. When `null`, the `client_certificate` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.client_certificate.new](#fn-client_certificatenew) constructor. + - `server_validation_ca` (`list[obj]`): Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. When `null`, the `server_validation_ca` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.server_validation_ca.new](#fn-server_validation_canew) 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-beta.google_network_security_client_tls_policy.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_network_security_client_tls_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_security_client_tls_policy` +Terraform resource. + +Unlike [google-beta.google_network_security_client_tls_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**: + - `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`): Set of label tags associated with the ClientTlsPolicy resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The location of the client tls policy. +The default value is 'global'. When `null`, the `location` field will be omitted from the resulting object. + - `name` (`string`): Name of the ClientTlsPolicy resource. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `sni` (`string`): Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com". When `null`, the `sni` field will be omitted from the resulting object. + - `client_certificate` (`list[obj]`): Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. When `null`, the `client_certificate` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.client_certificate.new](#fn-client_certificatenew) constructor. + - `server_validation_ca` (`list[obj]`): Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. When `null`, the `server_validation_ca` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.server_validation_ca.new](#fn-server_validation_canew) 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-beta.google_network_security_client_tls_policy.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_network_security_client_tls_policy` resource into the root Terraform configuration. + + +### fn withClientCertificate + +```ts +withClientCertificate() +``` + +`google-beta.list[obj].withClientCertificate` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the client_certificate 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-beta.list[obj].withClientCertificateMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `client_certificate` field. + + +### fn withClientCertificateMixin + +```ts +withClientCertificateMixin() +``` + +`google-beta.list[obj].withClientCertificateMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the client_certificate 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-beta.list[obj].withClientCertificate](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `client_certificate` field. + + +### fn withDescription + +```ts +withDescription() +``` + +`google-beta.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-beta.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-beta.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-beta.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-beta.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 withServerValidationCa + +```ts +withServerValidationCa() +``` + +`google-beta.list[obj].withServerValidationCa` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the server_validation_ca 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-beta.list[obj].withServerValidationCaMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `server_validation_ca` field. + + +### fn withServerValidationCaMixin + +```ts +withServerValidationCaMixin() +``` + +`google-beta.list[obj].withServerValidationCaMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the server_validation_ca 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-beta.list[obj].withServerValidationCa](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `server_validation_ca` field. + + +### fn withSni + +```ts +withSni() +``` + +`google-beta.string.withSni` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the sni field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `sni` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.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-beta.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-beta.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-beta.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 client_certificate + + + +### fn client_certificate.new + +```ts +new() +``` + + +`google-beta.google_network_security_client_tls_policy.client_certificate.new` constructs a new object with attributes and blocks configured for the `client_certificate` +Terraform sub block. + + + +**Args**: + - `certificate_provider_instance` (`list[obj]`): The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. When `null`, the `certificate_provider_instance` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.client_certificate.certificate_provider_instance.new](#fn-client_certificatecertificate_provider_instancenew) constructor. + - `grpc_endpoint` (`list[obj]`): gRPC specific configuration to access the gRPC server to obtain the cert and private key. When `null`, the `grpc_endpoint` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.client_certificate.grpc_endpoint.new](#fn-client_certificategrpc_endpointnew) constructor. + +**Returns**: + - An attribute object that represents the `client_certificate` sub block. + + +## obj client_certificate.certificate_provider_instance + + + +### fn client_certificate.certificate_provider_instance.new + +```ts +new() +``` + + +`google-beta.google_network_security_client_tls_policy.client_certificate.certificate_provider_instance.new` constructs a new object with attributes and blocks configured for the `certificate_provider_instance` +Terraform sub block. + + + +**Args**: + - `plugin_instance` (`string`): Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. + +**Returns**: + - An attribute object that represents the `certificate_provider_instance` sub block. + + +## obj client_certificate.grpc_endpoint + + + +### fn client_certificate.grpc_endpoint.new + +```ts +new() +``` + + +`google-beta.google_network_security_client_tls_policy.client_certificate.grpc_endpoint.new` constructs a new object with attributes and blocks configured for the `grpc_endpoint` +Terraform sub block. + + + +**Args**: + - `target_uri` (`string`): The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". + +**Returns**: + - An attribute object that represents the `grpc_endpoint` sub block. + + +## obj server_validation_ca + + + +### fn server_validation_ca.new + +```ts +new() +``` + + +`google-beta.google_network_security_client_tls_policy.server_validation_ca.new` constructs a new object with attributes and blocks configured for the `server_validation_ca` +Terraform sub block. + + + +**Args**: + - `certificate_provider_instance` (`list[obj]`): The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. When `null`, the `certificate_provider_instance` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.server_validation_ca.certificate_provider_instance.new](#fn-server_validation_cacertificate_provider_instancenew) constructor. + - `grpc_endpoint` (`list[obj]`): gRPC specific configuration to access the gRPC server to obtain the cert and private key. When `null`, the `grpc_endpoint` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_client_tls_policy.server_validation_ca.grpc_endpoint.new](#fn-server_validation_cagrpc_endpointnew) constructor. + +**Returns**: + - An attribute object that represents the `server_validation_ca` sub block. + + +## obj server_validation_ca.certificate_provider_instance + + + +### fn server_validation_ca.certificate_provider_instance.new + +```ts +new() +``` + + +`google-beta.google_network_security_client_tls_policy.server_validation_ca.certificate_provider_instance.new` constructs a new object with attributes and blocks configured for the `certificate_provider_instance` +Terraform sub block. + + + +**Args**: + - `plugin_instance` (`string`): Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. + +**Returns**: + - An attribute object that represents the `certificate_provider_instance` sub block. + + +## obj server_validation_ca.grpc_endpoint + + + +### fn server_validation_ca.grpc_endpoint.new + +```ts +new() +``` + + +`google-beta.google_network_security_client_tls_policy.server_validation_ca.grpc_endpoint.new` constructs a new object with attributes and blocks configured for the `grpc_endpoint` +Terraform sub block. + + + +**Args**: + - `target_uri` (`string`): The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". + +**Returns**: + - An attribute object that represents the `grpc_endpoint` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_network_security_client_tls_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `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/google_network_security_gateway_security_policy_rule.md b/docs/4.x/google_network_security_gateway_security_policy_rule.md index dde1d3d0..a6111e5e 100644 --- a/docs/4.x/google_network_security_gateway_security_policy_rule.md +++ b/docs/4.x/google_network_security_gateway_security_policy_rule.md @@ -71,7 +71,7 @@ rule should match the pattern: (^a-z?$). - `priority` (`number`): Priority of the rule. Lower number corresponds to higher precedence. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `session_matcher` (`string`): CEL expression for matching on session criteria. - - `tls_inspection_enabled` (`bool`): Flag to enable TLS inspection of traffic matching on. Can only be true if the + - `tls_inspection_enabled` (`bool`): Flag to enable TLS inspection of traffic matching on. Can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig. When `null`, the `tls_inspection_enabled` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_gateway_security_policy_rule.timeouts.new](#fn-timeoutsnew) constructor. @@ -108,7 +108,7 @@ rule should match the pattern: (^a-z?$). - `priority` (`number`): Priority of the rule. Lower number corresponds to higher precedence. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `session_matcher` (`string`): CEL expression for matching on session criteria. - - `tls_inspection_enabled` (`bool`): Flag to enable TLS inspection of traffic matching on. Can only be true if the + - `tls_inspection_enabled` (`bool`): Flag to enable TLS inspection of traffic matching on. Can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig. When `null`, the `tls_inspection_enabled` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_security_gateway_security_policy_rule.timeouts.new](#fn-timeoutsnew) constructor. diff --git a/docs/4.x/google_network_services_endpoint_policy.md b/docs/4.x/google_network_services_endpoint_policy.md new file mode 100644 index 00000000..c9465cad --- /dev/null +++ b/docs/4.x/google_network_services_endpoint_policy.md @@ -0,0 +1,476 @@ +--- +permalink: /google_network_services_endpoint_policy/ +--- + +# google_network_services_endpoint_policy + +`google_network_services_endpoint_policy` represents the `google-beta_google_network_services_endpoint_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 withAuthorizationPolicy()`](#fn-withauthorizationpolicy) +* [`fn withClientTlsPolicy()`](#fn-withclienttlspolicy) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withEndpointMatcher()`](#fn-withendpointmatcher) +* [`fn withEndpointMatcherMixin()`](#fn-withendpointmatchermixin) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withServerTlsPolicy()`](#fn-withservertlspolicy) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withTrafficPortSelector()`](#fn-withtrafficportselector) +* [`fn withTrafficPortSelectorMixin()`](#fn-withtrafficportselectormixin) +* [`fn withType()`](#fn-withtype) +* [`obj endpoint_matcher`](#obj-endpoint_matcher) + * [`fn new()`](#fn-endpoint_matchernew) + * [`obj endpoint_matcher.metadata_label_matcher`](#obj-endpoint_matchermetadata_label_matcher) + * [`fn new()`](#fn-endpoint_matchermetadata_label_matchernew) + * [`obj endpoint_matcher.metadata_label_matcher.metadata_labels`](#obj-endpoint_matchermetadata_label_matchermetadata_labels) + * [`fn new()`](#fn-endpoint_matchermetadata_label_matchermetadata_labelsnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) +* [`obj traffic_port_selector`](#obj-traffic_port_selector) + * [`fn new()`](#fn-traffic_port_selectornew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_network_services_endpoint_policy.new` injects a new `google-beta_google_network_services_endpoint_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-beta.google_network_services_endpoint_policy.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_network_services_endpoint_policy` using the reference: + + $._ref.google-beta_google_network_services_endpoint_policy.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_network_services_endpoint_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. + - `authorization_policy` (`string`): This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. When `null`, the `authorization_policy` field will be omitted from the resulting object. + - `client_tls_policy` (`string`): A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. When `null`, the `client_tls_policy` field will be omitted from the resulting object. + - `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`): Set of label tags associated with the TcpRoute resource. When `null`, the `labels` field will be omitted from the resulting object. + - `name` (`string`): Name of the EndpointPolicy resource. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `server_tls_policy` (`string`): A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. When `null`, the `server_tls_policy` field will be omitted from the resulting object. + - `type` (`string`): The type of endpoint policy. This is primarily used to validate the configuration. Possible values: ["SIDECAR_PROXY", "GRPC_SERVER"] + - `endpoint_matcher` (`list[obj]`): Required. A matcher that selects endpoints to which the policies should be applied. When `null`, the `endpoint_matcher` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_endpoint_policy.endpoint_matcher.new](#fn-endpoint_matchernew) 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-beta.google_network_services_endpoint_policy.timeouts.new](#fn-timeoutsnew) constructor. + - `traffic_port_selector` (`list[obj]`): Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports. When `null`, the `traffic_port_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-beta.google_network_services_endpoint_policy.traffic_port_selector.new](#fn-traffic_port_selectornew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_network_services_endpoint_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_endpoint_policy` +Terraform resource. + +Unlike [google-beta.google_network_services_endpoint_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**: + - `authorization_policy` (`string`): This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. When `null`, the `authorization_policy` field will be omitted from the resulting object. + - `client_tls_policy` (`string`): A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. When `null`, the `client_tls_policy` field will be omitted from the resulting object. + - `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`): Set of label tags associated with the TcpRoute resource. When `null`, the `labels` field will be omitted from the resulting object. + - `name` (`string`): Name of the EndpointPolicy resource. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `server_tls_policy` (`string`): A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. When `null`, the `server_tls_policy` field will be omitted from the resulting object. + - `type` (`string`): The type of endpoint policy. This is primarily used to validate the configuration. Possible values: ["SIDECAR_PROXY", "GRPC_SERVER"] + - `endpoint_matcher` (`list[obj]`): Required. A matcher that selects endpoints to which the policies should be applied. When `null`, the `endpoint_matcher` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_endpoint_policy.endpoint_matcher.new](#fn-endpoint_matchernew) 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-beta.google_network_services_endpoint_policy.timeouts.new](#fn-timeoutsnew) constructor. + - `traffic_port_selector` (`list[obj]`): Port selector for the (matched) endpoints. If no port selector is provided, the matched config is applied to all ports. When `null`, the `traffic_port_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-beta.google_network_services_endpoint_policy.traffic_port_selector.new](#fn-traffic_port_selectornew) 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 `google_network_services_endpoint_policy` resource into the root Terraform configuration. + + +### fn withAuthorizationPolicy + +```ts +withAuthorizationPolicy() +``` + +`google-beta.string.withAuthorizationPolicy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the authorization_policy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `authorization_policy` field. + + +### fn withClientTlsPolicy + +```ts +withClientTlsPolicy() +``` + +`google-beta.string.withClientTlsPolicy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the client_tls_policy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `client_tls_policy` field. + + +### fn withDescription + +```ts +withDescription() +``` + +`google-beta.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 withEndpointMatcher + +```ts +withEndpointMatcher() +``` + +`google-beta.list[obj].withEndpointMatcher` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the endpoint_matcher 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-beta.list[obj].withEndpointMatcherMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `endpoint_matcher` field. + + +### fn withEndpointMatcherMixin + +```ts +withEndpointMatcherMixin() +``` + +`google-beta.list[obj].withEndpointMatcherMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the endpoint_matcher 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-beta.list[obj].withEndpointMatcher](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `endpoint_matcher` field. + + +### fn withLabels + +```ts +withLabels() +``` + +`google-beta.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 withName + +```ts +withName() +``` + +`google-beta.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-beta.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 withServerTlsPolicy + +```ts +withServerTlsPolicy() +``` + +`google-beta.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 withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.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-beta.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-beta.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-beta.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 withTrafficPortSelector + +```ts +withTrafficPortSelector() +``` + +`google-beta.list[obj].withTrafficPortSelector` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the traffic_port_selector 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-beta.list[obj].withTrafficPortSelectorMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `traffic_port_selector` field. + + +### fn withTrafficPortSelectorMixin + +```ts +withTrafficPortSelectorMixin() +``` + +`google-beta.list[obj].withTrafficPortSelectorMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the traffic_port_selector 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-beta.list[obj].withTrafficPortSelector](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `traffic_port_selector` field. + + +### fn withType + +```ts +withType() +``` + +`google-beta.string.withType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `type` field. + + +## obj endpoint_matcher + + + +### fn endpoint_matcher.new + +```ts +new() +``` + + +`google-beta.google_network_services_endpoint_policy.endpoint_matcher.new` constructs a new object with attributes and blocks configured for the `endpoint_matcher` +Terraform sub block. + + + +**Args**: + - `metadata_label_matcher` (`list[obj]`): The matcher is based on node metadata presented by xDS clients. When `null`, the `metadata_label_matcher` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_endpoint_policy.endpoint_matcher.metadata_label_matcher.new](#fn-endpoint_matchermetadata_label_matchernew) constructor. + +**Returns**: + - An attribute object that represents the `endpoint_matcher` sub block. + + +## obj endpoint_matcher.metadata_label_matcher + + + +### fn endpoint_matcher.metadata_label_matcher.new + +```ts +new() +``` + + +`google-beta.google_network_services_endpoint_policy.endpoint_matcher.metadata_label_matcher.new` constructs a new object with attributes and blocks configured for the `metadata_label_matcher` +Terraform sub block. + + + +**Args**: + - `metadata_label_match_criteria` (`string`): Specifies how matching should be done. Possible values: ["MATCH_ANY", "MATCH_ALL"] + - `metadata_labels` (`list[obj]`): The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria When `null`, the `metadata_labels` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_endpoint_policy.endpoint_matcher.metadata_label_matcher.metadata_labels.new](#fn-endpoint_matcherendpoint_matchermetadata_labelsnew) constructor. + +**Returns**: + - An attribute object that represents the `metadata_label_matcher` sub block. + + +## obj endpoint_matcher.metadata_label_matcher.metadata_labels + + + +### fn endpoint_matcher.metadata_label_matcher.metadata_labels.new + +```ts +new() +``` + + +`google-beta.google_network_services_endpoint_policy.endpoint_matcher.metadata_label_matcher.metadata_labels.new` constructs a new object with attributes and blocks configured for the `metadata_labels` +Terraform sub block. + + + +**Args**: + - `label_name` (`string`): Required. Label name presented as key in xDS Node Metadata. + - `label_value` (`string`): Required. Label value presented as value corresponding to the above key, in xDS Node Metadata. + +**Returns**: + - An attribute object that represents the `metadata_labels` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_network_services_endpoint_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `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. + + +## obj traffic_port_selector + + + +### fn traffic_port_selector.new + +```ts +new() +``` + + +`google-beta.google_network_services_endpoint_policy.traffic_port_selector.new` constructs a new object with attributes and blocks configured for the `traffic_port_selector` +Terraform sub block. + + + +**Args**: + - `ports` (`list`): List of ports. Can be port numbers or port range (example, [80-90] specifies all ports from 80 to 90, including 80 and 90) or named ports or * to specify all ports. If the list is empty, all ports are selected. + +**Returns**: + - An attribute object that represents the `traffic_port_selector` sub block. diff --git a/docs/4.x/google_network_services_gateway.md b/docs/4.x/google_network_services_gateway.md index e663578e..cca57808 100644 --- a/docs/4.x/google_network_services_gateway.md +++ b/docs/4.x/google_network_services_gateway.md @@ -64,12 +64,12 @@ or `$` to refer to the root object. Instead, make an explicit outer object using The default value is 'global'. When `null`, the `location` field will be omitted from the resulting object. - `name` (`string`): Short name of the Gateway resource to be created. - `ports` (`list`): One or more port numbers (1-65535), on which the Gateway will receive traffic. -The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are +The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 and support multiple ports. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `scope` (`string`): Immutable. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as -a single coniguration to the proxy/load balancer. +a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. - `server_tls_policy` (`string`): A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. When `null`, the `server_tls_policy` field will be omitted from the resulting object. @@ -104,12 +104,12 @@ injecting into a complete block. The default value is 'global'. When `null`, the `location` field will be omitted from the resulting object. - `name` (`string`): Short name of the Gateway resource to be created. - `ports` (`list`): One or more port numbers (1-65535), on which the Gateway will receive traffic. -The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are +The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 and support multiple ports. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `scope` (`string`): Immutable. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as -a single coniguration to the proxy/load balancer. +a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. - `server_tls_policy` (`string`): A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. When `null`, the `server_tls_policy` field will be omitted from the resulting object. diff --git a/docs/4.x/google_network_services_grpc_route.md b/docs/4.x/google_network_services_grpc_route.md new file mode 100644 index 00000000..cd1088e9 --- /dev/null +++ b/docs/4.x/google_network_services_grpc_route.md @@ -0,0 +1,578 @@ +--- +permalink: /google_network_services_grpc_route/ +--- + +# google_network_services_grpc_route + +`google_network_services_grpc_route` represents the `google-beta_google_network_services_grpc_route` 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 withGateways()`](#fn-withgateways) +* [`fn withHostnames()`](#fn-withhostnames) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withMeshes()`](#fn-withmeshes) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withRules()`](#fn-withrules) +* [`fn withRulesMixin()`](#fn-withrulesmixin) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj rules`](#obj-rules) + * [`fn new()`](#fn-rulesnew) + * [`obj rules.action`](#obj-rulesaction) + * [`fn new()`](#fn-rulesactionnew) + * [`obj rules.action.destinations`](#obj-rulesactiondestinations) + * [`fn new()`](#fn-rulesactiondestinationsnew) + * [`obj rules.action.fault_injection_policy`](#obj-rulesactionfault_injection_policy) + * [`fn new()`](#fn-rulesactionfault_injection_policynew) + * [`obj rules.action.fault_injection_policy.abort`](#obj-rulesactionfault_injection_policyabort) + * [`fn new()`](#fn-rulesactionfault_injection_policyabortnew) + * [`obj rules.action.fault_injection_policy.delay`](#obj-rulesactionfault_injection_policydelay) + * [`fn new()`](#fn-rulesactionfault_injection_policydelaynew) + * [`obj rules.action.retry_policy`](#obj-rulesactionretry_policy) + * [`fn new()`](#fn-rulesactionretry_policynew) + * [`obj rules.matches`](#obj-rulesmatches) + * [`fn new()`](#fn-rulesmatchesnew) + * [`obj rules.matches.headers`](#obj-rulesmatchesheaders) + * [`fn new()`](#fn-rulesmatchesheadersnew) + * [`obj rules.matches.method`](#obj-rulesmatchesmethod) + * [`fn new()`](#fn-rulesmatchesmethodnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.new` injects a new `google-beta_google_network_services_grpc_route` 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-beta.google_network_services_grpc_route.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_network_services_grpc_route` using the reference: + + $._ref.google-beta_google_network_services_grpc_route.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_network_services_grpc_route.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. + - `gateways` (`list`): List of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. When `null`, the `gateways` field will be omitted from the resulting object. + - `hostnames` (`list`): Required. Service hostnames with an optional port for which this route describes traffic. + - `labels` (`obj`): Set of label tags associated with the GrpcRoute resource. When `null`, the `labels` field will be omitted from the resulting object. + - `meshes` (`list`): List of meshes this GrpcRoute is attached to, as one of the routing rules to route the requests served by the mesh. When `null`, the `meshes` field will be omitted from the resulting object. + - `name` (`string`): Name of the GrpcRoute resource. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. When `null`, the `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-beta.google_network_services_grpc_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_grpc_route.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_network_services_grpc_route.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_grpc_route` +Terraform resource. + +Unlike [google-beta.google_network_services_grpc_route.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. + - `gateways` (`list`): List of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. When `null`, the `gateways` field will be omitted from the resulting object. + - `hostnames` (`list`): Required. Service hostnames with an optional port for which this route describes traffic. + - `labels` (`obj`): Set of label tags associated with the GrpcRoute resource. When `null`, the `labels` field will be omitted from the resulting object. + - `meshes` (`list`): List of meshes this GrpcRoute is attached to, as one of the routing rules to route the requests served by the mesh. When `null`, the `meshes` field will be omitted from the resulting object. + - `name` (`string`): Name of the GrpcRoute resource. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. When `null`, the `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-beta.google_network_services_grpc_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_grpc_route.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 `google_network_services_grpc_route` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`google-beta.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 withGateways + +```ts +withGateways() +``` + +`google-beta.list.withGateways` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the gateways field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `gateways` field. + + +### fn withHostnames + +```ts +withHostnames() +``` + +`google-beta.list.withHostnames` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the hostnames field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `hostnames` field. + + +### fn withLabels + +```ts +withLabels() +``` + +`google-beta.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 withMeshes + +```ts +withMeshes() +``` + +`google-beta.list.withMeshes` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the meshes field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `meshes` field. + + +### fn withName + +```ts +withName() +``` + +`google-beta.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-beta.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 withRules + +```ts +withRules() +``` + +`google-beta.list[obj].withRules` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the rules 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-beta.list[obj].withRulesMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `rules` field. + + +### fn withRulesMixin + +```ts +withRulesMixin() +``` + +`google-beta.list[obj].withRulesMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the rules 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-beta.list[obj].withRules](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `rules` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.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-beta.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-beta.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-beta.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 rules + + + +### fn rules.new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.rules.new` constructs a new object with attributes and blocks configured for the `rules` +Terraform sub block. + + + +**Args**: + - `action` (`list[obj]`): Required. A detailed rule defining how to route traffic. When `null`, the `action` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.action.new](#fn-rulesactionnew) constructor. + - `matches` (`list[obj]`): Matches define conditions used for matching the rule against incoming gRPC requests. When `null`, the `matches` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.matches.new](#fn-rulesmatchesnew) constructor. + +**Returns**: + - An attribute object that represents the `rules` sub block. + + +## obj rules.action + + + +### fn rules.action.new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.rules.action.new` constructs a new object with attributes and blocks configured for the `action` +Terraform sub block. + + + +**Args**: + - `timeout` (`string`): Specifies the timeout for selected route. When `null`, the `timeout` field will be omitted from the resulting object. + - `destinations` (`list[obj]`): The destination to which traffic should be forwarded. When `null`, the `destinations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.action.destinations.new](#fn-rulesrulesdestinationsnew) constructor. + - `fault_injection_policy` (`list[obj]`): The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. When `null`, the `fault_injection_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-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.new](#fn-rulesrulesfault_injection_policynew) constructor. + - `retry_policy` (`list[obj]`): Specifies the retry policy associated with this route. When `null`, the `retry_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-beta.google_network_services_grpc_route.rules.action.retry_policy.new](#fn-rulesrulesretry_policynew) constructor. + +**Returns**: + - An attribute object that represents the `action` sub block. + + +## obj rules.action.destinations + + + +### fn rules.action.destinations.new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.rules.action.destinations.new` constructs a new object with attributes and blocks configured for the `destinations` +Terraform sub block. + + + +**Args**: + - `service_name` (`string`): The URL of a BackendService to route traffic to. When `null`, the `service_name` field will be omitted from the resulting object. + - `weight` (`number`): Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. When `null`, the `weight` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `destinations` sub block. + + +## obj rules.action.fault_injection_policy + + + +### fn rules.action.fault_injection_policy.new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.new` constructs a new object with attributes and blocks configured for the `fault_injection_policy` +Terraform sub block. + + + +**Args**: + - `abort` (`list[obj]`): Specification of how client requests are aborted as part of fault injection before being sent to a destination. When `null`, the `abort` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.abort.new](#fn-rulesrulesactionabortnew) constructor. + - `delay` (`list[obj]`): Specification of how client requests are delayed as part of fault injection before being sent to a destination. When `null`, the `delay` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.delay.new](#fn-rulesrulesactiondelaynew) constructor. + +**Returns**: + - An attribute object that represents the `fault_injection_policy` sub block. + + +## obj rules.action.fault_injection_policy.abort + + + +### fn rules.action.fault_injection_policy.abort.new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.abort.new` constructs a new object with attributes and blocks configured for the `abort` +Terraform sub block. + + + +**Args**: + - `http_status` (`number`): The HTTP status code used to abort the request. When `null`, the `http_status` field will be omitted from the resulting object. + - `percentage` (`number`): The percentage of traffic which will be aborted. When `null`, the `percentage` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `abort` sub block. + + +## obj rules.action.fault_injection_policy.delay + + + +### fn rules.action.fault_injection_policy.delay.new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.rules.action.fault_injection_policy.delay.new` constructs a new object with attributes and blocks configured for the `delay` +Terraform sub block. + + + +**Args**: + - `fixed_delay` (`string`): Specify a fixed delay before forwarding the request. When `null`, the `fixed_delay` field will be omitted from the resulting object. + - `percentage` (`number`): The percentage of traffic on which delay will be injected. When `null`, the `percentage` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `delay` sub block. + + +## obj rules.action.retry_policy + + + +### fn rules.action.retry_policy.new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.rules.action.retry_policy.new` constructs a new object with attributes and blocks configured for the `retry_policy` +Terraform sub block. + + + +**Args**: + - `num_retries` (`number`): Specifies the allowed number of retries. When `null`, the `num_retries` field will be omitted from the resulting object. + - `retry_conditions` (`list`): Specifies one or more conditions when this retry policy applies. Possible values: ["connect-failure", "refused-stream", "cancelled", "deadline-exceeded", "resource-exhausted", "unavailable"] When `null`, the `retry_conditions` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `retry_policy` sub block. + + +## obj rules.matches + + + +### fn rules.matches.new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.rules.matches.new` constructs a new object with attributes and blocks configured for the `matches` +Terraform sub block. + + + +**Args**: + - `headers` (`list[obj]`): Specifies a list of HTTP request headers to match against. When `null`, the `headers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.matches.headers.new](#fn-rulesrulesheadersnew) constructor. + - `method` (`list[obj]`): A gRPC method to match against. If this field is empty or omitted, will match all methods. When `null`, the `method` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_grpc_route.rules.matches.method.new](#fn-rulesrulesmethodnew) constructor. + +**Returns**: + - An attribute object that represents the `matches` sub block. + + +## obj rules.matches.headers + + + +### fn rules.matches.headers.new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.rules.matches.headers.new` constructs a new object with attributes and blocks configured for the `headers` +Terraform sub block. + + + +**Args**: + - `key` (`string`): Required. The key of the header. + - `type` (`string`): The type of match. Default value: "EXACT" Possible values: ["TYPE_UNSPECIFIED", "EXACT", "REGULAR_EXPRESSION"] When `null`, the `type` field will be omitted from the resulting object. + - `value` (`string`): Required. The value of the header. + +**Returns**: + - An attribute object that represents the `headers` sub block. + + +## obj rules.matches.method + + + +### fn rules.matches.method.new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.rules.matches.method.new` constructs a new object with attributes and blocks configured for the `method` +Terraform sub block. + + + +**Args**: + - `case_sensitive` (`bool`): Specifies that matches are case sensitive. The default value is true. When `null`, the `case_sensitive` field will be omitted from the resulting object. + - `grpc_method` (`string`): Required. Name of the method to match against. + - `grpc_service` (`string`): Required. Name of the service to match against. + +**Returns**: + - An attribute object that represents the `method` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_network_services_grpc_route.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/google_network_services_mesh.md b/docs/4.x/google_network_services_mesh.md index 3abeb352..15478b9f 100644 --- a/docs/4.x/google_network_services_mesh.md +++ b/docs/4.x/google_network_services_mesh.md @@ -55,10 +55,10 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - `description` (`string`): A free-text description of the resource. Max length 1024 characters. When `null`, the `description` field will be omitted from the resulting object. - - `interception_port` (`number`): Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the -specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to -be redirected to this port regardless of its actual ip:port destination. If unset, a port -'15001' is used as the interception port. This will is applicable only for sidecar proxy + - `interception_port` (`number`): Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the +specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to +be redirected to this port regardless of its actual ip:port destination. If unset, a port +'15001' is used as the interception port. This will is applicable only for sidecar proxy deployments. When `null`, the `interception_port` field will be omitted from the resulting object. - `labels` (`obj`): Set of label tags associated with the Mesh resource. When `null`, the `labels` field will be omitted from the resulting object. - `name` (`string`): Short name of the Mesh resource to be created. @@ -88,10 +88,10 @@ 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. - - `interception_port` (`number`): Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the -specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to -be redirected to this port regardless of its actual ip:port destination. If unset, a port -'15001' is used as the interception port. This will is applicable only for sidecar proxy + - `interception_port` (`number`): Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the +specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to +be redirected to this port regardless of its actual ip:port destination. If unset, a port +'15001' is used as the interception port. This will is applicable only for sidecar proxy deployments. When `null`, the `interception_port` field will be omitted from the resulting object. - `labels` (`obj`): Set of label tags associated with the Mesh resource. When `null`, the `labels` field will be omitted from the resulting object. - `name` (`string`): Short name of the Mesh resource to be created. diff --git a/docs/4.x/google_network_services_service_binding.md b/docs/4.x/google_network_services_service_binding.md new file mode 100644 index 00000000..4b02335a --- /dev/null +++ b/docs/4.x/google_network_services_service_binding.md @@ -0,0 +1,236 @@ +--- +permalink: /google_network_services_service_binding/ +--- + +# google_network_services_service_binding + +`google_network_services_service_binding` represents the `google-beta_google_network_services_service_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 withDescription()`](#fn-withdescription) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withService()`](#fn-withservice) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_network_services_service_binding.new` injects a new `google-beta_google_network_services_service_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-beta.google_network_services_service_binding.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_network_services_service_binding` using the reference: + + $._ref.google-beta_google_network_services_service_binding.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_network_services_service_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. + - `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`): Set of label tags associated with the ServiceBinding resource. When `null`, the `labels` field will be omitted from the resulting object. + - `name` (`string`): Name of the ServiceBinding resource. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `service` (`string`): The full Service Directory Service name of the format +projects/*/locations/*/namespaces/*/services/* + - `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-beta.google_network_services_service_binding.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_network_services_service_binding.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_service_binding` +Terraform resource. + +Unlike [google-beta.google_network_services_service_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**: + - `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`): Set of label tags associated with the ServiceBinding resource. When `null`, the `labels` field will be omitted from the resulting object. + - `name` (`string`): Name of the ServiceBinding resource. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `service` (`string`): The full Service Directory Service name of the format +projects/*/locations/*/namespaces/*/services/* + - `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-beta.google_network_services_service_binding.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 `google_network_services_service_binding` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`google-beta.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-beta.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 withName + +```ts +withName() +``` + +`google-beta.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-beta.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 withService + +```ts +withService() +``` + +`google-beta.string.withService` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the service field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `service` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.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-beta.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-beta.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-beta.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_network_services_service_binding.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/google_network_services_tcp_route.md b/docs/4.x/google_network_services_tcp_route.md index 55dca3c8..87748bd7 100644 --- a/docs/4.x/google_network_services_tcp_route.md +++ b/docs/4.x/google_network_services_tcp_route.md @@ -74,7 +74,7 @@ Each mesh reference should match the pattern: projects/*/locations/global/meshes The attached Mesh should be of a type SIDECAR When `null`, the `meshes` field will be omitted from the resulting object. - `name` (`string`): Name of the TcpRoute resource. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. + - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match. When `null`, the `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-beta.google_network_services_tcp_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_tcp_route.timeouts.new](#fn-timeoutsnew) constructor. @@ -109,7 +109,7 @@ Each mesh reference should match the pattern: projects/*/locations/global/meshes The attached Mesh should be of a type SIDECAR When `null`, the `meshes` field will be omitted from the resulting object. - `name` (`string`): Name of the TcpRoute resource. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. + - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match. When `null`, the `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-beta.google_network_services_tcp_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_tcp_route.timeouts.new](#fn-timeoutsnew) constructor. @@ -304,7 +304,7 @@ Terraform sub block. **Args**: - `action` (`list[obj]`): A detailed rule defining how to route traffic. When `null`, the `action` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tcp_route.rules.action.new](#fn-rulesactionnew) constructor. - - `matches` (`list[obj]`): RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "OR"ed for evaluation. + - `matches` (`list[obj]`): RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "OR"ed for evaluation. If no routeMatch field is specified, this rule will unconditionally match traffic. When `null`, the `matches` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tcp_route.rules.matches.new](#fn-rulesmatchesnew) constructor. **Returns**: @@ -379,7 +379,7 @@ Terraform sub block. **Args**: - - `address` (`string`): Must be specified in the CIDR range format. A CIDR range consists of an IP Address and a prefix length to construct the subnet mask. + - `address` (`string`): Must be specified in the CIDR range format. A CIDR range consists of an IP Address and a prefix length to construct the subnet mask. By default, the prefix length is 32 (i.e. matches a single IP address). Only IPV4 addresses are supported. Examples: "10.0.0.1" - matches against this exact IP address. "10.0.0.0/8" - matches against any IP address within the 10.0.0.0 subnet and 255.255.255.0 mask. "0.0.0.0/0" - matches against any IP address'. - `port` (`string`): Specifies the destination port to match against. diff --git a/docs/4.x/google_network_services_tls_route.md b/docs/4.x/google_network_services_tls_route.md new file mode 100644 index 00000000..e5eb5c87 --- /dev/null +++ b/docs/4.x/google_network_services_tls_route.md @@ -0,0 +1,386 @@ +--- +permalink: /google_network_services_tls_route/ +--- + +# google_network_services_tls_route + +`google_network_services_tls_route` represents the `google-beta_google_network_services_tls_route` 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 withGateways()`](#fn-withgateways) +* [`fn withMeshes()`](#fn-withmeshes) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withRules()`](#fn-withrules) +* [`fn withRulesMixin()`](#fn-withrulesmixin) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj rules`](#obj-rules) + * [`fn new()`](#fn-rulesnew) + * [`obj rules.action`](#obj-rulesaction) + * [`fn new()`](#fn-rulesactionnew) + * [`obj rules.action.destinations`](#obj-rulesactiondestinations) + * [`fn new()`](#fn-rulesactiondestinationsnew) + * [`obj rules.matches`](#obj-rulesmatches) + * [`fn new()`](#fn-rulesmatchesnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_network_services_tls_route.new` injects a new `google-beta_google_network_services_tls_route` 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-beta.google_network_services_tls_route.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_network_services_tls_route` using the reference: + + $._ref.google-beta_google_network_services_tls_route.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_network_services_tls_route.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. + - `gateways` (`list`): Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. +Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name> When `null`, the `gateways` field will be omitted from the resulting object. + - `meshes` (`list`): Meshes defines a list of meshes this TlsRoute is attached to, as one of the routing rules to route the requests served by the mesh. +Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name> +The attached Mesh should be of a type SIDECAR When `null`, the `meshes` field will be omitted from the resulting object. + - `name` (`string`): Name of the TlsRoute resource. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. When `null`, the `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-beta.google_network_services_tls_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_tls_route.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_network_services_tls_route.newAttrs` constructs a new object with attributes and blocks configured for the `google_network_services_tls_route` +Terraform resource. + +Unlike [google-beta.google_network_services_tls_route.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. + - `gateways` (`list`): Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. +Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name> When `null`, the `gateways` field will be omitted from the resulting object. + - `meshes` (`list`): Meshes defines a list of meshes this TlsRoute is attached to, as one of the routing rules to route the requests served by the mesh. +Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name> +The attached Mesh should be of a type SIDECAR When `null`, the `meshes` field will be omitted from the resulting object. + - `name` (`string`): Name of the TlsRoute resource. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `rules` (`list[obj]`): Rules that define how traffic is routed and handled. When `null`, the `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-beta.google_network_services_tls_route.rules.new](#fn-rulesnew) 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-beta.google_network_services_tls_route.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 `google_network_services_tls_route` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`google-beta.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 withGateways + +```ts +withGateways() +``` + +`google-beta.list.withGateways` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the gateways field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `gateways` field. + + +### fn withMeshes + +```ts +withMeshes() +``` + +`google-beta.list.withMeshes` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the meshes field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `meshes` field. + + +### fn withName + +```ts +withName() +``` + +`google-beta.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-beta.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 withRules + +```ts +withRules() +``` + +`google-beta.list[obj].withRules` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the rules 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-beta.list[obj].withRulesMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `rules` field. + + +### fn withRulesMixin + +```ts +withRulesMixin() +``` + +`google-beta.list[obj].withRulesMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the rules 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-beta.list[obj].withRules](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `rules` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.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-beta.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-beta.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-beta.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 rules + + + +### fn rules.new + +```ts +new() +``` + + +`google-beta.google_network_services_tls_route.rules.new` constructs a new object with attributes and blocks configured for the `rules` +Terraform sub block. + + + +**Args**: + - `action` (`list[obj]`): Required. A detailed rule defining how to route traffic. When `null`, the `action` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tls_route.rules.action.new](#fn-rulesactionnew) constructor. + - `matches` (`list[obj]`): Matches define the predicate used to match requests to a given action. When `null`, the `matches` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tls_route.rules.matches.new](#fn-rulesmatchesnew) constructor. + +**Returns**: + - An attribute object that represents the `rules` sub block. + + +## obj rules.action + + + +### fn rules.action.new + +```ts +new() +``` + + +`google-beta.google_network_services_tls_route.rules.action.new` constructs a new object with attributes and blocks configured for the `action` +Terraform sub block. + + + +**Args**: + - `destinations` (`list[obj]`): The destination to which traffic should be forwarded. When `null`, the `destinations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_network_services_tls_route.rules.action.destinations.new](#fn-rulesrulesdestinationsnew) constructor. + +**Returns**: + - An attribute object that represents the `action` sub block. + + +## obj rules.action.destinations + + + +### fn rules.action.destinations.new + +```ts +new() +``` + + +`google-beta.google_network_services_tls_route.rules.action.destinations.new` constructs a new object with attributes and blocks configured for the `destinations` +Terraform sub block. + + + +**Args**: + - `service_name` (`string`): The URL of a BackendService to route traffic to. When `null`, the `service_name` field will be omitted from the resulting object. + - `weight` (`number`): Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. When `null`, the `weight` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `destinations` sub block. + + +## obj rules.matches + + + +### fn rules.matches.new + +```ts +new() +``` + + +`google-beta.google_network_services_tls_route.rules.matches.new` constructs a new object with attributes and blocks configured for the `matches` +Terraform sub block. + + + +**Args**: + - `alpn` (`list`): ALPN (Application-Layer Protocol Negotiation) to match against. Examples: "http/1.1", "h2". At least one of sniHost and alpn is required. Up to 5 alpns across all matches can be set. When `null`, the `alpn` field will be omitted from the resulting object. + - `sni_host` (`list`): SNI (server name indicator) to match against. SNI will be matched against all wildcard domains, i.e. www.example.com will be first matched against www.example.com, then *.example.com, then *.com. +Partial wildcards are not supported, and values like *w.example.com are invalid. At least one of sniHost and alpn is required. Up to 5 sni hosts across all matches can be set. When `null`, the `sni_host` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `matches` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_network_services_tls_route.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/google_privateca_ca_pool.md b/docs/4.x/google_privateca_ca_pool.md index 6a0a6ef2..5412c733 100644 --- a/docs/4.x/google_privateca_ca_pool.md +++ b/docs/4.x/google_privateca_ca_pool.md @@ -564,7 +564,7 @@ Terraform sub block. - `is_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to true. When `null`, the `is_ca` field will be omitted from the resulting object. - `max_issuer_path_length` (`number`): Refers to the "path length constraint" in Basic Constraints extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. When `null`, the `max_issuer_path_length` field will be omitted from the resulting object. - - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false. + - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false. If both 'is_ca' and 'non_ca' are unset, the extension will be omitted from the CA certificate. When `null`, the `non_ca` field will be omitted from the resulting object. - `zero_max_issuer_path_length` (`bool`): When true, the "path length constraint" in Basic Constraints extension will be set to 0. if both 'max_issuer_path_length' and 'zero_max_issuer_path_length' are unset, diff --git a/docs/4.x/google_privateca_certificate.md b/docs/4.x/google_privateca_certificate.md index e0bddec2..a8730820 100644 --- a/docs/4.x/google_privateca_certificate.md +++ b/docs/4.x/google_privateca_certificate.md @@ -604,7 +604,7 @@ Terraform sub block. - `is_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to true. When `null`, the `is_ca` field will be omitted from the resulting object. - `max_issuer_path_length` (`number`): Refers to the "path length constraint" in Basic Constraints extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. When `null`, the `max_issuer_path_length` field will be omitted from the resulting object. - - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false. + - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false. If both 'is_ca' and 'non_ca' are unset, the extension will be omitted from the CA certificate. When `null`, the `non_ca` field will be omitted from the resulting object. - `zero_max_issuer_path_length` (`bool`): When true, the "path length constraint" in Basic Constraints extension will be set to 0. if both 'max_issuer_path_length' and 'zero_max_issuer_path_length' are unset, diff --git a/docs/4.x/google_privateca_certificate_authority.md b/docs/4.x/google_privateca_certificate_authority.md index f04ee349..9b3c1a19 100644 --- a/docs/4.x/google_privateca_certificate_authority.md +++ b/docs/4.x/google_privateca_certificate_authority.md @@ -764,7 +764,7 @@ Terraform sub block. - `max_issuer_path_length` (`number`): Refers to the "path length constraint" in Basic Constraints extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. Setting the value to 0 requires setting 'zero_max_issuer_path_length = true'. When `null`, the `max_issuer_path_length` field will be omitted from the resulting object. - - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false. + - `non_ca` (`bool`): When true, the "CA" in Basic Constraints extension will be set to false. If both 'is_ca' and 'non_ca' are unset, the extension will be omitted from the CA certificate. When `null`, the `non_ca` field will be omitted from the resulting object. - `zero_max_issuer_path_length` (`bool`): When true, the "path length constraint" in Basic Constraints extension will be set to 0. If both 'max_issuer_path_length' and 'zero_max_issuer_path_length' are unset, @@ -1006,7 +1006,7 @@ Terraform sub block. subordinate CertificateAuthority. This field is used for information and usability purposes only. The resource name is in the format 'projects/*/locations/*/caPools/*/certificateAuthorities/*'. When `null`, the `certificate_authority` field will be omitted from the resulting object. - - `pem_issuer_chain` (`list[obj]`): Contains the PEM certificate chain for the issuers of this CertificateAuthority, + - `pem_issuer_chain` (`list[obj]`): Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself. When `null`, the `pem_issuer_chain` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_privateca_certificate_authority.subordinate_config.pem_issuer_chain.new](#fn-subordinate_configpem_issuer_chainnew) constructor. **Returns**: diff --git a/docs/4.x/google_pubsub_subscription.md b/docs/4.x/google_pubsub_subscription.md index 874e2c9e..f79e5705 100644 --- a/docs/4.x/google_pubsub_subscription.md +++ b/docs/4.x/google_pubsub_subscription.md @@ -111,9 +111,9 @@ is true if the message was published multiple times by a publisher client. These - `enable_message_ordering` (`bool`): If 'true', messages published with the same orderingKey in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. When `null`, the `enable_message_ordering` field will be omitted from the resulting object. - - `filter` (`string`): The subscription only delivers the messages that match the filter. + - `filter` (`string`): The subscription only delivers the messages that match the filter. Pub/Sub automatically acknowledges the messages that don't match the filter. You can filter messages -by their attributes. The maximum length of a filter is 256 bytes. After creating the subscription, +by their attributes. The maximum length of a filter is 256 bytes. After creating the subscription, you can't modify the filter. When `null`, the `filter` field will be omitted from the resulting object. - `labels` (`obj`): A set of key/value label pairs to assign to this Subscription. When `null`, the `labels` field will be omitted from the resulting object. - `message_retention_duration` (`string`): How long to retain unacknowledged messages in the subscription's @@ -155,7 +155,7 @@ configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods. When `null`, the `push_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-beta.google_pubsub_subscription.push_config.new](#fn-push_confignew) constructor. - `retry_policy` (`list[obj]`): A policy that specifies how Pub/Sub retries message delivery for this subscription. -If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. +If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message When `null`, the `retry_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-beta.google_pubsub_subscription.retry_policy.new](#fn-retry_policynew) 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-beta.google_pubsub_subscription.timeouts.new](#fn-timeoutsnew) constructor. @@ -211,9 +211,9 @@ is true if the message was published multiple times by a publisher client. These - `enable_message_ordering` (`bool`): If 'true', messages published with the same orderingKey in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. When `null`, the `enable_message_ordering` field will be omitted from the resulting object. - - `filter` (`string`): The subscription only delivers the messages that match the filter. + - `filter` (`string`): The subscription only delivers the messages that match the filter. Pub/Sub automatically acknowledges the messages that don't match the filter. You can filter messages -by their attributes. The maximum length of a filter is 256 bytes. After creating the subscription, +by their attributes. The maximum length of a filter is 256 bytes. After creating the subscription, you can't modify the filter. When `null`, the `filter` field will be omitted from the resulting object. - `labels` (`obj`): A set of key/value label pairs to assign to this Subscription. When `null`, the `labels` field will be omitted from the resulting object. - `message_retention_duration` (`string`): How long to retain unacknowledged messages in the subscription's @@ -255,7 +255,7 @@ configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods. When `null`, the `push_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-beta.google_pubsub_subscription.push_config.new](#fn-push_confignew) constructor. - `retry_policy` (`list[obj]`): A policy that specifies how Pub/Sub retries message delivery for this subscription. -If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. +If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message When `null`, the `retry_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-beta.google_pubsub_subscription.retry_policy.new](#fn-retry_policynew) 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-beta.google_pubsub_subscription.timeouts.new](#fn-timeoutsnew) constructor. @@ -693,7 +693,7 @@ Terraform sub block. Format is 'projects/{project}/topics/{topic}'. The Cloud Pub/Sub service account associated with the enclosing subscription's -parent project (i.e., +parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. @@ -703,7 +703,7 @@ since messages published to a topic with no subscriptions are lost. When `null`, - `max_delivery_attempts` (`number`): The maximum number of delivery attempts for any message. The value must be between 5 and 100. -The number of delivery attempts is defined as 1 + (the sum of number of +The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that @@ -843,7 +843,7 @@ Terraform sub block. **Args**: - - `maximum_backoff` (`string`): The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. + - `maximum_backoff` (`string`): The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `maximum_backoff` field will be omitted from the resulting object. - `minimum_backoff` (`string`): The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". When `null`, the `minimum_backoff` field will be omitted from the resulting object. diff --git a/docs/4.x/google_sourcerepo_repository.md b/docs/4.x/google_sourcerepo_repository.md index 8b67b9f3..627f86d8 100644 --- a/docs/4.x/google_sourcerepo_repository.md +++ b/docs/4.x/google_sourcerepo_repository.md @@ -58,7 +58,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `name` (`string`): Resource name of the repository, of the form '{{repo}}'. The repo name may contain slashes. eg, 'name/with/slash' - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - - `pubsub_configs` (`list[obj]`): How this repository publishes a change in the repository through Cloud Pub/Sub. + - `pubsub_configs` (`list[obj]`): How this repository publishes a change in the repository through Cloud Pub/Sub. Keyed by the topic names. When `null`, the `pubsub_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sourcerepo_repository.pubsub_configs.new](#fn-pubsub_configsnew) 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-beta.google_sourcerepo_repository.timeouts.new](#fn-timeoutsnew) constructor. @@ -87,7 +87,7 @@ injecting into a complete block. - `name` (`string`): Resource name of the repository, of the form '{{repo}}'. The repo name may contain slashes. eg, 'name/with/slash' - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - - `pubsub_configs` (`list[obj]`): How this repository publishes a change in the repository through Cloud Pub/Sub. + - `pubsub_configs` (`list[obj]`): How this repository publishes a change in the repository through Cloud Pub/Sub. Keyed by the topic names. When `null`, the `pubsub_configs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_sourcerepo_repository.pubsub_configs.new](#fn-pubsub_configsnew) 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-beta.google_sourcerepo_repository.timeouts.new](#fn-timeoutsnew) constructor. @@ -217,12 +217,12 @@ Terraform sub block. **Args**: - - `message_format` (`string`): The format of the Cloud Pub/Sub messages. + - `message_format` (`string`): The format of the Cloud Pub/Sub messages. - PROTOBUF: The message payload is a serialized protocol buffer of SourceRepoEvent. - JSON: The message payload is a JSON string of SourceRepoEvent. Possible values: ["PROTOBUF", "JSON"] - - `service_account_email` (`string`): Email address of the service account used for publishing Cloud Pub/Sub messages. -This service account needs to be in the same project as the PubsubConfig. When added, -the caller needs to have iam.serviceAccounts.actAs permission on this service account. + - `service_account_email` (`string`): Email address of the service account used for publishing Cloud Pub/Sub messages. +This service account needs to be in the same project as the PubsubConfig. When added, +the caller needs to have iam.serviceAccounts.actAs permission on this service account. If unspecified, it defaults to the compute engine default service account. When `null`, the `service_account_email` field will be omitted from the resulting object. - `topic` (`string`): Set the `topic` field on the resulting object. diff --git a/docs/4.x/google_spanner_instance.md b/docs/4.x/google_spanner_instance.md index 2543f185..5efa0138 100644 --- a/docs/4.x/google_spanner_instance.md +++ b/docs/4.x/google_spanner_instance.md @@ -77,7 +77,7 @@ in length. If not provided, a random string starting with 'tf-' will be selected. When `null`, the `name` field will be omitted from the resulting object. - `num_nodes` (`number`): The number of nodes allocated to this instance. Exactly one of either node_count or processing_units must be present in terraform. When `null`, the `num_nodes` field will be omitted from the resulting object. - - `processing_units` (`number`): The number of processing units allocated to this instance. Exactly one of processing_units + - `processing_units` (`number`): The number of processing units allocated to this instance. Exactly one of processing_units or node_count must be present in terraform. When `null`, the `processing_units` 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. - `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-beta.google_spanner_instance.timeouts.new](#fn-timeoutsnew) constructor. @@ -124,7 +124,7 @@ in length. If not provided, a random string starting with 'tf-' will be selected. When `null`, the `name` field will be omitted from the resulting object. - `num_nodes` (`number`): The number of nodes allocated to this instance. Exactly one of either node_count or processing_units must be present in terraform. When `null`, the `num_nodes` field will be omitted from the resulting object. - - `processing_units` (`number`): The number of processing units allocated to this instance. Exactly one of processing_units + - `processing_units` (`number`): The number of processing units allocated to this instance. Exactly one of processing_units or node_count must be present in terraform. When `null`, the `processing_units` 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. - `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-beta.google_spanner_instance.timeouts.new](#fn-timeoutsnew) constructor. diff --git a/docs/4.x/google_sql_database.md b/docs/4.x/google_sql_database.md index 5fd56e9a..4005c458 100644 --- a/docs/4.x/google_sql_database.md +++ b/docs/4.x/google_sql_database.md @@ -65,9 +65,9 @@ a value of 'UTF8' at creation time. When `null`, the `charset` field wil and Postgres' [Collation Support](https://www.postgresql.org/docs/9.6/static/collation.html) for more details and supported values. Postgres databases only support a value of 'en_US.UTF8' at creation time. When `null`, the `collation` field will be omitted from the resulting object. - - `deletion_policy` (`string`): The deletion policy for the database. Setting ABANDON allows the resource -to be abandoned rather than deleted. This is useful for Postgres, where databases cannot be -deleted from the API if there are users other than cloudsqlsuperuser with access. Possible + - `deletion_policy` (`string`): The deletion policy for the database. Setting ABANDON allows the resource +to be abandoned rather than deleted. This is useful for Postgres, where databases cannot be +deleted from the API if there are users other than cloudsqlsuperuser with access. Possible values are: "ABANDON", "DELETE". Defaults to "DELETE". When `null`, the `deletion_policy` field will be omitted from the resulting object. - `instance` (`string`): The name of the Cloud SQL instance. This does not include the project ID. @@ -108,9 +108,9 @@ a value of 'UTF8' at creation time. When `null`, the `charset` field wil and Postgres' [Collation Support](https://www.postgresql.org/docs/9.6/static/collation.html) for more details and supported values. Postgres databases only support a value of 'en_US.UTF8' at creation time. When `null`, the `collation` field will be omitted from the resulting object. - - `deletion_policy` (`string`): The deletion policy for the database. Setting ABANDON allows the resource -to be abandoned rather than deleted. This is useful for Postgres, where databases cannot be -deleted from the API if there are users other than cloudsqlsuperuser with access. Possible + - `deletion_policy` (`string`): The deletion policy for the database. Setting ABANDON allows the resource +to be abandoned rather than deleted. This is useful for Postgres, where databases cannot be +deleted from the API if there are users other than cloudsqlsuperuser with access. Possible values are: "ABANDON", "DELETE". Defaults to "DELETE". When `null`, the `deletion_policy` field will be omitted from the resulting object. - `instance` (`string`): The name of the Cloud SQL instance. This does not include the project ID. diff --git a/docs/4.x/google_sql_source_representation_instance.md b/docs/4.x/google_sql_source_representation_instance.md index 37b2a2df..07ae9af5 100644 --- a/docs/4.x/google_sql_source_representation_instance.md +++ b/docs/4.x/google_sql_source_representation_instance.md @@ -64,7 +64,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `ca_certificate` (`string`): The CA certificate on the external server. Include only if SSL/TLS is used on the external server. When `null`, the `ca_certificate` field will be omitted from the resulting object. - `client_certificate` (`string`): The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_certificate` field will be omitted from the resulting object. - `client_key` (`string`): The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_key` field will be omitted from the resulting object. - - `database_version` (`string`): The MySQL version running on your source database server. Possible values: ["MYSQL_5_5", "MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0"] + - `database_version` (`string`): The MySQL version running on your source database server. Possible values: ["MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0", "POSTGRES_9_6", "POSTGRES_10", "POSTGRES_11", "POSTGRES_12", "POSTGRES_13", "POSTGRES_14"] - `dump_file_path` (`string`): A file in the bucket that contains the data from the external server. When `null`, the `dump_file_path` field will be omitted from the resulting object. - `host` (`string`): The externally accessible IPv4 address for the source database server. - `name` (`string`): The name of the source representation instance. Use any valid Cloud SQL instance name. @@ -102,7 +102,7 @@ injecting into a complete block. - `ca_certificate` (`string`): The CA certificate on the external server. Include only if SSL/TLS is used on the external server. When `null`, the `ca_certificate` field will be omitted from the resulting object. - `client_certificate` (`string`): The client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_certificate` field will be omitted from the resulting object. - `client_key` (`string`): The private key file for the client certificate on the external server. Required only for server-client authentication. Include only if SSL/TLS is used on the external server. When `null`, the `client_key` field will be omitted from the resulting object. - - `database_version` (`string`): The MySQL version running on your source database server. Possible values: ["MYSQL_5_5", "MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0"] + - `database_version` (`string`): The MySQL version running on your source database server. Possible values: ["MYSQL_5_6", "MYSQL_5_7", "MYSQL_8_0", "POSTGRES_9_6", "POSTGRES_10", "POSTGRES_11", "POSTGRES_12", "POSTGRES_13", "POSTGRES_14"] - `dump_file_path` (`string`): A file in the bucket that contains the data from the external server. When `null`, the `dump_file_path` field will be omitted from the resulting object. - `host` (`string`): The externally accessible IPv4 address for the source database server. - `name` (`string`): The name of the source representation instance. Use any valid Cloud SQL instance name. diff --git a/docs/4.x/google_vertex_ai_endpoint.md b/docs/4.x/google_vertex_ai_endpoint.md index b1611f2a..6e2a382f 100644 --- a/docs/4.x/google_vertex_ai_endpoint.md +++ b/docs/4.x/google_vertex_ai_endpoint.md @@ -24,6 +24,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withName()`](#fn-withname) * [`fn withNetwork()`](#fn-withnetwork) * [`fn withProject()`](#fn-withproject) +* [`fn withRegion()`](#fn-withregion) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj encryption_spec`](#obj-encryption_spec) @@ -67,6 +68,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `name` (`string`): The resource name of the Endpoint. The name must be numeric with no leading zeros and can be at most 10 digits. - `network` (`string`): The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): 'projects/{project}/global/networks/{network}'. Where '{project}' is a project number, as in '12345', and '{network}' is network name. 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. + - `region` (`string`): The region for the resource When `null`, the `region` field will be omitted from the resulting object. - `encryption_spec` (`list[obj]`): Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key. When `null`, the `encryption_spec` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_vertex_ai_endpoint.encryption_spec.new](#fn-encryption_specnew) 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-beta.google_vertex_ai_endpoint.timeouts.new](#fn-timeoutsnew) constructor. @@ -99,6 +101,7 @@ injecting into a complete block. - `name` (`string`): The resource name of the Endpoint. The name must be numeric with no leading zeros and can be at most 10 digits. - `network` (`string`): The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): 'projects/{project}/global/networks/{network}'. Where '{project}' is a project number, as in '12345', and '{network}' is network name. 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. + - `region` (`string`): The region for the resource When `null`, the `region` field will be omitted from the resulting object. - `encryption_spec` (`list[obj]`): Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key. When `null`, the `encryption_spec` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_vertex_ai_endpoint.encryption_spec.new](#fn-encryption_specnew) 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-beta.google_vertex_ai_endpoint.timeouts.new](#fn-timeoutsnew) constructor. @@ -255,6 +258,22 @@ Terraform resource block to set or update the project field. - `value` (`string`): The value to set for the `project` field. +### fn withRegion + +```ts +withRegion() +``` + +`google-beta.string.withRegion` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the region field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `region` field. + + ### fn withTimeouts ```ts diff --git a/docs/4.x/google_vertex_ai_index.md b/docs/4.x/google_vertex_ai_index.md index 63945cac..a1e1c673 100644 --- a/docs/4.x/google_vertex_ai_index.md +++ b/docs/4.x/google_vertex_ai_index.md @@ -342,7 +342,7 @@ Required if tree-AH algorithm is used. When `null`, the `approximate_neighbors_c * L1_DISTANCE: Manhattan (L_1) Distance * COSINE_DISTANCE: Cosine Distance. Defined as 1 - cosine similarity. * DOT_PRODUCT_DISTANCE: Dot Product Distance. Defined as a negative of the dot product When `null`, the `distance_measure_type` field will be omitted from the resulting object. - - `feature_norm_type` (`string`): Type of normalization to be carried out on each vector. The value must be one of the followings: + - `feature_norm_type` (`string`): Type of normalization to be carried out on each vector. The value must be one of the followings: * UNIT_L2_NORM: Unit L2 normalization type * NONE: No normalization type is specified. When `null`, the `feature_norm_type` field will be omitted from the resulting object. - `algorithm_config` (`list[obj]`): The configuration with regard to the algorithms used for efficient search. When `null`, the `algorithm_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-beta.google_vertex_ai_index.metadata.config.algorithm_config.new](#fn-metadatametadataalgorithm_confignew) constructor. diff --git a/docs/4.x/google_workflows_workflow.md b/docs/4.x/google_workflows_workflow.md index 5de8529b..8efff235 100644 --- a/docs/4.x/google_workflows_workflow.md +++ b/docs/4.x/google_workflows_workflow.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withCryptoKeyName()`](#fn-withcryptokeyname) * [`fn withDescription()`](#fn-withdescription) * [`fn withLabels()`](#fn-withlabels) * [`fn withName()`](#fn-withname) @@ -57,6 +58,9 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. + - `crypto_key_name` (`string`): The KMS key used to encrypt workflow and execution data. + +Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} When `null`, the `crypto_key_name` field will be omitted from the resulting object. - `description` (`string`): Description of the workflow provided by the user. Must be at most 1000 unicode characters long. When `null`, the `description` field will be omitted from the resulting object. - `labels` (`obj`): A set of key/value label pairs to assign to this Workflow. When `null`, the `labels` field will be omitted from the resulting object. - `name` (`string`): Name of the Workflow. When `null`, the `name` field will be omitted from the resulting object. @@ -65,8 +69,11 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `region` (`string`): The region of the workflow. When `null`, the `region` field will be omitted from the resulting object. - `service_account` (`string`): Name of the service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. - -Format: projects/{project}/serviceAccounts/{account}. When `null`, the `service_account` field will be omitted from the resulting object. +Format: projects/{project}/serviceAccounts/{account} or {account}. +Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. +The {account} value can be the email address or the unique_id of the service account. +If not provided, workflow will use the project's default service account. +Modifying this field for an existing workflow results in a new workflow revision. When `null`, the `service_account` field will be omitted from the resulting object. - `source_contents` (`string`): Workflow code to be executed. The size limit is 32KB. When `null`, the `source_contents` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workflows_workflow.timeouts.new](#fn-timeoutsnew) constructor. @@ -92,6 +99,9 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: + - `crypto_key_name` (`string`): The KMS key used to encrypt workflow and execution data. + +Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} When `null`, the `crypto_key_name` field will be omitted from the resulting object. - `description` (`string`): Description of the workflow provided by the user. Must be at most 1000 unicode characters long. When `null`, the `description` field will be omitted from the resulting object. - `labels` (`obj`): A set of key/value label pairs to assign to this Workflow. When `null`, the `labels` field will be omitted from the resulting object. - `name` (`string`): Name of the Workflow. When `null`, the `name` field will be omitted from the resulting object. @@ -100,8 +110,11 @@ injecting into a complete block. - `region` (`string`): The region of the workflow. When `null`, the `region` field will be omitted from the resulting object. - `service_account` (`string`): Name of the service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. - -Format: projects/{project}/serviceAccounts/{account}. When `null`, the `service_account` field will be omitted from the resulting object. +Format: projects/{project}/serviceAccounts/{account} or {account}. +Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. +The {account} value can be the email address or the unique_id of the service account. +If not provided, workflow will use the project's default service account. +Modifying this field for an existing workflow results in a new workflow revision. When `null`, the `service_account` field will be omitted from the resulting object. - `source_contents` (`string`): Workflow code to be executed. The size limit is 32KB. When `null`, the `source_contents` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workflows_workflow.timeouts.new](#fn-timeoutsnew) constructor. @@ -109,6 +122,22 @@ Format: projects/{project}/serviceAccounts/{account}. When `null`, the `service_ - 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 `google_workflows_workflow` resource into the root Terraform configuration. +### fn withCryptoKeyName + +```ts +withCryptoKeyName() +``` + +`google-beta.string.withCryptoKeyName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the crypto_key_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `crypto_key_name` field. + + ### fn withDescription ```ts diff --git a/docs/4.x/google_workstations_workstation.md b/docs/4.x/google_workstations_workstation.md index 3e38729c..4eed5015 100644 --- a/docs/4.x/google_workstations_workstation.md +++ b/docs/4.x/google_workstations_workstation.md @@ -60,10 +60,10 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `annotations` (`obj`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object. - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object. - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object. - - `location` (`string`): The location where the workstation cluster config should reside. + - `location` (`string`): The location where the workstation parent resources reside. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - - `workstation_cluster_id` (`string`): The name of the workstation cluster. - - `workstation_config_id` (`string`): The ID of the workstation cluster config. + - `workstation_cluster_id` (`string`): The ID of the parent workstation cluster. + - `workstation_config_id` (`string`): The ID of the parent workstation cluster config. - `workstation_id` (`string`): ID to use for the workstation. - `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-beta.google_workstations_workstation.timeouts.new](#fn-timeoutsnew) constructor. @@ -92,10 +92,10 @@ injecting into a complete block. - `annotations` (`obj`): Client-specified annotations. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object. - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object. - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object. - - `location` (`string`): The location where the workstation cluster config should reside. + - `location` (`string`): The location where the workstation parent resources reside. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - - `workstation_cluster_id` (`string`): The name of the workstation cluster. - - `workstation_config_id` (`string`): The ID of the workstation cluster config. + - `workstation_cluster_id` (`string`): The ID of the parent workstation cluster. + - `workstation_config_id` (`string`): The ID of the parent workstation cluster config. - `workstation_id` (`string`): ID to use for the workstation. - `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-beta.google_workstations_workstation.timeouts.new](#fn-timeoutsnew) constructor. diff --git a/docs/4.x/google_workstations_workstation_cluster.md b/docs/4.x/google_workstations_workstation_cluster.md index d7a99317..8953b46c 100644 --- a/docs/4.x/google_workstations_workstation_cluster.md +++ b/docs/4.x/google_workstations_workstation_cluster.md @@ -65,12 +65,12 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object. - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object. - `location` (`string`): The location where the workstation cluster should reside. When `null`, the `location` field will be omitted from the resulting object. - - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. + - `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}". - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - - `subnetwork` (`string`): Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. + - `subnetwork` (`string`): Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. Must be part of the subnetwork specified for this cluster. - - `workstation_cluster_id` (`string`): The ID of the workstation cluster. + - `workstation_cluster_id` (`string`): ID to use for the workstation cluster. - `private_cluster_config` (`list[obj]`): Configuration for private cluster. 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-beta.google_workstations_workstation_cluster.private_cluster_config.new](#fn-private_cluster_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-beta.google_workstations_workstation_cluster.timeouts.new](#fn-timeoutsnew) constructor. @@ -100,12 +100,12 @@ injecting into a complete block. - `display_name` (`string`): Human-readable name for this resource. When `null`, the `display_name` field will be omitted from the resulting object. - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object. - `location` (`string`): The location where the workstation cluster should reside. When `null`, the `location` field will be omitted from the resulting object. - - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. + - `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}". - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - - `subnetwork` (`string`): Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. + - `subnetwork` (`string`): Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. Must be part of the subnetwork specified for this cluster. - - `workstation_cluster_id` (`string`): The ID of the workstation cluster. + - `workstation_cluster_id` (`string`): ID to use for the workstation cluster. - `private_cluster_config` (`list[obj]`): Configuration for private cluster. 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-beta.google_workstations_workstation_cluster.private_cluster_config.new](#fn-private_cluster_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-beta.google_workstations_workstation_cluster.timeouts.new](#fn-timeoutsnew) constructor. diff --git a/docs/4.x/google_workstations_workstation_config.md b/docs/4.x/google_workstations_workstation_config.md index 3cc8dad3..a173cb7b 100644 --- a/docs/4.x/google_workstations_workstation_config.md +++ b/docs/4.x/google_workstations_workstation_config.md @@ -85,8 +85,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object. - `location` (`string`): The location where the workstation cluster config should reside. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - - `workstation_cluster_id` (`string`): The name of the workstation cluster. - - `workstation_config_id` (`string`): The ID of the workstation cluster config. + - `workstation_cluster_id` (`string`): The ID of the parent workstation cluster. + - `workstation_config_id` (`string`): The ID to be assigned to the workstation cluster config. - `container` (`list[obj]`): Container that will be run for each workstation using this configuration when that workstation is started. When `null`, the `container` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.container.new](#fn-containernew) constructor. - `encryption_key` (`list[obj]`): Encrypts resources of this workstation configuration using a customer-managed encryption key. @@ -124,8 +124,8 @@ injecting into a complete block. - `labels` (`obj`): Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. When `null`, the `labels` field will be omitted from the resulting object. - `location` (`string`): The location where the workstation cluster config should reside. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - - `workstation_cluster_id` (`string`): The name of the workstation cluster. - - `workstation_config_id` (`string`): The ID of the workstation cluster config. + - `workstation_cluster_id` (`string`): The ID of the parent workstation cluster. + - `workstation_config_id` (`string`): The ID to be assigned to the workstation cluster config. - `container` (`list[obj]`): Container that will be run for each workstation using this configuration when that workstation is started. When `null`, the `container` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.container.new](#fn-containernew) constructor. - `encryption_key` (`list[obj]`): Encrypts resources of this workstation configuration using a customer-managed encryption key. @@ -457,7 +457,7 @@ Terraform sub block. - `command` (`list`): If set, overrides the default ENTRYPOINT specified by the image. When `null`, the `command` field will be omitted from the resulting object. - `env` (`obj`): Environment variables passed to the container. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". When `null`, the `env` field will be omitted from the resulting object. - - `image` (`string`): Docker image defining the container. This image must be accessible by the config"s service account. When `null`, the `image` field will be omitted from the resulting object. + - `image` (`string`): Docker image defining the container. This image must be accessible by the config's service account. When `null`, the `image` field will be omitted from the resulting object. - `run_as_user` (`number`): If set, overrides the USER specified in the image with the given uid. When `null`, the `run_as_user` field will be omitted from the resulting object. - `working_dir` (`string`): If set, overrides the default DIR specified by the image. When `null`, the `working_dir` field will be omitted from the resulting object. @@ -506,7 +506,7 @@ Terraform sub block. **Args**: - - `gce_instance` (`list[obj]`): Specifies a Compute Engine instance as the host. When `null`, the `gce_instance` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.gce_instance.new](#fn-hostgce_instancenew) constructor. + - `gce_instance` (`list[obj]`): A runtime using a Compute Engine instance. When `null`, the `gce_instance` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.gce_instance.new](#fn-hostgce_instancenew) constructor. **Returns**: - An attribute object that represents the `host` sub block. @@ -633,7 +633,7 @@ Terraform sub block. **Args**: - `disk_type` (`string`): Type of the disk to use. When `null`, the `disk_type` field will be omitted from the resulting object. - `fs_type` (`string`): Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if sourceSnapshot is set. When `null`, the `fs_type` field will be omitted from the resulting object. - - `reclaim_policy` (`string`): What should happen to the disk after the workstation is deleted. Defaults to DELETE. Possible values: ["RECLAIM_POLICY_UNSPECIFIED", "DELETE", "RETAIN"] When `null`, the `reclaim_policy` field will be omitted from the resulting object. + - `reclaim_policy` (`string`): What should happen to the disk after the workstation is deleted. Defaults to DELETE. Possible values: ["DELETE", "RETAIN"] When `null`, the `reclaim_policy` field will be omitted from the resulting object. - `size_gb` (`number`): Size of the disk in GB. Must be empty if sourceSnapshot is set. When `null`, the `size_gb` field will be omitted from the resulting object. **Returns**: diff --git a/docs/4.x/google_workstations_workstation_config_iam_binding.md b/docs/4.x/google_workstations_workstation_config_iam_binding.md new file mode 100644 index 00000000..2ce4f0ae --- /dev/null +++ b/docs/4.x/google_workstations_workstation_config_iam_binding.md @@ -0,0 +1,255 @@ +--- +permalink: /google_workstations_workstation_config_iam_binding/ +--- + +# google_workstations_workstation_config_iam_binding + +`google_workstations_workstation_config_iam_binding` represents the `google-beta_google_workstations_workstation_config_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 withProject()`](#fn-withproject) +* [`fn withRole()`](#fn-withrole) +* [`fn withWorkstationClusterId()`](#fn-withworkstationclusterid) +* [`fn withWorkstationConfigId()`](#fn-withworkstationconfigid) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_workstations_workstation_config_iam_binding.new` injects a new `google-beta_google_workstations_workstation_config_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-beta.google_workstations_workstation_config_iam_binding.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_config_iam_binding` using the reference: + + $._ref.google-beta_google_workstations_workstation_config_iam_binding.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_workstations_workstation_config_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block. + - `workstation_config_id` (`string`): Set the `workstation_config_id` 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-beta.google_workstations_workstation_config_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-beta.google_workstations_workstation_config_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_config_iam_binding` +Terraform resource. + +Unlike [google-beta.google_workstations_workstation_config_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object. + - `workstation_config_id` (`string`): Set the `workstation_config_id` 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-beta.google_workstations_workstation_config_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 `google_workstations_workstation_config_iam_binding` resource into the root Terraform configuration. + + +### fn withCondition + +```ts +withCondition() +``` + +`google-beta.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-beta.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-beta.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-beta.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-beta.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-beta.list.withMembers` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the members field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `members` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.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-beta.string.withRole` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role` field. + + +### fn withWorkstationClusterId + +```ts +withWorkstationClusterId() +``` + +`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_cluster_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_cluster_id` field. + + +### fn withWorkstationConfigId + +```ts +withWorkstationConfigId() +``` + +`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_config_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_config_id` field. + + +## obj condition + + + +### fn condition.new + +```ts +new() +``` + + +`google-beta.google_workstations_workstation_config_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/google_workstations_workstation_config_iam_member.md b/docs/4.x/google_workstations_workstation_config_iam_member.md new file mode 100644 index 00000000..2d4e8bde --- /dev/null +++ b/docs/4.x/google_workstations_workstation_config_iam_member.md @@ -0,0 +1,255 @@ +--- +permalink: /google_workstations_workstation_config_iam_member/ +--- + +# google_workstations_workstation_config_iam_member + +`google_workstations_workstation_config_iam_member` represents the `google-beta_google_workstations_workstation_config_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 withProject()`](#fn-withproject) +* [`fn withRole()`](#fn-withrole) +* [`fn withWorkstationClusterId()`](#fn-withworkstationclusterid) +* [`fn withWorkstationConfigId()`](#fn-withworkstationconfigid) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_workstations_workstation_config_iam_member.new` injects a new `google-beta_google_workstations_workstation_config_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-beta.google_workstations_workstation_config_iam_member.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_config_iam_member` using the reference: + + $._ref.google-beta_google_workstations_workstation_config_iam_member.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_workstations_workstation_config_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block. + - `workstation_config_id` (`string`): Set the `workstation_config_id` 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-beta.google_workstations_workstation_config_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-beta.google_workstations_workstation_config_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_config_iam_member` +Terraform resource. + +Unlike [google-beta.google_workstations_workstation_config_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object. + - `workstation_config_id` (`string`): Set the `workstation_config_id` 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-beta.google_workstations_workstation_config_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 `google_workstations_workstation_config_iam_member` resource into the root Terraform configuration. + + +### fn withCondition + +```ts +withCondition() +``` + +`google-beta.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-beta.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-beta.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-beta.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-beta.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-beta.string.withMember` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the member field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `member` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.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-beta.string.withRole` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role` field. + + +### fn withWorkstationClusterId + +```ts +withWorkstationClusterId() +``` + +`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_cluster_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_cluster_id` field. + + +### fn withWorkstationConfigId + +```ts +withWorkstationConfigId() +``` + +`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_config_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_config_id` field. + + +## obj condition + + + +### fn condition.new + +```ts +new() +``` + + +`google-beta.google_workstations_workstation_config_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/google_workstations_workstation_config_iam_policy.md b/docs/4.x/google_workstations_workstation_config_iam_policy.md new file mode 100644 index 00000000..cfcdc0fe --- /dev/null +++ b/docs/4.x/google_workstations_workstation_config_iam_policy.md @@ -0,0 +1,168 @@ +--- +permalink: /google_workstations_workstation_config_iam_policy/ +--- + +# google_workstations_workstation_config_iam_policy + +`google_workstations_workstation_config_iam_policy` represents the `google-beta_google_workstations_workstation_config_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 withPolicyData()`](#fn-withpolicydata) +* [`fn withProject()`](#fn-withproject) +* [`fn withWorkstationClusterId()`](#fn-withworkstationclusterid) +* [`fn withWorkstationConfigId()`](#fn-withworkstationconfigid) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_workstations_workstation_config_iam_policy.new` injects a new `google-beta_google_workstations_workstation_config_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-beta.google_workstations_workstation_config_iam_policy.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_config_iam_policy` using the reference: + + $._ref.google-beta_google_workstations_workstation_config_iam_policy.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_workstations_workstation_config_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block. + - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting resource block. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_workstations_workstation_config_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_config_iam_policy` +Terraform resource. + +Unlike [google-beta.google_workstations_workstation_config_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object. + - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_workstations_workstation_config_iam_policy` resource into the root Terraform configuration. + + +### fn withLocation + +```ts +withLocation() +``` + +`google-beta.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 withPolicyData + +```ts +withPolicyData() +``` + +`google-beta.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-beta.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 withWorkstationClusterId + +```ts +withWorkstationClusterId() +``` + +`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_cluster_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_cluster_id` field. + + +### fn withWorkstationConfigId + +```ts +withWorkstationConfigId() +``` + +`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_config_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_config_id` field. diff --git a/docs/4.x/google_workstations_workstation_iam_binding.md b/docs/4.x/google_workstations_workstation_iam_binding.md new file mode 100644 index 00000000..e17b7c3e --- /dev/null +++ b/docs/4.x/google_workstations_workstation_iam_binding.md @@ -0,0 +1,274 @@ +--- +permalink: /google_workstations_workstation_iam_binding/ +--- + +# google_workstations_workstation_iam_binding + +`google_workstations_workstation_iam_binding` represents the `google-beta_google_workstations_workstation_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 withProject()`](#fn-withproject) +* [`fn withRole()`](#fn-withrole) +* [`fn withWorkstationClusterId()`](#fn-withworkstationclusterid) +* [`fn withWorkstationConfigId()`](#fn-withworkstationconfigid) +* [`fn withWorkstationId()`](#fn-withworkstationid) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_workstations_workstation_iam_binding.new` injects a new `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_iam_binding.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_iam_binding` using the reference: + + $._ref.google-beta_google_workstations_workstation_iam_binding.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_workstations_workstation_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block. + - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting resource block. + - `workstation_id` (`string`): Set the `workstation_id` 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-beta.google_workstations_workstation_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-beta.google_workstations_workstation_iam_binding.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_iam_binding` +Terraform resource. + +Unlike [google-beta.google_workstations_workstation_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object. + - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting object. + - `workstation_id` (`string`): Set the `workstation_id` 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-beta.google_workstations_workstation_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 `google_workstations_workstation_iam_binding` resource into the root Terraform configuration. + + +### fn withCondition + +```ts +withCondition() +``` + +`google-beta.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-beta.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-beta.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-beta.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-beta.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-beta.list.withMembers` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the members field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `members` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.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-beta.string.withRole` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role` field. + + +### fn withWorkstationClusterId + +```ts +withWorkstationClusterId() +``` + +`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_cluster_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_cluster_id` field. + + +### fn withWorkstationConfigId + +```ts +withWorkstationConfigId() +``` + +`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_config_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_config_id` field. + + +### fn withWorkstationId + +```ts +withWorkstationId() +``` + +`google-beta.string.withWorkstationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_id` field. + + +## obj condition + + + +### fn condition.new + +```ts +new() +``` + + +`google-beta.google_workstations_workstation_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/google_workstations_workstation_iam_member.md b/docs/4.x/google_workstations_workstation_iam_member.md new file mode 100644 index 00000000..1022f5ae --- /dev/null +++ b/docs/4.x/google_workstations_workstation_iam_member.md @@ -0,0 +1,274 @@ +--- +permalink: /google_workstations_workstation_iam_member/ +--- + +# google_workstations_workstation_iam_member + +`google_workstations_workstation_iam_member` represents the `google-beta_google_workstations_workstation_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 withProject()`](#fn-withproject) +* [`fn withRole()`](#fn-withrole) +* [`fn withWorkstationClusterId()`](#fn-withworkstationclusterid) +* [`fn withWorkstationConfigId()`](#fn-withworkstationconfigid) +* [`fn withWorkstationId()`](#fn-withworkstationid) +* [`obj condition`](#obj-condition) + * [`fn new()`](#fn-conditionnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_workstations_workstation_iam_member.new` injects a new `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_iam_member.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_iam_member` using the reference: + + $._ref.google-beta_google_workstations_workstation_iam_member.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_workstations_workstation_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block. + - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting resource block. + - `workstation_id` (`string`): Set the `workstation_id` 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-beta.google_workstations_workstation_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-beta.google_workstations_workstation_iam_member.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_iam_member` +Terraform resource. + +Unlike [google-beta.google_workstations_workstation_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object. + - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting object. + - `workstation_id` (`string`): Set the `workstation_id` 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-beta.google_workstations_workstation_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 `google_workstations_workstation_iam_member` resource into the root Terraform configuration. + + +### fn withCondition + +```ts +withCondition() +``` + +`google-beta.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-beta.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-beta.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-beta.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-beta.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-beta.string.withMember` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the member field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `member` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.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-beta.string.withRole` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role` field. + + +### fn withWorkstationClusterId + +```ts +withWorkstationClusterId() +``` + +`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_cluster_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_cluster_id` field. + + +### fn withWorkstationConfigId + +```ts +withWorkstationConfigId() +``` + +`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_config_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_config_id` field. + + +### fn withWorkstationId + +```ts +withWorkstationId() +``` + +`google-beta.string.withWorkstationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_id` field. + + +## obj condition + + + +### fn condition.new + +```ts +new() +``` + + +`google-beta.google_workstations_workstation_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/google_workstations_workstation_iam_policy.md b/docs/4.x/google_workstations_workstation_iam_policy.md new file mode 100644 index 00000000..be865620 --- /dev/null +++ b/docs/4.x/google_workstations_workstation_iam_policy.md @@ -0,0 +1,187 @@ +--- +permalink: /google_workstations_workstation_iam_policy/ +--- + +# google_workstations_workstation_iam_policy + +`google_workstations_workstation_iam_policy` represents the `google-beta_google_workstations_workstation_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 withPolicyData()`](#fn-withpolicydata) +* [`fn withProject()`](#fn-withproject) +* [`fn withWorkstationClusterId()`](#fn-withworkstationclusterid) +* [`fn withWorkstationConfigId()`](#fn-withworkstationconfigid) +* [`fn withWorkstationId()`](#fn-withworkstationid) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_workstations_workstation_iam_policy.new` injects a new `google-beta_google_workstations_workstation_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-beta.google_workstations_workstation_iam_policy.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_workstations_workstation_iam_policy` using the reference: + + $._ref.google-beta_google_workstations_workstation_iam_policy.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_workstations_workstation_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting resource block. + - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting resource block. + - `workstation_id` (`string`): Set the `workstation_id` field on the resulting resource block. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_workstations_workstation_iam_policy.newAttrs` constructs a new object with attributes and blocks configured for the `google_workstations_workstation_iam_policy` +Terraform resource. + +Unlike [google-beta.google_workstations_workstation_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. + - `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. + - `workstation_cluster_id` (`string`): Set the `workstation_cluster_id` field on the resulting object. + - `workstation_config_id` (`string`): Set the `workstation_config_id` field on the resulting object. + - `workstation_id` (`string`): Set the `workstation_id` field on the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_workstations_workstation_iam_policy` resource into the root Terraform configuration. + + +### fn withLocation + +```ts +withLocation() +``` + +`google-beta.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 withPolicyData + +```ts +withPolicyData() +``` + +`google-beta.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-beta.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 withWorkstationClusterId + +```ts +withWorkstationClusterId() +``` + +`google-beta.string.withWorkstationClusterId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_cluster_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_cluster_id` field. + + +### fn withWorkstationConfigId + +```ts +withWorkstationConfigId() +``` + +`google-beta.string.withWorkstationConfigId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_config_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_config_id` field. + + +### fn withWorkstationId + +```ts +withWorkstationId() +``` + +`google-beta.string.withWorkstationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the workstation_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `workstation_id` field. diff --git a/docs/4.x/provider.md b/docs/4.x/provider.md index f348b0c7..2849be4f 100644 --- a/docs/4.x/provider.md +++ b/docs/4.x/provider.md @@ -85,6 +85,7 @@ the `src` and/or `version` parameters are set. - `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. - `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. - `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. + - `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. - `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. - `dataform_custom_endpoint` (`string`): Set the `dataform_custom_endpoint` field on the resulting provider block. When `null`, the `dataform_custom_endpoint` field will be omitted from the resulting object. - `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. @@ -110,6 +111,7 @@ the `src` and/or `version` parameters are set. - `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. - `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. - `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. + - `gkeonprem_custom_endpoint` (`string`): Set the `gkeonprem_custom_endpoint` field on the resulting provider block. When `null`, the `gkeonprem_custom_endpoint` field will be omitted from the resulting object. - `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. - `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. - `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. @@ -250,6 +252,7 @@ injecting into a complete block. - `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. - `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. - `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. + - `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. - `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. - `dataform_custom_endpoint` (`string`): Set the `dataform_custom_endpoint` field on the resulting object. When `null`, the `dataform_custom_endpoint` field will be omitted from the resulting object. - `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. @@ -275,6 +278,7 @@ injecting into a complete block. - `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. - `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. - `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. + - `gkeonprem_custom_endpoint` (`string`): Set the `gkeonprem_custom_endpoint` field on the resulting object. When `null`, the `gkeonprem_custom_endpoint` field will be omitted from the resulting object. - `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. - `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. - `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.