From 2e5b2dd75132c483031e87303250e45bcd80ba96 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" Date: Mon, 13 Nov 2023 20:02:47 +0000 Subject: [PATCH] Generate libsonnet source from libgenerator PR https://github.com/tf-libsonnet/libgenerator/pull/228 Signed-off-by: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> --- 4.x/_gen/main.libsonnet | 1 + 4.x/_gen/provider_google.libsonnet | 8 +- .../assured_workloads_workload.libsonnet | 94 +- .../resources/composer_environment.libsonnet | 36 +- .../compute_backend_service.libsonnet | 4 +- .../resources/container_aws_cluster.libsonnet | 16 +- .../container_aws_node_pool.libsonnet | 2 +- .../container_azure_cluster.libsonnet | 12 +- .../resources/container_cluster.libsonnet | 36 +- .../resources/dialogflow_cx_flow.libsonnet | 18 +- .../resources/dialogflow_cx_intent.libsonnet | 32 +- 4.x/_gen/resources/gke_hub_feature.libsonnet | 106 +- .../gke_hub_feature_membership.libsonnet | 4 +- ...ntegration_connectors_connection.libsonnet | 872 ++++++++ ...ng_billing_account_bucket_config.libsonnet | 38 +- .../logging_folder_bucket_config.libsonnet | 38 +- ...gging_organization_bucket_config.libsonnet | 38 +- .../logging_project_bucket_config.libsonnet | 38 +- .../monitoring_uptime_check_config.libsonnet | 50 +- .../resources/org_policy_policy.libsonnet | 80 +- 4.x/_gen/resources/pubsub_topic.libsonnet | 4 +- 4.x/_gen/resources/spanner_instance.libsonnet | 58 +- .../resources/sql_database_instance.libsonnet | 6 +- .../vertex_ai_index_endpoint.libsonnet | 38 +- docs/4.x/README.md | 1 + docs/4.x/assured_workloads_workload.md | 144 +- docs/4.x/composer_environment.md | 70 +- docs/4.x/compute_backend_service.md | 8 +- docs/4.x/container_aws_cluster.md | 30 +- docs/4.x/container_aws_node_pool.md | 2 +- docs/4.x/container_azure_cluster.md | 26 + docs/4.x/container_cluster.md | 66 + docs/4.x/dialogflow_cx_flow.md | 25 + docs/4.x/dialogflow_cx_intent.md | 56 +- docs/4.x/gke_hub_feature.md | 206 ++ docs/4.x/gke_hub_feature_membership.md | 1 + docs/4.x/integration_connectors_connection.md | 1839 +++++++++++++++++ .../logging_billing_account_bucket_config.md | 69 + docs/4.x/logging_folder_bucket_config.md | 69 + .../4.x/logging_organization_bucket_config.md | 69 + docs/4.x/logging_project_bucket_config.md | 69 + docs/4.x/monitoring_uptime_check_config.md | 74 +- docs/4.x/org_policy_policy.md | 151 ++ docs/4.x/provider.md | 2 + docs/4.x/pubsub_topic.md | 6 +- docs/4.x/spanner_instance.md | 134 ++ docs/4.x/sql_database_instance.md | 3 +- docs/4.x/vertex_ai_index_endpoint.md | 67 + 48 files changed, 4740 insertions(+), 76 deletions(-) create mode 100644 4.x/_gen/resources/integration_connectors_connection.libsonnet create mode 100644 docs/4.x/integration_connectors_connection.md diff --git a/4.x/_gen/main.libsonnet b/4.x/_gen/main.libsonnet index 3654f17f..baaeeacb 100644 --- a/4.x/_gen/main.libsonnet +++ b/4.x/_gen/main.libsonnet @@ -520,6 +520,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); identity_platform_tenant_default_supported_idp_config: (import 'resources/identity_platform_tenant_default_supported_idp_config.libsonnet'), identity_platform_tenant_inbound_saml_config: (import 'resources/identity_platform_tenant_inbound_saml_config.libsonnet'), identity_platform_tenant_oauth_idp_config: (import 'resources/identity_platform_tenant_oauth_idp_config.libsonnet'), + integration_connectors_connection: (import 'resources/integration_connectors_connection.libsonnet'), kms_crypto_key: (import 'resources/kms_crypto_key.libsonnet'), kms_crypto_key_iam_binding: (import 'resources/kms_crypto_key_iam_binding.libsonnet'), kms_crypto_key_iam_member: (import 'resources/kms_crypto_key_iam_member.libsonnet'), diff --git a/4.x/_gen/provider_google.libsonnet b/4.x/_gen/provider_google.libsonnet index b5d8b983..f510398d 100644 --- a/4.x/_gen/provider_google.libsonnet +++ b/4.x/_gen/provider_google.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='provider', url='', help='`provider` represents the `google` Terraform provider config.\n\n\n\nThis package contains functions and utilities for setting up the provider using Jsonnet code.\n'), - '#new':: d.fn(help='\n`google.provider.new` injects a new `google` Terraform `provider`\nblock into the root module document.\n\nOptionally, this inserts the provider into the\n[required_providers](https://developer.hashicorp.com/terraform/language/providers/requirements) `terraform` sub block if\nthe `src` and/or `version` parameters are set.\n\n**Args**:\n - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting provider block. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting provider block. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting provider block. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting provider block. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting provider block. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting provider block. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting provider block. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting provider block. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting provider block. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting provider block. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting provider block. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting provider block. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting provider block. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting provider block. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting provider block. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting provider block. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting provider block. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting provider block. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting provider block. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting provider block. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting provider block. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting provider block. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting provider block. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting provider block. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting provider block. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting provider block. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting provider block. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting provider block. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting provider block. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting provider block. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting provider block. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `data_pipeline_custom_endpoint` (`string`): Set the `data_pipeline_custom_endpoint` field on the resulting provider block. When `null`, the `data_pipeline_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting provider block. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting provider block. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting provider block. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting provider block. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting provider block. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `default_labels` (`obj`): Set the `default_labels` field on the resulting provider block. When `null`, the `default_labels` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting provider block. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting provider block. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `edgecontainer_custom_endpoint` (`string`): Set the `edgecontainer_custom_endpoint` field on the resulting provider block. When `null`, the `edgecontainer_custom_endpoint` field will be omitted from the resulting object.\n - `edgenetwork_custom_endpoint` (`string`): Set the `edgenetwork_custom_endpoint` field on the resulting provider block. When `null`, the `edgenetwork_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting provider block. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting provider block. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting provider block. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting provider block. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting provider block. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting provider block. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting provider block. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `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 - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting provider block. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting provider block. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting provider block. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting provider block. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting provider block. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting provider block. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting provider block. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting provider block. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting provider block. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting provider block. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting provider block. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting provider block. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting provider block. When `null`, the `privateca_custom_endpoint` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting provider block. When `null`, the `project` field will be omitted from the resulting object.\n - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting provider block. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting provider block. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting provider block. When `null`, the `redis_custom_endpoint` field will be omitted from the resulting object.\n - `region` (`string`): Set the `region` field on the resulting provider block. When `null`, the `region` field will be omitted from the resulting object.\n - `request_reason` (`string`): Set the `request_reason` field on the resulting provider block. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting provider block. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting provider block. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting provider block. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting provider block. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting provider block. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting provider block. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting provider block. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting provider block. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting provider block. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting provider block. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting provider block. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_insights_custom_endpoint` (`string`): Set the `storage_insights_custom_endpoint` field on the resulting provider block. When `null`, the `storage_insights_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting provider block. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting provider block. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting provider block. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `universe_domain` (`string`): Set the `universe_domain` field on the resulting provider block. When `null`, the `universe_domain` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting provider block. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting provider block. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting provider block. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting provider block. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting provider block. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting provider block. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n - `alias` (`string`): The provider `alias` to set for this instance of the provider block. When `null`, the `alias`\n field will be omitted from the resulting provider block.\n - `src` (`string`): The provider `source` to set on the resulting `required_providers` block. If `src` or `version` is\n set and is not `null`, a `required_providers` block and entry for the provider will be injected into the document.\n - `version` (`string`): The provider `version` to set on the resulting `required_providers` block. If `src` or\n `version` is set and is not `null`, a `required_providers` block and entry for the provider will be injected into the\n document.\n\n\n**Returns**:\n- A mixin object that injects the new provider (and optionally, `required_providers` block) into the root Terraform configuration.\n', args=[]), + '#new':: d.fn(help='\n`google.provider.new` injects a new `google` Terraform `provider`\nblock into the root module document.\n\nOptionally, this inserts the provider into the\n[required_providers](https://developer.hashicorp.com/terraform/language/providers/requirements) `terraform` sub block if\nthe `src` and/or `version` parameters are set.\n\n**Args**:\n - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting provider block. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting provider block. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting provider block. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting provider block. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting provider block. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting provider block. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting provider block. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting provider block. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting provider block. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting provider block. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting provider block. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting provider block. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting provider block. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting provider block. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting provider block. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting provider block. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting provider block. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting provider block. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting provider block. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting provider block. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting provider block. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting provider block. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting provider block. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting provider block. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting provider block. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting provider block. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting provider block. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting provider block. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting provider block. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting provider block. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting provider block. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting provider block. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting provider block. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting provider block. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `data_pipeline_custom_endpoint` (`string`): Set the `data_pipeline_custom_endpoint` field on the resulting provider block. When `null`, the `data_pipeline_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting provider block. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting provider block. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting provider block. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting provider block. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting provider block. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting provider block. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `default_labels` (`obj`): Set the `default_labels` field on the resulting provider block. When `null`, the `default_labels` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting provider block. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting provider block. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting provider block. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting provider block. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `edgecontainer_custom_endpoint` (`string`): Set the `edgecontainer_custom_endpoint` field on the resulting provider block. When `null`, the `edgecontainer_custom_endpoint` field will be omitted from the resulting object.\n - `edgenetwork_custom_endpoint` (`string`): Set the `edgenetwork_custom_endpoint` field on the resulting provider block. When `null`, the `edgenetwork_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting provider block. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting provider block. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting provider block. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting provider block. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting provider block. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting provider block. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting provider block. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting provider block. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `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 - `integration_connectors_custom_endpoint` (`string`): Set the `integration_connectors_custom_endpoint` field on the resulting provider block. When `null`, the `integration_connectors_custom_endpoint` field will be omitted from the resulting object.\n - `kms_custom_endpoint` (`string`): Set the `kms_custom_endpoint` field on the resulting provider block. When `null`, the `kms_custom_endpoint` field will be omitted from the resulting object.\n - `logging_custom_endpoint` (`string`): Set the `logging_custom_endpoint` field on the resulting provider block. When `null`, the `logging_custom_endpoint` field will be omitted from the resulting object.\n - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting provider block. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting provider block. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting provider block. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting provider block. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting provider block. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting provider block. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting provider block. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting provider block. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting provider block. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting provider block. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting provider block. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting provider block. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting provider block. When `null`, the `privateca_custom_endpoint` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting provider block. When `null`, the `project` field will be omitted from the resulting object.\n - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting provider block. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting provider block. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting provider block. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting provider block. When `null`, the `redis_custom_endpoint` field will be omitted from the resulting object.\n - `region` (`string`): Set the `region` field on the resulting provider block. When `null`, the `region` field will be omitted from the resulting object.\n - `request_reason` (`string`): Set the `request_reason` field on the resulting provider block. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting provider block. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting provider block. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting provider block. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting provider block. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting provider block. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting provider block. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting provider block. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting provider block. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting provider block. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting provider block. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting provider block. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting provider block. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_insights_custom_endpoint` (`string`): Set the `storage_insights_custom_endpoint` field on the resulting provider block. When `null`, the `storage_insights_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting provider block. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting provider block. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting provider block. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting provider block. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `universe_domain` (`string`): Set the `universe_domain` field on the resulting provider block. When `null`, the `universe_domain` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting provider block. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting provider block. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting provider block. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting provider block. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting provider block. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting provider block. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n - `alias` (`string`): The provider `alias` to set for this instance of the provider block. When `null`, the `alias`\n field will be omitted from the resulting provider block.\n - `src` (`string`): The provider `source` to set on the resulting `required_providers` block. If `src` or `version` is\n set and is not `null`, a `required_providers` block and entry for the provider will be injected into the document.\n - `version` (`string`): The provider `version` to set on the resulting `required_providers` block. If `src` or\n `version` is set and is not `null`, a `required_providers` block and entry for the provider will be injected into the\n document.\n\n\n**Returns**:\n- A mixin object that injects the new provider (and optionally, `required_providers` block) into the root Terraform configuration.\n', args=[]), new( access_approval_custom_endpoint=null, access_context_manager_custom_endpoint=null, @@ -92,6 +92,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); identity_platform_custom_endpoint=null, impersonate_service_account=null, impersonate_service_account_delegates=null, + integration_connectors_custom_endpoint=null, kms_custom_endpoint=null, logging_custom_endpoint=null, looker_custom_endpoint=null, @@ -236,6 +237,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); identity_platform_custom_endpoint=identity_platform_custom_endpoint, impersonate_service_account=impersonate_service_account, impersonate_service_account_delegates=impersonate_service_account_delegates, + integration_connectors_custom_endpoint=integration_connectors_custom_endpoint, kms_custom_endpoint=kms_custom_endpoint, logging_custom_endpoint=logging_custom_endpoint, looker_custom_endpoint=looker_custom_endpoint, @@ -285,7 +287,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); zone=zone ) ), - '#newAttrs':: d.fn(help='\n`google.provider.` constructs a new object with attributes and blocks configured for the `google`\nTerraform `provider`.\n\nUnlike [google.provider.new](#fn-googlenew), this function will not inject the `provider`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting object. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting object. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting object. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting object. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting object. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting object. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting object. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting object. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting object. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting object. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting object. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting object. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting object. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting object. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting object. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting object. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting object. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting object. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting object. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting object. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting object. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting object. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting object. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting object. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting object. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting object. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting object. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting object. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting object. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting object. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting object. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting object. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting object. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting object. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting object. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting object. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting object. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting object. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting object. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting object. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting object. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting object. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting object. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting object. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting object. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting object. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `data_pipeline_custom_endpoint` (`string`): Set the `data_pipeline_custom_endpoint` field on the resulting object. When `null`, the `data_pipeline_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting object. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting object. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting object. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting object. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting object. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting object. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting object. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `default_labels` (`obj`): Set the `default_labels` field on the resulting object. When `null`, the `default_labels` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting object. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting object. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting object. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting object. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `edgecontainer_custom_endpoint` (`string`): Set the `edgecontainer_custom_endpoint` field on the resulting object. When `null`, the `edgecontainer_custom_endpoint` field will be omitted from the resulting object.\n - `edgenetwork_custom_endpoint` (`string`): Set the `edgenetwork_custom_endpoint` field on the resulting object. When `null`, the `edgenetwork_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting object. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting object. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting object. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting object. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting object. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting object. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting object. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting object. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting object. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `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 - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting object. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting object. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting object. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting object. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting object. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting object. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting object. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting object. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting object. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting object. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting object. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting object. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting object. When `null`, the `privateca_custom_endpoint` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting object. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting object. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting object. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting object. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting object. When `null`, the `redis_custom_endpoint` field will be omitted from the resulting object.\n - `region` (`string`): Set the `region` field on the resulting object. When `null`, the `region` field will be omitted from the resulting object.\n - `request_reason` (`string`): Set the `request_reason` field on the resulting object. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting object. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting object. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting object. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting object. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting object. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting object. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting object. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting object. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting object. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting object. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting object. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_insights_custom_endpoint` (`string`): Set the `storage_insights_custom_endpoint` field on the resulting object. When `null`, the `storage_insights_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting object. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting object. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting object. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting object. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `universe_domain` (`string`): Set the `universe_domain` field on the resulting object. When `null`, the `universe_domain` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting object. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting object. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting object. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting object. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting object. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting object. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) to construct a new `google` provider\n configuration into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.provider.` constructs a new object with attributes and blocks configured for the `google`\nTerraform `provider`.\n\nUnlike [google.provider.new](#fn-googlenew), this function will not inject the `provider`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `access_approval_custom_endpoint` (`string`): Set the `access_approval_custom_endpoint` field on the resulting object. When `null`, the `access_approval_custom_endpoint` field will be omitted from the resulting object.\n - `access_context_manager_custom_endpoint` (`string`): Set the `access_context_manager_custom_endpoint` field on the resulting object. When `null`, the `access_context_manager_custom_endpoint` field will be omitted from the resulting object.\n - `access_token` (`string`): Set the `access_token` field on the resulting object. When `null`, the `access_token` field will be omitted from the resulting object.\n - `active_directory_custom_endpoint` (`string`): Set the `active_directory_custom_endpoint` field on the resulting object. When `null`, the `active_directory_custom_endpoint` field will be omitted from the resulting object.\n - `alloydb_custom_endpoint` (`string`): Set the `alloydb_custom_endpoint` field on the resulting object. When `null`, the `alloydb_custom_endpoint` field will be omitted from the resulting object.\n - `apigee_custom_endpoint` (`string`): Set the `apigee_custom_endpoint` field on the resulting object. When `null`, the `apigee_custom_endpoint` field will be omitted from the resulting object.\n - `apikeys_custom_endpoint` (`string`): Set the `apikeys_custom_endpoint` field on the resulting object. When `null`, the `apikeys_custom_endpoint` field will be omitted from the resulting object.\n - `app_engine_custom_endpoint` (`string`): Set the `app_engine_custom_endpoint` field on the resulting object. When `null`, the `app_engine_custom_endpoint` field will be omitted from the resulting object.\n - `artifact_registry_custom_endpoint` (`string`): Set the `artifact_registry_custom_endpoint` field on the resulting object. When `null`, the `artifact_registry_custom_endpoint` field will be omitted from the resulting object.\n - `assured_workloads_custom_endpoint` (`string`): Set the `assured_workloads_custom_endpoint` field on the resulting object. When `null`, the `assured_workloads_custom_endpoint` field will be omitted from the resulting object.\n - `beyondcorp_custom_endpoint` (`string`): Set the `beyondcorp_custom_endpoint` field on the resulting object. When `null`, the `beyondcorp_custom_endpoint` field will be omitted from the resulting object.\n - `big_query_custom_endpoint` (`string`): Set the `big_query_custom_endpoint` field on the resulting object. When `null`, the `big_query_custom_endpoint` field will be omitted from the resulting object.\n - `biglake_custom_endpoint` (`string`): Set the `biglake_custom_endpoint` field on the resulting object. When `null`, the `biglake_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_analytics_hub_custom_endpoint` (`string`): Set the `bigquery_analytics_hub_custom_endpoint` field on the resulting object. When `null`, the `bigquery_analytics_hub_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_connection_custom_endpoint` (`string`): Set the `bigquery_connection_custom_endpoint` field on the resulting object. When `null`, the `bigquery_connection_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_data_transfer_custom_endpoint` (`string`): Set the `bigquery_data_transfer_custom_endpoint` field on the resulting object. When `null`, the `bigquery_data_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_datapolicy_custom_endpoint` (`string`): Set the `bigquery_datapolicy_custom_endpoint` field on the resulting object. When `null`, the `bigquery_datapolicy_custom_endpoint` field will be omitted from the resulting object.\n - `bigquery_reservation_custom_endpoint` (`string`): Set the `bigquery_reservation_custom_endpoint` field on the resulting object. When `null`, the `bigquery_reservation_custom_endpoint` field will be omitted from the resulting object.\n - `bigtable_custom_endpoint` (`string`): Set the `bigtable_custom_endpoint` field on the resulting object. When `null`, the `bigtable_custom_endpoint` field will be omitted from the resulting object.\n - `billing_custom_endpoint` (`string`): Set the `billing_custom_endpoint` field on the resulting object. When `null`, the `billing_custom_endpoint` field will be omitted from the resulting object.\n - `billing_project` (`string`): Set the `billing_project` field on the resulting object. When `null`, the `billing_project` field will be omitted from the resulting object.\n - `binary_authorization_custom_endpoint` (`string`): Set the `binary_authorization_custom_endpoint` field on the resulting object. When `null`, the `binary_authorization_custom_endpoint` field will be omitted from the resulting object.\n - `certificate_manager_custom_endpoint` (`string`): Set the `certificate_manager_custom_endpoint` field on the resulting object. When `null`, the `certificate_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_asset_custom_endpoint` (`string`): Set the `cloud_asset_custom_endpoint` field on the resulting object. When `null`, the `cloud_asset_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_billing_custom_endpoint` (`string`): Set the `cloud_billing_custom_endpoint` field on the resulting object. When `null`, the `cloud_billing_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_custom_endpoint` (`string`): Set the `cloud_build_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_build_worker_pool_custom_endpoint` (`string`): Set the `cloud_build_worker_pool_custom_endpoint` field on the resulting object. When `null`, the `cloud_build_worker_pool_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_functions_custom_endpoint` (`string`): Set the `cloud_functions_custom_endpoint` field on the resulting object. When `null`, the `cloud_functions_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_identity_custom_endpoint` (`string`): Set the `cloud_identity_custom_endpoint` field on the resulting object. When `null`, the `cloud_identity_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_ids_custom_endpoint` (`string`): Set the `cloud_ids_custom_endpoint` field on the resulting object. When `null`, the `cloud_ids_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_resource_manager_custom_endpoint` (`string`): Set the `cloud_resource_manager_custom_endpoint` field on the resulting object. When `null`, the `cloud_resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_custom_endpoint` (`string`): Set the `cloud_run_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_run_v2_custom_endpoint` (`string`): Set the `cloud_run_v2_custom_endpoint` field on the resulting object. When `null`, the `cloud_run_v2_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_scheduler_custom_endpoint` (`string`): Set the `cloud_scheduler_custom_endpoint` field on the resulting object. When `null`, the `cloud_scheduler_custom_endpoint` field will be omitted from the resulting object.\n - `cloud_tasks_custom_endpoint` (`string`): Set the `cloud_tasks_custom_endpoint` field on the resulting object. When `null`, the `cloud_tasks_custom_endpoint` field will be omitted from the resulting object.\n - `cloudbuildv2_custom_endpoint` (`string`): Set the `cloudbuildv2_custom_endpoint` field on the resulting object. When `null`, the `cloudbuildv2_custom_endpoint` field will be omitted from the resulting object.\n - `clouddeploy_custom_endpoint` (`string`): Set the `clouddeploy_custom_endpoint` field on the resulting object. When `null`, the `clouddeploy_custom_endpoint` field will be omitted from the resulting object.\n - `cloudfunctions2_custom_endpoint` (`string`): Set the `cloudfunctions2_custom_endpoint` field on the resulting object. When `null`, the `cloudfunctions2_custom_endpoint` field will be omitted from the resulting object.\n - `composer_custom_endpoint` (`string`): Set the `composer_custom_endpoint` field on the resulting object. When `null`, the `composer_custom_endpoint` field will be omitted from the resulting object.\n - `compute_custom_endpoint` (`string`): Set the `compute_custom_endpoint` field on the resulting object. When `null`, the `compute_custom_endpoint` field will be omitted from the resulting object.\n - `container_analysis_custom_endpoint` (`string`): Set the `container_analysis_custom_endpoint` field on the resulting object. When `null`, the `container_analysis_custom_endpoint` field will be omitted from the resulting object.\n - `container_attached_custom_endpoint` (`string`): Set the `container_attached_custom_endpoint` field on the resulting object. When `null`, the `container_attached_custom_endpoint` field will be omitted from the resulting object.\n - `container_aws_custom_endpoint` (`string`): Set the `container_aws_custom_endpoint` field on the resulting object. When `null`, the `container_aws_custom_endpoint` field will be omitted from the resulting object.\n - `container_azure_custom_endpoint` (`string`): Set the `container_azure_custom_endpoint` field on the resulting object. When `null`, the `container_azure_custom_endpoint` field will be omitted from the resulting object.\n - `container_custom_endpoint` (`string`): Set the `container_custom_endpoint` field on the resulting object. When `null`, the `container_custom_endpoint` field will be omitted from the resulting object.\n - `core_billing_custom_endpoint` (`string`): Set the `core_billing_custom_endpoint` field on the resulting object. When `null`, the `core_billing_custom_endpoint` field will be omitted from the resulting object.\n - `credentials` (`string`): Set the `credentials` field on the resulting object. When `null`, the `credentials` field will be omitted from the resulting object.\n - `data_catalog_custom_endpoint` (`string`): Set the `data_catalog_custom_endpoint` field on the resulting object. When `null`, the `data_catalog_custom_endpoint` field will be omitted from the resulting object.\n - `data_fusion_custom_endpoint` (`string`): Set the `data_fusion_custom_endpoint` field on the resulting object. When `null`, the `data_fusion_custom_endpoint` field will be omitted from the resulting object.\n - `data_loss_prevention_custom_endpoint` (`string`): Set the `data_loss_prevention_custom_endpoint` field on the resulting object. When `null`, the `data_loss_prevention_custom_endpoint` field will be omitted from the resulting object.\n - `data_pipeline_custom_endpoint` (`string`): Set the `data_pipeline_custom_endpoint` field on the resulting object. When `null`, the `data_pipeline_custom_endpoint` field will be omitted from the resulting object.\n - `database_migration_service_custom_endpoint` (`string`): Set the `database_migration_service_custom_endpoint` field on the resulting object. When `null`, the `database_migration_service_custom_endpoint` field will be omitted from the resulting object.\n - `dataflow_custom_endpoint` (`string`): Set the `dataflow_custom_endpoint` field on the resulting object. When `null`, the `dataflow_custom_endpoint` field will be omitted from the resulting object.\n - `dataplex_custom_endpoint` (`string`): Set the `dataplex_custom_endpoint` field on the resulting object. When `null`, the `dataplex_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_custom_endpoint` (`string`): Set the `dataproc_custom_endpoint` field on the resulting object. When `null`, the `dataproc_custom_endpoint` field will be omitted from the resulting object.\n - `dataproc_metastore_custom_endpoint` (`string`): Set the `dataproc_metastore_custom_endpoint` field on the resulting object. When `null`, the `dataproc_metastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastore_custom_endpoint` (`string`): Set the `datastore_custom_endpoint` field on the resulting object. When `null`, the `datastore_custom_endpoint` field will be omitted from the resulting object.\n - `datastream_custom_endpoint` (`string`): Set the `datastream_custom_endpoint` field on the resulting object. When `null`, the `datastream_custom_endpoint` field will be omitted from the resulting object.\n - `default_labels` (`obj`): Set the `default_labels` field on the resulting object. When `null`, the `default_labels` field will be omitted from the resulting object.\n - `deployment_manager_custom_endpoint` (`string`): Set the `deployment_manager_custom_endpoint` field on the resulting object. When `null`, the `deployment_manager_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_custom_endpoint` (`string`): Set the `dialogflow_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_custom_endpoint` field will be omitted from the resulting object.\n - `dialogflow_cx_custom_endpoint` (`string`): Set the `dialogflow_cx_custom_endpoint` field on the resulting object. When `null`, the `dialogflow_cx_custom_endpoint` field will be omitted from the resulting object.\n - `dns_custom_endpoint` (`string`): Set the `dns_custom_endpoint` field on the resulting object. When `null`, the `dns_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_custom_endpoint` (`string`): Set the `document_ai_custom_endpoint` field on the resulting object. When `null`, the `document_ai_custom_endpoint` field will be omitted from the resulting object.\n - `document_ai_warehouse_custom_endpoint` (`string`): Set the `document_ai_warehouse_custom_endpoint` field on the resulting object. When `null`, the `document_ai_warehouse_custom_endpoint` field will be omitted from the resulting object.\n - `edgecontainer_custom_endpoint` (`string`): Set the `edgecontainer_custom_endpoint` field on the resulting object. When `null`, the `edgecontainer_custom_endpoint` field will be omitted from the resulting object.\n - `edgenetwork_custom_endpoint` (`string`): Set the `edgenetwork_custom_endpoint` field on the resulting object. When `null`, the `edgenetwork_custom_endpoint` field will be omitted from the resulting object.\n - `essential_contacts_custom_endpoint` (`string`): Set the `essential_contacts_custom_endpoint` field on the resulting object. When `null`, the `essential_contacts_custom_endpoint` field will be omitted from the resulting object.\n - `eventarc_custom_endpoint` (`string`): Set the `eventarc_custom_endpoint` field on the resulting object. When `null`, the `eventarc_custom_endpoint` field will be omitted from the resulting object.\n - `filestore_custom_endpoint` (`string`): Set the `filestore_custom_endpoint` field on the resulting object. When `null`, the `filestore_custom_endpoint` field will be omitted from the resulting object.\n - `firebaserules_custom_endpoint` (`string`): Set the `firebaserules_custom_endpoint` field on the resulting object. When `null`, the `firebaserules_custom_endpoint` field will be omitted from the resulting object.\n - `firestore_custom_endpoint` (`string`): Set the `firestore_custom_endpoint` field on the resulting object. When `null`, the `firestore_custom_endpoint` field will be omitted from the resulting object.\n - `gke_backup_custom_endpoint` (`string`): Set the `gke_backup_custom_endpoint` field on the resulting object. When `null`, the `gke_backup_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub2_custom_endpoint` (`string`): Set the `gke_hub2_custom_endpoint` field on the resulting object. When `null`, the `gke_hub2_custom_endpoint` field will be omitted from the resulting object.\n - `gke_hub_custom_endpoint` (`string`): Set the `gke_hub_custom_endpoint` field on the resulting object. When `null`, the `gke_hub_custom_endpoint` field will be omitted from the resulting object.\n - `gkehub_feature_custom_endpoint` (`string`): Set the `gkehub_feature_custom_endpoint` field on the resulting object. When `null`, the `gkehub_feature_custom_endpoint` field will be omitted from the resulting object.\n - `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 - `integration_connectors_custom_endpoint` (`string`): Set the `integration_connectors_custom_endpoint` field on the resulting object. When `null`, the `integration_connectors_custom_endpoint` field will be omitted from the resulting object.\n - `kms_custom_endpoint` (`string`): Set the `kms_custom_endpoint` field on the resulting object. When `null`, the `kms_custom_endpoint` field will be omitted from the resulting object.\n - `logging_custom_endpoint` (`string`): Set the `logging_custom_endpoint` field on the resulting object. When `null`, the `logging_custom_endpoint` field will be omitted from the resulting object.\n - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting object. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object.\n - `memcache_custom_endpoint` (`string`): Set the `memcache_custom_endpoint` field on the resulting object. When `null`, the `memcache_custom_endpoint` field will be omitted from the resulting object.\n - `ml_engine_custom_endpoint` (`string`): Set the `ml_engine_custom_endpoint` field on the resulting object. When `null`, the `ml_engine_custom_endpoint` field will be omitted from the resulting object.\n - `monitoring_custom_endpoint` (`string`): Set the `monitoring_custom_endpoint` field on the resulting object. When `null`, the `monitoring_custom_endpoint` field will be omitted from the resulting object.\n - `network_connectivity_custom_endpoint` (`string`): Set the `network_connectivity_custom_endpoint` field on the resulting object. When `null`, the `network_connectivity_custom_endpoint` field will be omitted from the resulting object.\n - `network_management_custom_endpoint` (`string`): Set the `network_management_custom_endpoint` field on the resulting object. When `null`, the `network_management_custom_endpoint` field will be omitted from the resulting object.\n - `network_security_custom_endpoint` (`string`): Set the `network_security_custom_endpoint` field on the resulting object. When `null`, the `network_security_custom_endpoint` field will be omitted from the resulting object.\n - `network_services_custom_endpoint` (`string`): Set the `network_services_custom_endpoint` field on the resulting object. When `null`, the `network_services_custom_endpoint` field will be omitted from the resulting object.\n - `notebooks_custom_endpoint` (`string`): Set the `notebooks_custom_endpoint` field on the resulting object. When `null`, the `notebooks_custom_endpoint` field will be omitted from the resulting object.\n - `org_policy_custom_endpoint` (`string`): Set the `org_policy_custom_endpoint` field on the resulting object. When `null`, the `org_policy_custom_endpoint` field will be omitted from the resulting object.\n - `os_config_custom_endpoint` (`string`): Set the `os_config_custom_endpoint` field on the resulting object. When `null`, the `os_config_custom_endpoint` field will be omitted from the resulting object.\n - `os_login_custom_endpoint` (`string`): Set the `os_login_custom_endpoint` field on the resulting object. When `null`, the `os_login_custom_endpoint` field will be omitted from the resulting object.\n - `privateca_custom_endpoint` (`string`): Set the `privateca_custom_endpoint` field on the resulting object. When `null`, the `privateca_custom_endpoint` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `public_ca_custom_endpoint` (`string`): Set the `public_ca_custom_endpoint` field on the resulting object. When `null`, the `public_ca_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_custom_endpoint` (`string`): Set the `pubsub_custom_endpoint` field on the resulting object. When `null`, the `pubsub_custom_endpoint` field will be omitted from the resulting object.\n - `pubsub_lite_custom_endpoint` (`string`): Set the `pubsub_lite_custom_endpoint` field on the resulting object. When `null`, the `pubsub_lite_custom_endpoint` field will be omitted from the resulting object.\n - `recaptcha_enterprise_custom_endpoint` (`string`): Set the `recaptcha_enterprise_custom_endpoint` field on the resulting object. When `null`, the `recaptcha_enterprise_custom_endpoint` field will be omitted from the resulting object.\n - `redis_custom_endpoint` (`string`): Set the `redis_custom_endpoint` field on the resulting object. When `null`, the `redis_custom_endpoint` field will be omitted from the resulting object.\n - `region` (`string`): Set the `region` field on the resulting object. When `null`, the `region` field will be omitted from the resulting object.\n - `request_reason` (`string`): Set the `request_reason` field on the resulting object. When `null`, the `request_reason` field will be omitted from the resulting object.\n - `request_timeout` (`string`): Set the `request_timeout` field on the resulting object. When `null`, the `request_timeout` field will be omitted from the resulting object.\n - `resource_manager_custom_endpoint` (`string`): Set the `resource_manager_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_custom_endpoint` field will be omitted from the resulting object.\n - `resource_manager_v3_custom_endpoint` (`string`): Set the `resource_manager_v3_custom_endpoint` field on the resulting object. When `null`, the `resource_manager_v3_custom_endpoint` field will be omitted from the resulting object.\n - `scopes` (`list`): Set the `scopes` field on the resulting object. When `null`, the `scopes` field will be omitted from the resulting object.\n - `secret_manager_custom_endpoint` (`string`): Set the `secret_manager_custom_endpoint` field on the resulting object. When `null`, the `secret_manager_custom_endpoint` field will be omitted from the resulting object.\n - `security_center_custom_endpoint` (`string`): Set the `security_center_custom_endpoint` field on the resulting object. When `null`, the `security_center_custom_endpoint` field will be omitted from the resulting object.\n - `service_management_custom_endpoint` (`string`): Set the `service_management_custom_endpoint` field on the resulting object. When `null`, the `service_management_custom_endpoint` field will be omitted from the resulting object.\n - `service_networking_custom_endpoint` (`string`): Set the `service_networking_custom_endpoint` field on the resulting object. When `null`, the `service_networking_custom_endpoint` field will be omitted from the resulting object.\n - `service_usage_custom_endpoint` (`string`): Set the `service_usage_custom_endpoint` field on the resulting object. When `null`, the `service_usage_custom_endpoint` field will be omitted from the resulting object.\n - `source_repo_custom_endpoint` (`string`): Set the `source_repo_custom_endpoint` field on the resulting object. When `null`, the `source_repo_custom_endpoint` field will be omitted from the resulting object.\n - `spanner_custom_endpoint` (`string`): Set the `spanner_custom_endpoint` field on the resulting object. When `null`, the `spanner_custom_endpoint` field will be omitted from the resulting object.\n - `sql_custom_endpoint` (`string`): Set the `sql_custom_endpoint` field on the resulting object. When `null`, the `sql_custom_endpoint` field will be omitted from the resulting object.\n - `storage_custom_endpoint` (`string`): Set the `storage_custom_endpoint` field on the resulting object. When `null`, the `storage_custom_endpoint` field will be omitted from the resulting object.\n - `storage_insights_custom_endpoint` (`string`): Set the `storage_insights_custom_endpoint` field on the resulting object. When `null`, the `storage_insights_custom_endpoint` field will be omitted from the resulting object.\n - `storage_transfer_custom_endpoint` (`string`): Set the `storage_transfer_custom_endpoint` field on the resulting object. When `null`, the `storage_transfer_custom_endpoint` field will be omitted from the resulting object.\n - `tags_custom_endpoint` (`string`): Set the `tags_custom_endpoint` field on the resulting object. When `null`, the `tags_custom_endpoint` field will be omitted from the resulting object.\n - `tags_location_custom_endpoint` (`string`): Set the `tags_location_custom_endpoint` field on the resulting object. When `null`, the `tags_location_custom_endpoint` field will be omitted from the resulting object.\n - `tpu_custom_endpoint` (`string`): Set the `tpu_custom_endpoint` field on the resulting object. When `null`, the `tpu_custom_endpoint` field will be omitted from the resulting object.\n - `universe_domain` (`string`): Set the `universe_domain` field on the resulting object. When `null`, the `universe_domain` field will be omitted from the resulting object.\n - `user_project_override` (`bool`): Set the `user_project_override` field on the resulting object. When `null`, the `user_project_override` field will be omitted from the resulting object.\n - `vertex_ai_custom_endpoint` (`string`): Set the `vertex_ai_custom_endpoint` field on the resulting object. When `null`, the `vertex_ai_custom_endpoint` field will be omitted from the resulting object.\n - `vpc_access_custom_endpoint` (`string`): Set the `vpc_access_custom_endpoint` field on the resulting object. When `null`, the `vpc_access_custom_endpoint` field will be omitted from the resulting object.\n - `workflows_custom_endpoint` (`string`): Set the `workflows_custom_endpoint` field on the resulting object. When `null`, the `workflows_custom_endpoint` field will be omitted from the resulting object.\n - `zone` (`string`): Set the `zone` field on the resulting object. When `null`, the `zone` field will be omitted from the resulting object.\n - `batching` (`list[obj]`): Set the `batching` field on the resulting object. When `null`, the `batching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.provider.batching.new](#fn-googlebatchingnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) to construct a new `google` provider\n configuration into the root Terraform configuration.\n', args=[]), newAttrs( access_approval_custom_endpoint=null, access_context_manager_custom_endpoint=null, @@ -375,6 +377,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); identity_platform_custom_endpoint=null, impersonate_service_account=null, impersonate_service_account_delegates=null, + integration_connectors_custom_endpoint=null, kms_custom_endpoint=null, logging_custom_endpoint=null, looker_custom_endpoint=null, @@ -511,6 +514,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); identity_platform_custom_endpoint: identity_platform_custom_endpoint, impersonate_service_account: impersonate_service_account, impersonate_service_account_delegates: impersonate_service_account_delegates, + integration_connectors_custom_endpoint: integration_connectors_custom_endpoint, kms_custom_endpoint: kms_custom_endpoint, logging_custom_endpoint: logging_custom_endpoint, looker_custom_endpoint: looker_custom_endpoint, diff --git a/4.x/_gen/resources/assured_workloads_workload.libsonnet b/4.x/_gen/resources/assured_workloads_workload.libsonnet index 15d672fe..1dcbfe1d 100644 --- a/4.x/_gen/resources/assured_workloads_workload.libsonnet +++ b/4.x/_gen/resources/assured_workloads_workload.libsonnet @@ -12,19 +12,23 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); rotation_period: rotation_period, }), }, - '#new':: d.fn(help="\n`google.assured_workloads_workload.new` injects a new `google_assured_workloads_workload` 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.assured_workloads_workload.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.assured_workloads_workload` using the reference:\n\n $._ref.google_assured_workloads_workload.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_assured_workloads_workload.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 - `billing_account` (`string`): Required. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, \u0026#39;billingAccounts/012345-567890-ABCDEF`.\n - `compliance_regime` (`string`): Required. Immutable. Compliance Regime associated with this workload. Possible values: COMPLIANCE_REGIME_UNSPECIFIED, IL4, CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, US_REGIONAL_ACCESS, HIPAA, EU_REGIONS_AND_SUPPORT, CA_REGIONS_AND_SUPPORT, ITAR, AU_REGIONS_AND_US_SUPPORT, ASSURED_WORKLOADS_FOR_PARTNERS\n - `display_name` (`string`): Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload\n - `labels` (`obj`): Optional. Labels applied to the workload.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field `effective_labels` for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `organization` (`string`): The organization for the resource\n - `provisioned_resources_parent` (`string`): Input only. The parent resource for the resources managed by this Assured Workload. May be either an organization or a folder. Must be the same or a child of the Workload parent. If not specified all resources are created under the Workload parent. Formats: folders/{folder_id}, organizations/{organization_id} When `null`, the `provisioned_resources_parent` field will be omitted from the resulting object.\n - `kms_settings` (`list[obj]`): Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. When `null`, the `kms_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.assured_workloads_workload.kms_settings.new](#fn-kms_settingsnew) constructor.\n - `resource_settings` (`list[obj]`): Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. When `null`, the `resource_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.assured_workloads_workload.resource_settings.new](#fn-resource_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.assured_workloads_workload.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.assured_workloads_workload.new` injects a new `google_assured_workloads_workload` 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.assured_workloads_workload.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.assured_workloads_workload` using the reference:\n\n $._ref.google_assured_workloads_workload.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_assured_workloads_workload.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 - `billing_account` (`string`): Optional. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. When `null`, the `billing_account` field will be omitted from the resulting object.\n - `compliance_regime` (`string`): Required. Immutable. Compliance Regime associated with this workload. Possible values: COMPLIANCE_REGIME_UNSPECIFIED, IL4, CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, US_REGIONAL_ACCESS, HIPAA, HITRUST, EU_REGIONS_AND_SUPPORT, CA_REGIONS_AND_SUPPORT, ITAR, AU_REGIONS_AND_US_SUPPORT, ASSURED_WORKLOADS_FOR_PARTNERS, ISR_REGIONS, ISR_REGIONS_AND_SUPPORT, CA_PROTECTED_B, IL5, IL2, JP_REGIONS_AND_SUPPORT\n - `display_name` (`string`): Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload\n - `enable_sovereign_controls` (`bool`): Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. When `null`, the `enable_sovereign_controls` field will be omitted from the resulting object.\n - `labels` (`obj`): Optional. Labels applied to the workload.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field `effective_labels` for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `organization` (`string`): The organization for the resource\n - `partner` (`string`): Optional. Partner regime associated with this workload. Possible values: PARTNER_UNSPECIFIED, LOCAL_CONTROLS_BY_S3NS, SOVEREIGN_CONTROLS_BY_T_SYSTEMS, SOVEREIGN_CONTROLS_BY_SIA_MINSAIT, SOVEREIGN_CONTROLS_BY_PSN When `null`, the `partner` field will be omitted from the resulting object.\n - `provisioned_resources_parent` (`string`): Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} When `null`, the `provisioned_resources_parent` field will be omitted from the resulting object.\n - `violation_notifications_enabled` (`bool`): Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload. When `null`, the `violation_notifications_enabled` field will be omitted from the resulting object.\n - `kms_settings` (`list[obj]`): **DEPRECATED** Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field. When `null`, the `kms_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.assured_workloads_workload.kms_settings.new](#fn-kms_settingsnew) constructor.\n - `partner_permissions` (`list[obj]`): Optional. Permissions granted to the AW Partner SA account for the customer workload When `null`, the `partner_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.assured_workloads_workload.partner_permissions.new](#fn-partner_permissionsnew) constructor.\n - `resource_settings` (`list[obj]`): Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. When `null`, the `resource_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.assured_workloads_workload.resource_settings.new](#fn-resource_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.assured_workloads_workload.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_account, compliance_regime, display_name, location, organization, + billing_account=null, + enable_sovereign_controls=null, kms_settings=null, labels=null, + partner=null, + partner_permissions=null, provisioned_resources_parent=null, resource_settings=null, timeouts=null, + violation_notifications_enabled=null, _meta={} ):: tf.withResource( type='google_assured_workloads_workload', @@ -33,46 +37,72 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); billing_account=billing_account, compliance_regime=compliance_regime, display_name=display_name, + enable_sovereign_controls=enable_sovereign_controls, kms_settings=kms_settings, labels=labels, location=location, organization=organization, + partner=partner, + partner_permissions=partner_permissions, provisioned_resources_parent=provisioned_resources_parent, resource_settings=resource_settings, - timeouts=timeouts + timeouts=timeouts, + violation_notifications_enabled=violation_notifications_enabled ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.assured_workloads_workload.newAttrs` constructs a new object with attributes and blocks configured for the `assured_workloads_workload`\nTerraform resource.\n\nUnlike [google.assured_workloads_workload.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 - `billing_account` (`string`): Required. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, 'billingAccounts/012345-567890-ABCDEF`.\n - `compliance_regime` (`string`): Required. Immutable. Compliance Regime associated with this workload. Possible values: COMPLIANCE_REGIME_UNSPECIFIED, IL4, CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, US_REGIONAL_ACCESS, HIPAA, EU_REGIONS_AND_SUPPORT, CA_REGIONS_AND_SUPPORT, ITAR, AU_REGIONS_AND_US_SUPPORT, ASSURED_WORKLOADS_FOR_PARTNERS\n - `display_name` (`string`): Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload\n - `labels` (`obj`): Optional. Labels applied to the workload.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field `effective_labels` for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `organization` (`string`): The organization for the resource\n - `provisioned_resources_parent` (`string`): Input only. The parent resource for the resources managed by this Assured Workload. May be either an organization or a folder. Must be the same or a child of the Workload parent. If not specified all resources are created under the Workload parent. Formats: folders/{folder_id}, organizations/{organization_id} When `null`, the `provisioned_resources_parent` field will be omitted from the resulting object.\n - `kms_settings` (`list[obj]`): Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. When `null`, the `kms_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.assured_workloads_workload.kms_settings.new](#fn-kms_settingsnew) constructor.\n - `resource_settings` (`list[obj]`): Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. When `null`, the `resource_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.assured_workloads_workload.resource_settings.new](#fn-resource_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.assured_workloads_workload.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 `assured_workloads_workload` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.assured_workloads_workload.newAttrs` constructs a new object with attributes and blocks configured for the `assured_workloads_workload`\nTerraform resource.\n\nUnlike [google.assured_workloads_workload.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 - `billing_account` (`string`): Optional. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. When `null`, the `billing_account` field will be omitted from the resulting object.\n - `compliance_regime` (`string`): Required. Immutable. Compliance Regime associated with this workload. Possible values: COMPLIANCE_REGIME_UNSPECIFIED, IL4, CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, US_REGIONAL_ACCESS, HIPAA, HITRUST, EU_REGIONS_AND_SUPPORT, CA_REGIONS_AND_SUPPORT, ITAR, AU_REGIONS_AND_US_SUPPORT, ASSURED_WORKLOADS_FOR_PARTNERS, ISR_REGIONS, ISR_REGIONS_AND_SUPPORT, CA_PROTECTED_B, IL5, IL2, JP_REGIONS_AND_SUPPORT\n - `display_name` (`string`): Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload\n - `enable_sovereign_controls` (`bool`): Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. When `null`, the `enable_sovereign_controls` field will be omitted from the resulting object.\n - `labels` (`obj`): Optional. Labels applied to the workload.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field `effective_labels` for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `organization` (`string`): The organization for the resource\n - `partner` (`string`): Optional. Partner regime associated with this workload. Possible values: PARTNER_UNSPECIFIED, LOCAL_CONTROLS_BY_S3NS, SOVEREIGN_CONTROLS_BY_T_SYSTEMS, SOVEREIGN_CONTROLS_BY_SIA_MINSAIT, SOVEREIGN_CONTROLS_BY_PSN When `null`, the `partner` field will be omitted from the resulting object.\n - `provisioned_resources_parent` (`string`): Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} When `null`, the `provisioned_resources_parent` field will be omitted from the resulting object.\n - `violation_notifications_enabled` (`bool`): Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload. When `null`, the `violation_notifications_enabled` field will be omitted from the resulting object.\n - `kms_settings` (`list[obj]`): **DEPRECATED** Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field. When `null`, the `kms_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.assured_workloads_workload.kms_settings.new](#fn-kms_settingsnew) constructor.\n - `partner_permissions` (`list[obj]`): Optional. Permissions granted to the AW Partner SA account for the customer workload When `null`, the `partner_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.assured_workloads_workload.partner_permissions.new](#fn-partner_permissionsnew) constructor.\n - `resource_settings` (`list[obj]`): Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. When `null`, the `resource_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.assured_workloads_workload.resource_settings.new](#fn-resource_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.assured_workloads_workload.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 `assured_workloads_workload` resource into the root Terraform configuration.\n', args=[]), newAttrs( - billing_account, compliance_regime, display_name, location, organization, + billing_account=null, + enable_sovereign_controls=null, kms_settings=null, labels=null, + partner=null, + partner_permissions=null, provisioned_resources_parent=null, resource_settings=null, - timeouts=null + timeouts=null, + violation_notifications_enabled=null ):: std.prune(a={ billing_account: billing_account, compliance_regime: compliance_regime, display_name: display_name, + enable_sovereign_controls: enable_sovereign_controls, kms_settings: kms_settings, labels: labels, location: location, organization: organization, + partner: partner, + partner_permissions: partner_permissions, provisioned_resources_parent: provisioned_resources_parent, resource_settings: resource_settings, timeouts: timeouts, + violation_notifications_enabled: violation_notifications_enabled, }), + partner_permissions:: { + '#new':: d.fn(help='\n`google.assured_workloads_workload.partner_permissions.new` constructs a new object with attributes and blocks configured for the `partner_permissions`\nTerraform sub block.\n\n\n\n**Args**:\n - `assured_workloads_monitoring` (`bool`): Optional. Allow partner to view violation alerts. When `null`, the `assured_workloads_monitoring` field will be omitted from the resulting object.\n - `data_logs_viewer` (`bool`): Allow the partner to view inspectability logs and monitoring violations. When `null`, the `data_logs_viewer` field will be omitted from the resulting object.\n - `service_access_approver` (`bool`): Optional. Allow partner to view access approval logs. When `null`, the `service_access_approver` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `partner_permissions` sub block.\n', args=[]), + new( + assured_workloads_monitoring=null, + data_logs_viewer=null, + service_access_approver=null + ):: std.prune(a={ + assured_workloads_monitoring: assured_workloads_monitoring, + data_logs_viewer: data_logs_viewer, + service_access_approver: service_access_approver, + }), + }, resource_settings:: { - '#new':: d.fn(help='\n`google.assured_workloads_workload.resource_settings.new` constructs a new object with attributes and blocks configured for the `resource_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `resource_id` (`string`): Resource identifier. For a project this represents project_number. If the project is already taken, the workload creation will fail. When `null`, the `resource_id` field will be omitted from the resulting object.\n - `resource_type` (`string`): Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT) Possible values: RESOURCE_TYPE_UNSPECIFIED, CONSUMER_PROJECT, ENCRYPTION_KEYS_PROJECT, KEYRING, CONSUMER_FOLDER When `null`, the `resource_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `resource_settings` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.assured_workloads_workload.resource_settings.new` constructs a new object with attributes and blocks configured for the `resource_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `display_name` (`string`): User-assigned resource display name. If not empty it will be used to create a resource with the specified name. When `null`, the `display_name` field will be omitted from the resulting object.\n - `resource_id` (`string`): Resource identifier. For a project this represents projectId. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google. When `null`, the `resource_id` field will be omitted from the resulting object.\n - `resource_type` (`string`): Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT) Possible values: RESOURCE_TYPE_UNSPECIFIED, CONSUMER_PROJECT, ENCRYPTION_KEYS_PROJECT, KEYRING, CONSUMER_FOLDER When `null`, the `resource_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `resource_settings` sub block.\n', args=[]), new( + display_name=null, resource_id=null, resource_type=null ):: std.prune(a={ + display_name: display_name, resource_id: resource_id, resource_type: resource_type, }), @@ -119,6 +149,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withEnableSovereignControls':: d.fn(help='`google.bool.withEnableSovereignControls` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the enable_sovereign_controls 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_sovereign_controls` field.\n', args=[]), + withEnableSovereignControls(resourceLabel, value): { + resource+: { + google_assured_workloads_workload+: { + [resourceLabel]+: { + enable_sovereign_controls: value, + }, + }, + }, + }, '#withKmsSettings':: d.fn(help='`google.list[obj].withKmsSettings` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the kms_settings field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withKmsSettingsMixin](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 `kms_settings` field.\n', args=[]), withKmsSettings(resourceLabel, value): { resource+: { @@ -169,6 +209,36 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withPartner':: d.fn(help='`google.string.withPartner` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the partner 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 `partner` field.\n', args=[]), + withPartner(resourceLabel, value): { + resource+: { + google_assured_workloads_workload+: { + [resourceLabel]+: { + partner: value, + }, + }, + }, + }, + '#withPartnerPermissions':: d.fn(help='`google.list[obj].withPartnerPermissions` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the partner_permissions field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withPartnerPermissionsMixin](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 `partner_permissions` field.\n', args=[]), + withPartnerPermissions(resourceLabel, value): { + resource+: { + google_assured_workloads_workload+: { + [resourceLabel]+: { + partner_permissions: value, + }, + }, + }, + }, + '#withPartnerPermissionsMixin':: d.fn(help='`google.list[obj].withPartnerPermissionsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the partner_permissions field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withPartnerPermissions](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 `partner_permissions` field.\n', args=[]), + withPartnerPermissionsMixin(resourceLabel, value): { + resource+: { + google_assured_workloads_workload+: { + [resourceLabel]+: { + partner_permissions+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withProvisionedResourcesParent':: d.fn(help='`google.string.withProvisionedResourcesParent` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the provisioned_resources_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 `provisioned_resources_parent` field.\n', args=[]), withProvisionedResourcesParent(resourceLabel, value): { resource+: { @@ -219,4 +289,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withViolationNotificationsEnabled':: d.fn(help='`google.bool.withViolationNotificationsEnabled` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the violation_notifications_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 `violation_notifications_enabled` field.\n', args=[]), + withViolationNotificationsEnabled(resourceLabel, value): { + resource+: { + google_assured_workloads_workload+: { + [resourceLabel]+: { + violation_notifications_enabled: value, + }, + }, + }, + }, } diff --git a/4.x/_gen/resources/composer_environment.libsonnet b/4.x/_gen/resources/composer_environment.libsonnet index 907c43c2..f45e5df4 100644 --- a/4.x/_gen/resources/composer_environment.libsonnet +++ b/4.x/_gen/resources/composer_environment.libsonnet @@ -266,7 +266,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, - '#new':: d.fn(help="\n`google.composer_environment.new` injects a new `google_composer_environment` 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.composer_environment.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.composer_environment` using the reference:\n\n $._ref.google_composer_environment.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_composer_environment.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 - `labels` (`obj`): User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be \u0026lt;= 128 bytes in size.\n\t\t\t\t\n\t\t\t\t**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\n\t\t\t\tPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the environment.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The location or Compute Engine region for the environment. When `null`, the `region` field will be omitted from the resulting object.\n - `config` (`list[obj]`): Configuration parameters for this environment. 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.composer_environment.config.new](#fn-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.composer_environment.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.composer_environment.new` injects a new `google_composer_environment` 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.composer_environment.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.composer_environment` using the reference:\n\n $._ref.google_composer_environment.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_composer_environment.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 - `labels` (`obj`): User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be \u0026lt;= 128 bytes in size.\n\n\t\t\t\t**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\n\t\t\t\tPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the environment.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The location or Compute Engine region for the environment. When `null`, the `region` field will be omitted from the resulting object.\n - `config` (`list[obj]`): Configuration parameters for this environment. 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.composer_environment.config.new](#fn-confignew) constructor.\n - `storage_config` (`list[obj]`): Configuration options for storage used by Composer environment. 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.composer_environment.storage_config.new](#fn-storage_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.composer_environment.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, @@ -274,6 +274,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); labels=null, project=null, region=null, + storage_config=null, timeouts=null, _meta={} ):: tf.withResource( @@ -285,17 +286,19 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); name=name, project=project, region=region, + storage_config=storage_config, timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.composer_environment.newAttrs` constructs a new object with attributes and blocks configured for the `composer_environment`\nTerraform resource.\n\nUnlike [google.composer_environment.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 - `labels` (`obj`): User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.\n\t\t\t\t\n\t\t\t\t**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\n\t\t\t\tPlease refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the environment.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The location or Compute Engine region for the environment. When `null`, the `region` field will be omitted from the resulting object.\n - `config` (`list[obj]`): Configuration parameters for this environment. 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.composer_environment.config.new](#fn-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.composer_environment.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 `composer_environment` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.composer_environment.newAttrs` constructs a new object with attributes and blocks configured for the `composer_environment`\nTerraform resource.\n\nUnlike [google.composer_environment.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 - `labels` (`obj`): User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.\n\n\t\t\t\t**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\n\t\t\t\tPlease refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `name` (`string`): Name of the environment.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): The location or Compute Engine region for the environment. When `null`, the `region` field will be omitted from the resulting object.\n - `config` (`list[obj]`): Configuration parameters for this environment. 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.composer_environment.config.new](#fn-confignew) constructor.\n - `storage_config` (`list[obj]`): Configuration options for storage used by Composer environment. 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.composer_environment.storage_config.new](#fn-storage_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.composer_environment.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 `composer_environment` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, config=null, labels=null, project=null, region=null, + storage_config=null, timeouts=null ):: std.prune(a={ config: config, @@ -303,8 +306,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); name: name, project: project, region: region, + storage_config: storage_config, timeouts: timeouts, }), + storage_config:: { + '#new':: d.fn(help='\n`google.composer_environment.storage_config.new` constructs a new object with attributes and blocks configured for the `storage_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `bucket` (`string`): Optional. Name of an existing Cloud Storage bucket to be used by the environment.\n\n**Returns**:\n - An attribute object that represents the `storage_config` sub block.\n', args=[]), + new( + bucket + ):: std.prune(a={ + bucket: bucket, + }), + }, timeouts:: { '#new':: d.fn(help='\n`google.composer_environment.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( @@ -377,6 +389,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withStorageConfig':: d.fn(help='`google.list[obj].withStorageConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the storage_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withStorageConfigMixin](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_config` field.\n', args=[]), + withStorageConfig(resourceLabel, value): { + resource+: { + google_composer_environment+: { + [resourceLabel]+: { + storage_config: value, + }, + }, + }, + }, + '#withStorageConfigMixin':: d.fn(help='`google.list[obj].withStorageConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the storage_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withStorageConfig](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_config` field.\n', args=[]), + withStorageConfigMixin(resourceLabel, value): { + resource+: { + google_composer_environment+: { + [resourceLabel]+: { + storage_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), withTimeouts(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/compute_backend_service.libsonnet b/4.x/_gen/resources/compute_backend_service.libsonnet index 87975d99..357a0d9a 100644 --- a/4.x/_gen/resources/compute_backend_service.libsonnet +++ b/4.x/_gen/resources/compute_backend_service.libsonnet @@ -192,7 +192,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); sample_rate: sample_rate, }), }, - '#new':: d.fn(help="\n`google.compute_backend_service.new` injects a new `google_compute_backend_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.compute_backend_service.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_backend_service` using the reference:\n\n $._ref.google_compute_backend_service.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_backend_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 - `affinity_cookie_ttl_sec` (`number`): Lifetime of cookies in seconds if session_affinity is\nGENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts\nonly until the end of the browser session (or equivalent). The\nmaximum allowed value for TTL is one day.\n\nWhen the load balancing scheme is INTERNAL, this field is not used. When `null`, the `affinity_cookie_ttl_sec` field will be omitted from the resulting object.\n - `compression_mode` (`string`): Compress text responses using Brotli or gzip compression, based on the client\u0026#39;s Accept-Encoding header. Possible values: [\u0026#34;AUTOMATIC\u0026#34;, \u0026#34;DISABLED\u0026#34;] When `null`, the `compression_mode` field will be omitted from the resulting object.\n - `connection_draining_timeout_sec` (`number`): Time for which instance will be drained (not accept new\nconnections, but still work to finish started). When `null`, the `connection_draining_timeout_sec` field will be omitted from the resulting object.\n - `custom_request_headers` (`list`): Headers that the HTTP/S load balancer should add to proxied\nrequests. When `null`, the `custom_request_headers` field will be omitted from the resulting object.\n - `custom_response_headers` (`list`): Headers that the HTTP/S load balancer should add to proxied\nresponses. When `null`, the `custom_response_headers` 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 - `edge_security_policy` (`string`): The resource URL for the edge security policy associated with this backend service. When `null`, the `edge_security_policy` field will be omitted from the resulting object.\n - `enable_cdn` (`bool`): If true, enable Cloud CDN for this BackendService. When `null`, the `enable_cdn` field will be omitted from the resulting object.\n - `health_checks` (`list`): The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource\nfor health checking this BackendService. Currently at most one health\ncheck can be specified.\n\nA health check must be specified unless the backend service uses an internet\nor serverless NEG as a backend.\n\nFor internal load balancing, a URL to a HealthCheck resource must be specified instead. When `null`, the `health_checks` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Indicates whether the backend service will be used with internal or\nexternal load balancing. A backend service created for one type of\nload balancing cannot be used with the other. For more information, refer to\n[Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). Default value: \u0026#34;EXTERNAL\u0026#34; Possible values: [\u0026#34;EXTERNAL\u0026#34;, \u0026#34;INTERNAL_SELF_MANAGED\u0026#34;, \u0026#34;INTERNAL_MANAGED\u0026#34;, \u0026#34;EXTERNAL_MANAGED\u0026#34;] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `locality_lb_policy` (`string`): The load balancing algorithm used within the scope of the locality.\nThe possible values are:\n\n* \u0026#39;ROUND_ROBIN\u0026#39;: This is a simple policy in which each healthy backend\n is selected in round robin order.\n\n* \u0026#39;LEAST_REQUEST\u0026#39;: An O(1) algorithm which selects two random healthy\n hosts and picks the host which has fewer active requests.\n\n* \u0026#39;RING_HASH\u0026#39;: The ring/modulo hash load balancer implements consistent\n hashing to backends. The algorithm has the property that the\n addition/removal of a host from a set of N hosts only affects\n 1/N of the requests.\n\n* \u0026#39;RANDOM\u0026#39;: The load balancer selects a random healthy host.\n\n* \u0026#39;ORIGINAL_DESTINATION\u0026#39;: Backend host is selected based on the client\n connection metadata, i.e., connections are opened\n to the same address as the destination address of\n the incoming connection before the connection\n was redirected to the load balancer.\n\n* \u0026#39;MAGLEV\u0026#39;: used as a drop in replacement for the ring hash load balancer.\n Maglev is not as stable as ring hash but has faster table lookup\n build times and host selection times. For more information about\n Maglev, refer to https://ai.google/research/pubs/pub44824\n\n* \u0026#39;WEIGHTED_MAGLEV\u0026#39;: Per-instance weighted Load Balancing via health check\n reported weights. If set, the Backend Service must\n configure a non legacy HTTP-based Health Check, and\n health check replies are expected to contain\n non-standard HTTP response header field\n X-Load-Balancing-Endpoint-Weight to specify the\n per-instance weights. If set, Load Balancing is weight\n based on the per-instance weights reported in the last\n processed health check replies, as long as every\n instance either reported a valid weight or had\n UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains\n equal-weight.\n\n\nThis field is applicable to either:\n\n* A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2,\n and loadBalancingScheme set to INTERNAL_MANAGED.\n* A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.\n* A regional backend service with loadBalancingScheme set to EXTERNAL (External Network\n Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External\n Network Load Balancing. The default is MAGLEV.\n\n\nIf session_affinity is not NONE, and this field is not set to MAGLEV, WEIGHTED_MAGLEV,\nor RING_HASH, session affinity settings will not take effect.\n\nOnly ROUND_ROBIN and RING_HASH are supported when the backend service is referenced\nby a URL map that is bound to target gRPC proxy that has validate_for_proxyless\nfield set to true. Possible values: [\u0026#34;ROUND_ROBIN\u0026#34;, \u0026#34;LEAST_REQUEST\u0026#34;, \u0026#34;RING_HASH\u0026#34;, \u0026#34;RANDOM\u0026#34;, \u0026#34;ORIGINAL_DESTINATION\u0026#34;, \u0026#34;MAGLEV\u0026#34;, \u0026#34;WEIGHTED_MAGLEV\u0026#34;] When `null`, the `locality_lb_policy` 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 - `port_name` (`string`): Name of backend port. The same name should appear in the instance\ngroups referenced by this service. Required when the load balancing\nscheme is EXTERNAL. When `null`, the `port_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 - `protocol` (`string`): The protocol this BackendService uses to communicate with backends.\nThe default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer\ntypes and may result in errors if used with the GA API. **NOTE**: With protocol “UNSPECIFIED”,\nthe backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing\nwith TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values: [\u0026#34;HTTP\u0026#34;, \u0026#34;HTTPS\u0026#34;, \u0026#34;HTTP2\u0026#34;, \u0026#34;TCP\u0026#34;, \u0026#34;SSL\u0026#34;, \u0026#34;GRPC\u0026#34;, \u0026#34;UNSPECIFIED\u0026#34;] When `null`, the `protocol` field will be omitted from the resulting object.\n - `security_policy` (`string`): The security policy associated with this backend service. When `null`, the `security_policy` field will be omitted from the resulting object.\n - `session_affinity` (`string`): Type of session affinity to use. The default is NONE. Session affinity is\nnot applicable if the protocol is UDP. Possible values: [\u0026#34;NONE\u0026#34;, \u0026#34;CLIENT_IP\u0026#34;, \u0026#34;CLIENT_IP_PORT_PROTO\u0026#34;, \u0026#34;CLIENT_IP_PROTO\u0026#34;, \u0026#34;GENERATED_COOKIE\u0026#34;, \u0026#34;HEADER_FIELD\u0026#34;, \u0026#34;HTTP_COOKIE\u0026#34;] When `null`, the `session_affinity` field will be omitted from the resulting object.\n - `timeout_sec` (`number`): How many seconds to wait for the backend before considering it a\nfailed request. Default is 30 seconds. Valid range is [1, 86400]. When `null`, the `timeout_sec` field will be omitted from the resulting object.\n - `backend` (`list[obj]`): The set of backends that serve this BackendService. When `null`, the `backend` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.backend.new](#fn-backendnew) constructor.\n - `cdn_policy` (`list[obj]`): Cloud CDN configuration for this BackendService. When `null`, the `cdn_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.compute_backend_service.cdn_policy.new](#fn-cdn_policynew) constructor.\n - `circuit_breakers` (`list[obj]`): Settings controlling the volume of connections to a backend service. This field\nis applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. When `null`, the `circuit_breakers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.circuit_breakers.new](#fn-circuit_breakersnew) constructor.\n - `consistent_hash` (`list[obj]`): Consistent Hash-based load balancing can be used to provide soft session\naffinity based on HTTP headers, cookies or other properties. This load balancing\npolicy is applicable only for HTTP connections. The affinity to a particular\ndestination host will be lost when one or more hosts are added/removed from the\ndestination service. This field specifies parameters that control consistent\nhashing. This field only applies if the load_balancing_scheme is set to\nINTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is\nset to MAGLEV or RING_HASH. When `null`, the `consistent_hash` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.consistent_hash.new](#fn-consistent_hashnew) constructor.\n - `iap` (`list[obj]`): Settings for enabling Cloud Identity Aware Proxy When `null`, the `iap` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.iap.new](#fn-iapnew) constructor.\n - `locality_lb_policies` (`list[obj]`): A list of locality load balancing policies to be used in order of\npreference. Either the policy or the customPolicy field should be set.\nOverrides any value set in the localityLbPolicy field.\n\nlocalityLbPolicies is only supported when the BackendService is referenced\nby a URL Map that is referenced by a target gRPC proxy that has the\nvalidateForProxyless field set to true. When `null`, the `locality_lb_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.compute_backend_service.locality_lb_policies.new](#fn-locality_lb_policiesnew) constructor.\n - `log_config` (`list[obj]`): This field denotes the logging options for the load balancer traffic served by this backend service.\nIf logging is enabled, logs will be exported to Stackdriver. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.log_config.new](#fn-log_confignew) constructor.\n - `outlier_detection` (`list[obj]`): Settings controlling eviction of unhealthy hosts from the load balancing pool.\nThis field is applicable only when the load_balancing_scheme is set\nto INTERNAL_SELF_MANAGED. When `null`, the `outlier_detection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.outlier_detection.new](#fn-outlier_detectionnew) constructor.\n - `security_settings` (`list[obj]`): The security settings that apply to this backend service. This field is applicable to either\na regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and\nload_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the\nload_balancing_scheme set to INTERNAL_SELF_MANAGED. When `null`, the `security_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.compute_backend_service.security_settings.new](#fn-security_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google.compute_backend_service.new` injects a new `google_compute_backend_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.compute_backend_service.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.compute_backend_service` using the reference:\n\n $._ref.google_compute_backend_service.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_compute_backend_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 - `affinity_cookie_ttl_sec` (`number`): Lifetime of cookies in seconds if session_affinity is\nGENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts\nonly until the end of the browser session (or equivalent). The\nmaximum allowed value for TTL is one day.\n\nWhen the load balancing scheme is INTERNAL, this field is not used. When `null`, the `affinity_cookie_ttl_sec` field will be omitted from the resulting object.\n - `compression_mode` (`string`): Compress text responses using Brotli or gzip compression, based on the client\u0026#39;s Accept-Encoding header. Possible values: [\u0026#34;AUTOMATIC\u0026#34;, \u0026#34;DISABLED\u0026#34;] When `null`, the `compression_mode` field will be omitted from the resulting object.\n - `connection_draining_timeout_sec` (`number`): Time for which instance will be drained (not accept new\nconnections, but still work to finish started). When `null`, the `connection_draining_timeout_sec` field will be omitted from the resulting object.\n - `custom_request_headers` (`list`): Headers that the HTTP/S load balancer should add to proxied\nrequests. When `null`, the `custom_request_headers` field will be omitted from the resulting object.\n - `custom_response_headers` (`list`): Headers that the HTTP/S load balancer should add to proxied\nresponses. When `null`, the `custom_response_headers` 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 - `edge_security_policy` (`string`): The resource URL for the edge security policy associated with this backend service. When `null`, the `edge_security_policy` field will be omitted from the resulting object.\n - `enable_cdn` (`bool`): If true, enable Cloud CDN for this BackendService. When `null`, the `enable_cdn` field will be omitted from the resulting object.\n - `health_checks` (`list`): The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource\nfor health checking this BackendService. Currently at most one health\ncheck can be specified.\n\nA health check must be specified unless the backend service uses an internet\nor serverless NEG as a backend.\n\nFor internal load balancing, a URL to a HealthCheck resource must be specified instead. When `null`, the `health_checks` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Indicates whether the backend service will be used with internal or\nexternal load balancing. A backend service created for one type of\nload balancing cannot be used with the other. For more information, refer to\n[Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). Default value: \u0026#34;EXTERNAL\u0026#34; Possible values: [\u0026#34;EXTERNAL\u0026#34;, \u0026#34;INTERNAL_SELF_MANAGED\u0026#34;, \u0026#34;INTERNAL_MANAGED\u0026#34;, \u0026#34;EXTERNAL_MANAGED\u0026#34;] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `locality_lb_policy` (`string`): The load balancing algorithm used within the scope of the locality.\nThe possible values are:\n\n* \u0026#39;ROUND_ROBIN\u0026#39;: This is a simple policy in which each healthy backend\n is selected in round robin order.\n\n* \u0026#39;LEAST_REQUEST\u0026#39;: An O(1) algorithm which selects two random healthy\n hosts and picks the host which has fewer active requests.\n\n* \u0026#39;RING_HASH\u0026#39;: The ring/modulo hash load balancer implements consistent\n hashing to backends. The algorithm has the property that the\n addition/removal of a host from a set of N hosts only affects\n 1/N of the requests.\n\n* \u0026#39;RANDOM\u0026#39;: The load balancer selects a random healthy host.\n\n* \u0026#39;ORIGINAL_DESTINATION\u0026#39;: Backend host is selected based on the client\n connection metadata, i.e., connections are opened\n to the same address as the destination address of\n the incoming connection before the connection\n was redirected to the load balancer.\n\n* \u0026#39;MAGLEV\u0026#39;: used as a drop in replacement for the ring hash load balancer.\n Maglev is not as stable as ring hash but has faster table lookup\n build times and host selection times. For more information about\n Maglev, refer to https://ai.google/research/pubs/pub44824\n\n* \u0026#39;WEIGHTED_MAGLEV\u0026#39;: Per-instance weighted Load Balancing via health check\n reported weights. If set, the Backend Service must\n configure a non legacy HTTP-based Health Check, and\n health check replies are expected to contain\n non-standard HTTP response header field\n X-Load-Balancing-Endpoint-Weight to specify the\n per-instance weights. If set, Load Balancing is weight\n based on the per-instance weights reported in the last\n processed health check replies, as long as every\n instance either reported a valid weight or had\n UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains\n equal-weight.\n\n\nThis field is applicable to either:\n\n* A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2,\n and loadBalancingScheme set to INTERNAL_MANAGED.\n* A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.\n* A regional backend service with loadBalancingScheme set to EXTERNAL (External Network\n Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External\n Network Load Balancing. The default is MAGLEV.\n\n\nIf session_affinity is not NONE, and this field is not set to MAGLEV, WEIGHTED_MAGLEV,\nor RING_HASH, session affinity settings will not take effect.\n\nOnly ROUND_ROBIN and RING_HASH are supported when the backend service is referenced\nby a URL map that is bound to target gRPC proxy that has validate_for_proxyless\nfield set to true. Possible values: [\u0026#34;ROUND_ROBIN\u0026#34;, \u0026#34;LEAST_REQUEST\u0026#34;, \u0026#34;RING_HASH\u0026#34;, \u0026#34;RANDOM\u0026#34;, \u0026#34;ORIGINAL_DESTINATION\u0026#34;, \u0026#34;MAGLEV\u0026#34;, \u0026#34;WEIGHTED_MAGLEV\u0026#34;] When `null`, the `locality_lb_policy` 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 - `port_name` (`string`): Name of backend port. The same name should appear in the instance\ngroups referenced by this service. Required when the load balancing\nscheme is EXTERNAL. When `null`, the `port_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 - `protocol` (`string`): The protocol this BackendService uses to communicate with backends.\nThe default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer\ntypes and may result in errors if used with the GA API. **NOTE**: With protocol “UNSPECIFIED”,\nthe backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing\nwith TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values: [\u0026#34;HTTP\u0026#34;, \u0026#34;HTTPS\u0026#34;, \u0026#34;HTTP2\u0026#34;, \u0026#34;TCP\u0026#34;, \u0026#34;SSL\u0026#34;, \u0026#34;GRPC\u0026#34;, \u0026#34;UNSPECIFIED\u0026#34;] When `null`, the `protocol` field will be omitted from the resulting object.\n - `security_policy` (`string`): The security policy associated with this backend service. When `null`, the `security_policy` field will be omitted from the resulting object.\n - `session_affinity` (`string`): Type of session affinity to use. The default is NONE. Session affinity is\nnot applicable if the protocol is UDP. Possible values: [\u0026#34;NONE\u0026#34;, \u0026#34;CLIENT_IP\u0026#34;, \u0026#34;CLIENT_IP_PORT_PROTO\u0026#34;, \u0026#34;CLIENT_IP_PROTO\u0026#34;, \u0026#34;GENERATED_COOKIE\u0026#34;, \u0026#34;HEADER_FIELD\u0026#34;, \u0026#34;HTTP_COOKIE\u0026#34;] When `null`, the `session_affinity` field will be omitted from the resulting object.\n - `timeout_sec` (`number`): How many seconds to wait for the backend before considering it a\nfailed request. Default is 30 seconds. Valid range is [1, 86400]. When `null`, the `timeout_sec` field will be omitted from the resulting object.\n - `backend` (`list[obj]`): The set of backends that serve this BackendService. When `null`, the `backend` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.backend.new](#fn-backendnew) constructor.\n - `cdn_policy` (`list[obj]`): Cloud CDN configuration for this BackendService. When `null`, the `cdn_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.compute_backend_service.cdn_policy.new](#fn-cdn_policynew) constructor.\n - `circuit_breakers` (`list[obj]`): Settings controlling the volume of connections to a backend service. This field\nis applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. When `null`, the `circuit_breakers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.circuit_breakers.new](#fn-circuit_breakersnew) constructor.\n - `consistent_hash` (`list[obj]`): Consistent Hash-based load balancing can be used to provide soft session\naffinity based on HTTP headers, cookies or other properties. This load balancing\npolicy is applicable only for HTTP connections. The affinity to a particular\ndestination host will be lost when one or more hosts are added/removed from the\ndestination service. This field specifies parameters that control consistent\nhashing. This field only applies if the load_balancing_scheme is set to\nINTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is\nset to MAGLEV or RING_HASH. When `null`, the `consistent_hash` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.consistent_hash.new](#fn-consistent_hashnew) constructor.\n - `iap` (`list[obj]`): Settings for enabling Cloud Identity Aware Proxy When `null`, the `iap` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.iap.new](#fn-iapnew) constructor.\n - `locality_lb_policies` (`list[obj]`): A list of locality load balancing policies to be used in order of\npreference. Either the policy or the customPolicy field should be set.\nOverrides any value set in the localityLbPolicy field.\n\nlocalityLbPolicies is only supported when the BackendService is referenced\nby a URL Map that is referenced by a target gRPC proxy that has the\nvalidateForProxyless field set to true. When `null`, the `locality_lb_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.compute_backend_service.locality_lb_policies.new](#fn-locality_lb_policiesnew) constructor.\n - `log_config` (`list[obj]`): This field denotes the logging options for the load balancer traffic served by this backend service.\nIf logging is enabled, logs will be exported to Stackdriver. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.log_config.new](#fn-log_confignew) constructor.\n - `outlier_detection` (`list[obj]`): Settings controlling eviction of unhealthy hosts from the load balancing pool.\nApplicable backend service types can be a global backend service with the\nloadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. When `null`, the `outlier_detection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.outlier_detection.new](#fn-outlier_detectionnew) constructor.\n - `security_settings` (`list[obj]`): The security settings that apply to this backend service. This field is applicable to either\na regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and\nload_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the\nload_balancing_scheme set to INTERNAL_SELF_MANAGED. When `null`, the `security_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.compute_backend_service.security_settings.new](#fn-security_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.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, @@ -259,7 +259,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.compute_backend_service.newAttrs` constructs a new object with attributes and blocks configured for the `compute_backend_service`\nTerraform resource.\n\nUnlike [google.compute_backend_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 - `affinity_cookie_ttl_sec` (`number`): Lifetime of cookies in seconds if session_affinity is\nGENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts\nonly until the end of the browser session (or equivalent). The\nmaximum allowed value for TTL is one day.\n\nWhen the load balancing scheme is INTERNAL, this field is not used. When `null`, the `affinity_cookie_ttl_sec` field will be omitted from the resulting object.\n - `compression_mode` (`string`): Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values: ["AUTOMATIC", "DISABLED"] When `null`, the `compression_mode` field will be omitted from the resulting object.\n - `connection_draining_timeout_sec` (`number`): Time for which instance will be drained (not accept new\nconnections, but still work to finish started). When `null`, the `connection_draining_timeout_sec` field will be omitted from the resulting object.\n - `custom_request_headers` (`list`): Headers that the HTTP/S load balancer should add to proxied\nrequests. When `null`, the `custom_request_headers` field will be omitted from the resulting object.\n - `custom_response_headers` (`list`): Headers that the HTTP/S load balancer should add to proxied\nresponses. When `null`, the `custom_response_headers` 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 - `edge_security_policy` (`string`): The resource URL for the edge security policy associated with this backend service. When `null`, the `edge_security_policy` field will be omitted from the resulting object.\n - `enable_cdn` (`bool`): If true, enable Cloud CDN for this BackendService. When `null`, the `enable_cdn` field will be omitted from the resulting object.\n - `health_checks` (`list`): The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource\nfor health checking this BackendService. Currently at most one health\ncheck can be specified.\n\nA health check must be specified unless the backend service uses an internet\nor serverless NEG as a backend.\n\nFor internal load balancing, a URL to a HealthCheck resource must be specified instead. When `null`, the `health_checks` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Indicates whether the backend service will be used with internal or\nexternal load balancing. A backend service created for one type of\nload balancing cannot be used with the other. For more information, refer to\n[Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). Default value: "EXTERNAL" Possible values: ["EXTERNAL", "INTERNAL_SELF_MANAGED", "INTERNAL_MANAGED", "EXTERNAL_MANAGED"] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `locality_lb_policy` (`string`): The load balancing algorithm used within the scope of the locality.\nThe possible values are:\n\n* 'ROUND_ROBIN': This is a simple policy in which each healthy backend\n is selected in round robin order.\n\n* 'LEAST_REQUEST': An O(1) algorithm which selects two random healthy\n hosts and picks the host which has fewer active requests.\n\n* 'RING_HASH': The ring/modulo hash load balancer implements consistent\n hashing to backends. The algorithm has the property that the\n addition/removal of a host from a set of N hosts only affects\n 1/N of the requests.\n\n* 'RANDOM': The load balancer selects a random healthy host.\n\n* 'ORIGINAL_DESTINATION': Backend host is selected based on the client\n connection metadata, i.e., connections are opened\n to the same address as the destination address of\n the incoming connection before the connection\n was redirected to the load balancer.\n\n* 'MAGLEV': used as a drop in replacement for the ring hash load balancer.\n Maglev is not as stable as ring hash but has faster table lookup\n build times and host selection times. For more information about\n Maglev, refer to https://ai.google/research/pubs/pub44824\n\n* 'WEIGHTED_MAGLEV': Per-instance weighted Load Balancing via health check\n reported weights. If set, the Backend Service must\n configure a non legacy HTTP-based Health Check, and\n health check replies are expected to contain\n non-standard HTTP response header field\n X-Load-Balancing-Endpoint-Weight to specify the\n per-instance weights. If set, Load Balancing is weight\n based on the per-instance weights reported in the last\n processed health check replies, as long as every\n instance either reported a valid weight or had\n UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains\n equal-weight.\n\n\nThis field is applicable to either:\n\n* A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2,\n and loadBalancingScheme set to INTERNAL_MANAGED.\n* A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.\n* A regional backend service with loadBalancingScheme set to EXTERNAL (External Network\n Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External\n Network Load Balancing. The default is MAGLEV.\n\n\nIf session_affinity is not NONE, and this field is not set to MAGLEV, WEIGHTED_MAGLEV,\nor RING_HASH, session affinity settings will not take effect.\n\nOnly ROUND_ROBIN and RING_HASH are supported when the backend service is referenced\nby a URL map that is bound to target gRPC proxy that has validate_for_proxyless\nfield set to true. Possible values: ["ROUND_ROBIN", "LEAST_REQUEST", "RING_HASH", "RANDOM", "ORIGINAL_DESTINATION", "MAGLEV", "WEIGHTED_MAGLEV"] When `null`, the `locality_lb_policy` 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 - `port_name` (`string`): Name of backend port. The same name should appear in the instance\ngroups referenced by this service. Required when the load balancing\nscheme is EXTERNAL. When `null`, the `port_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 - `protocol` (`string`): The protocol this BackendService uses to communicate with backends.\nThe default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer\ntypes and may result in errors if used with the GA API. **NOTE**: With protocol “UNSPECIFIED”,\nthe backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing\nwith TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values: ["HTTP", "HTTPS", "HTTP2", "TCP", "SSL", "GRPC", "UNSPECIFIED"] When `null`, the `protocol` field will be omitted from the resulting object.\n - `security_policy` (`string`): The security policy associated with this backend service. When `null`, the `security_policy` field will be omitted from the resulting object.\n - `session_affinity` (`string`): Type of session affinity to use. The default is NONE. Session affinity is\nnot applicable if the protocol is UDP. Possible values: ["NONE", "CLIENT_IP", "CLIENT_IP_PORT_PROTO", "CLIENT_IP_PROTO", "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE"] When `null`, the `session_affinity` field will be omitted from the resulting object.\n - `timeout_sec` (`number`): How many seconds to wait for the backend before considering it a\nfailed request. Default is 30 seconds. Valid range is [1, 86400]. When `null`, the `timeout_sec` field will be omitted from the resulting object.\n - `backend` (`list[obj]`): The set of backends that serve this BackendService. When `null`, the `backend` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.backend.new](#fn-backendnew) constructor.\n - `cdn_policy` (`list[obj]`): Cloud CDN configuration for this BackendService. When `null`, the `cdn_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.compute_backend_service.cdn_policy.new](#fn-cdn_policynew) constructor.\n - `circuit_breakers` (`list[obj]`): Settings controlling the volume of connections to a backend service. This field\nis applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. When `null`, the `circuit_breakers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.circuit_breakers.new](#fn-circuit_breakersnew) constructor.\n - `consistent_hash` (`list[obj]`): Consistent Hash-based load balancing can be used to provide soft session\naffinity based on HTTP headers, cookies or other properties. This load balancing\npolicy is applicable only for HTTP connections. The affinity to a particular\ndestination host will be lost when one or more hosts are added/removed from the\ndestination service. This field specifies parameters that control consistent\nhashing. This field only applies if the load_balancing_scheme is set to\nINTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is\nset to MAGLEV or RING_HASH. When `null`, the `consistent_hash` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.consistent_hash.new](#fn-consistent_hashnew) constructor.\n - `iap` (`list[obj]`): Settings for enabling Cloud Identity Aware Proxy When `null`, the `iap` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.iap.new](#fn-iapnew) constructor.\n - `locality_lb_policies` (`list[obj]`): A list of locality load balancing policies to be used in order of\npreference. Either the policy or the customPolicy field should be set.\nOverrides any value set in the localityLbPolicy field.\n\nlocalityLbPolicies is only supported when the BackendService is referenced\nby a URL Map that is referenced by a target gRPC proxy that has the\nvalidateForProxyless field set to true. When `null`, the `locality_lb_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.compute_backend_service.locality_lb_policies.new](#fn-locality_lb_policiesnew) constructor.\n - `log_config` (`list[obj]`): This field denotes the logging options for the load balancer traffic served by this backend service.\nIf logging is enabled, logs will be exported to Stackdriver. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.log_config.new](#fn-log_confignew) constructor.\n - `outlier_detection` (`list[obj]`): Settings controlling eviction of unhealthy hosts from the load balancing pool.\nThis field is applicable only when the load_balancing_scheme is set\nto INTERNAL_SELF_MANAGED. When `null`, the `outlier_detection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.outlier_detection.new](#fn-outlier_detectionnew) constructor.\n - `security_settings` (`list[obj]`): The security settings that apply to this backend service. This field is applicable to either\na regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and\nload_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the\nload_balancing_scheme set to INTERNAL_SELF_MANAGED. When `null`, the `security_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.compute_backend_service.security_settings.new](#fn-security_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `compute_backend_service` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.compute_backend_service.newAttrs` constructs a new object with attributes and blocks configured for the `compute_backend_service`\nTerraform resource.\n\nUnlike [google.compute_backend_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 - `affinity_cookie_ttl_sec` (`number`): Lifetime of cookies in seconds if session_affinity is\nGENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts\nonly until the end of the browser session (or equivalent). The\nmaximum allowed value for TTL is one day.\n\nWhen the load balancing scheme is INTERNAL, this field is not used. When `null`, the `affinity_cookie_ttl_sec` field will be omitted from the resulting object.\n - `compression_mode` (`string`): Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Possible values: ["AUTOMATIC", "DISABLED"] When `null`, the `compression_mode` field will be omitted from the resulting object.\n - `connection_draining_timeout_sec` (`number`): Time for which instance will be drained (not accept new\nconnections, but still work to finish started). When `null`, the `connection_draining_timeout_sec` field will be omitted from the resulting object.\n - `custom_request_headers` (`list`): Headers that the HTTP/S load balancer should add to proxied\nrequests. When `null`, the `custom_request_headers` field will be omitted from the resulting object.\n - `custom_response_headers` (`list`): Headers that the HTTP/S load balancer should add to proxied\nresponses. When `null`, the `custom_response_headers` 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 - `edge_security_policy` (`string`): The resource URL for the edge security policy associated with this backend service. When `null`, the `edge_security_policy` field will be omitted from the resulting object.\n - `enable_cdn` (`bool`): If true, enable Cloud CDN for this BackendService. When `null`, the `enable_cdn` field will be omitted from the resulting object.\n - `health_checks` (`list`): The set of URLs to the HttpHealthCheck or HttpsHealthCheck resource\nfor health checking this BackendService. Currently at most one health\ncheck can be specified.\n\nA health check must be specified unless the backend service uses an internet\nor serverless NEG as a backend.\n\nFor internal load balancing, a URL to a HealthCheck resource must be specified instead. When `null`, the `health_checks` field will be omitted from the resulting object.\n - `load_balancing_scheme` (`string`): Indicates whether the backend service will be used with internal or\nexternal load balancing. A backend service created for one type of\nload balancing cannot be used with the other. For more information, refer to\n[Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). Default value: "EXTERNAL" Possible values: ["EXTERNAL", "INTERNAL_SELF_MANAGED", "INTERNAL_MANAGED", "EXTERNAL_MANAGED"] When `null`, the `load_balancing_scheme` field will be omitted from the resulting object.\n - `locality_lb_policy` (`string`): The load balancing algorithm used within the scope of the locality.\nThe possible values are:\n\n* 'ROUND_ROBIN': This is a simple policy in which each healthy backend\n is selected in round robin order.\n\n* 'LEAST_REQUEST': An O(1) algorithm which selects two random healthy\n hosts and picks the host which has fewer active requests.\n\n* 'RING_HASH': The ring/modulo hash load balancer implements consistent\n hashing to backends. The algorithm has the property that the\n addition/removal of a host from a set of N hosts only affects\n 1/N of the requests.\n\n* 'RANDOM': The load balancer selects a random healthy host.\n\n* 'ORIGINAL_DESTINATION': Backend host is selected based on the client\n connection metadata, i.e., connections are opened\n to the same address as the destination address of\n the incoming connection before the connection\n was redirected to the load balancer.\n\n* 'MAGLEV': used as a drop in replacement for the ring hash load balancer.\n Maglev is not as stable as ring hash but has faster table lookup\n build times and host selection times. For more information about\n Maglev, refer to https://ai.google/research/pubs/pub44824\n\n* 'WEIGHTED_MAGLEV': Per-instance weighted Load Balancing via health check\n reported weights. If set, the Backend Service must\n configure a non legacy HTTP-based Health Check, and\n health check replies are expected to contain\n non-standard HTTP response header field\n X-Load-Balancing-Endpoint-Weight to specify the\n per-instance weights. If set, Load Balancing is weight\n based on the per-instance weights reported in the last\n processed health check replies, as long as every\n instance either reported a valid weight or had\n UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains\n equal-weight.\n\n\nThis field is applicable to either:\n\n* A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2,\n and loadBalancingScheme set to INTERNAL_MANAGED.\n* A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.\n* A regional backend service with loadBalancingScheme set to EXTERNAL (External Network\n Load Balancing). Only MAGLEV and WEIGHTED_MAGLEV values are possible for External\n Network Load Balancing. The default is MAGLEV.\n\n\nIf session_affinity is not NONE, and this field is not set to MAGLEV, WEIGHTED_MAGLEV,\nor RING_HASH, session affinity settings will not take effect.\n\nOnly ROUND_ROBIN and RING_HASH are supported when the backend service is referenced\nby a URL map that is bound to target gRPC proxy that has validate_for_proxyless\nfield set to true. Possible values: ["ROUND_ROBIN", "LEAST_REQUEST", "RING_HASH", "RANDOM", "ORIGINAL_DESTINATION", "MAGLEV", "WEIGHTED_MAGLEV"] When `null`, the `locality_lb_policy` 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 - `port_name` (`string`): Name of backend port. The same name should appear in the instance\ngroups referenced by this service. Required when the load balancing\nscheme is EXTERNAL. When `null`, the `port_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 - `protocol` (`string`): The protocol this BackendService uses to communicate with backends.\nThe default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer\ntypes and may result in errors if used with the GA API. **NOTE**: With protocol “UNSPECIFIED”,\nthe backend service can be used by Layer 4 Internal Load Balancing or Network Load Balancing\nwith TCP/UDP/L3_DEFAULT Forwarding Rule protocol. Possible values: ["HTTP", "HTTPS", "HTTP2", "TCP", "SSL", "GRPC", "UNSPECIFIED"] When `null`, the `protocol` field will be omitted from the resulting object.\n - `security_policy` (`string`): The security policy associated with this backend service. When `null`, the `security_policy` field will be omitted from the resulting object.\n - `session_affinity` (`string`): Type of session affinity to use. The default is NONE. Session affinity is\nnot applicable if the protocol is UDP. Possible values: ["NONE", "CLIENT_IP", "CLIENT_IP_PORT_PROTO", "CLIENT_IP_PROTO", "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE"] When `null`, the `session_affinity` field will be omitted from the resulting object.\n - `timeout_sec` (`number`): How many seconds to wait for the backend before considering it a\nfailed request. Default is 30 seconds. Valid range is [1, 86400]. When `null`, the `timeout_sec` field will be omitted from the resulting object.\n - `backend` (`list[obj]`): The set of backends that serve this BackendService. When `null`, the `backend` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.backend.new](#fn-backendnew) constructor.\n - `cdn_policy` (`list[obj]`): Cloud CDN configuration for this BackendService. When `null`, the `cdn_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.compute_backend_service.cdn_policy.new](#fn-cdn_policynew) constructor.\n - `circuit_breakers` (`list[obj]`): Settings controlling the volume of connections to a backend service. This field\nis applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED. When `null`, the `circuit_breakers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.circuit_breakers.new](#fn-circuit_breakersnew) constructor.\n - `consistent_hash` (`list[obj]`): Consistent Hash-based load balancing can be used to provide soft session\naffinity based on HTTP headers, cookies or other properties. This load balancing\npolicy is applicable only for HTTP connections. The affinity to a particular\ndestination host will be lost when one or more hosts are added/removed from the\ndestination service. This field specifies parameters that control consistent\nhashing. This field only applies if the load_balancing_scheme is set to\nINTERNAL_SELF_MANAGED. This field is only applicable when locality_lb_policy is\nset to MAGLEV or RING_HASH. When `null`, the `consistent_hash` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.consistent_hash.new](#fn-consistent_hashnew) constructor.\n - `iap` (`list[obj]`): Settings for enabling Cloud Identity Aware Proxy When `null`, the `iap` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.iap.new](#fn-iapnew) constructor.\n - `locality_lb_policies` (`list[obj]`): A list of locality load balancing policies to be used in order of\npreference. Either the policy or the customPolicy field should be set.\nOverrides any value set in the localityLbPolicy field.\n\nlocalityLbPolicies is only supported when the BackendService is referenced\nby a URL Map that is referenced by a target gRPC proxy that has the\nvalidateForProxyless field set to true. When `null`, the `locality_lb_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.compute_backend_service.locality_lb_policies.new](#fn-locality_lb_policiesnew) constructor.\n - `log_config` (`list[obj]`): This field denotes the logging options for the load balancer traffic served by this backend service.\nIf logging is enabled, logs will be exported to Stackdriver. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.log_config.new](#fn-log_confignew) constructor.\n - `outlier_detection` (`list[obj]`): Settings controlling eviction of unhealthy hosts from the load balancing pool.\nApplicable backend service types can be a global backend service with the\nloadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. When `null`, the `outlier_detection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.outlier_detection.new](#fn-outlier_detectionnew) constructor.\n - `security_settings` (`list[obj]`): The security settings that apply to this backend service. This field is applicable to either\na regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and\nload_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the\nload_balancing_scheme set to INTERNAL_SELF_MANAGED. When `null`, the `security_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.compute_backend_service.security_settings.new](#fn-security_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `compute_backend_service` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, affinity_cookie_ttl_sec=null, diff --git a/4.x/_gen/resources/container_aws_cluster.libsonnet b/4.x/_gen/resources/container_aws_cluster.libsonnet index 64e2999f..e311d215 100644 --- a/4.x/_gen/resources/container_aws_cluster.libsonnet +++ b/4.x/_gen/resources/container_aws_cluster.libsonnet @@ -3,6 +3,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='container_aws_cluster', url='', help='`container_aws_cluster` represents the `google_container_aws_cluster` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), authorization:: { + admin_groups:: { + '#new':: d.fn(help='\n`google.container_aws_cluster.authorization.admin_groups.new` constructs a new object with attributes and blocks configured for the `admin_groups`\nTerraform sub block.\n\n\n\n**Args**:\n - `group` (`string`): The name of the group, e.g. `my-group@domain.com`.\n\n**Returns**:\n - An attribute object that represents the `admin_groups` sub block.\n', args=[]), + new( + group + ):: std.prune(a={ + group: group, + }), + }, admin_users:: { '#new':: d.fn(help='\n`google.container_aws_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( @@ -11,10 +19,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); username: username, }), }, - '#new':: d.fn(help='\n`google.container_aws_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 to perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the `cluster-admin` ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles 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.container_aws_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':: d.fn(help='\n`google.container_aws_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_groups` (`list[obj]`): Groups of users that can perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the `cluster-admin` ClusterRole to the groups. Up to ten admin groups can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles When `null`, the `admin_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.container_aws_cluster.authorization.admin_groups.new](#fn-authorizationadmin_groupsnew) constructor.\n - `admin_users` (`list[obj]`): Users to perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the `cluster-admin` ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles 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.container_aws_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_groups=null, admin_users=null ):: std.prune(a={ + admin_groups: admin_groups, admin_users: admin_users, }), }, @@ -54,7 +64,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, main_volume:: { - '#new':: d.fn(help='\n`google.container_aws_cluster.control_plane.main_volume.new` constructs a new object with attributes and blocks configured for the `main_volume`\nTerraform sub block.\n\n\n\n**Args**:\n - `iops` (`number`): Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume. When `null`, the `iops` field will be omitted from the resulting object.\n - `kms_key_arn` (`string`): Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used. When `null`, the `kms_key_arn` field will be omitted from the resulting object.\n - `size_gib` (`number`): Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource. When `null`, the `size_gib` field will be omitted from the resulting object.\n - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. When `null`, the `throughput` field will be omitted from the resulting object.\n - `volume_type` (`string`): Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3 When `null`, the `volume_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `main_volume` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.container_aws_cluster.control_plane.main_volume.new` constructs a new object with attributes and blocks configured for the `main_volume`\nTerraform sub block.\n\n\n\n**Args**:\n - `iops` (`number`): Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume. When `null`, the `iops` field will be omitted from the resulting object.\n - `kms_key_arn` (`string`): Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used. When `null`, the `kms_key_arn` field will be omitted from the resulting object.\n - `size_gib` (`number`): Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource. When `null`, the `size_gib` field will be omitted from the resulting object.\n - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. If volume type is gp3 and throughput is not specified, the throughput will defaults to 125. When `null`, the `throughput` field will be omitted from the resulting object.\n - `volume_type` (`string`): Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3 When `null`, the `volume_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `main_volume` sub block.\n', args=[]), new( iops=null, kms_key_arn=null, @@ -110,7 +120,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, root_volume:: { - '#new':: d.fn(help='\n`google.container_aws_cluster.control_plane.root_volume.new` constructs a new object with attributes and blocks configured for the `root_volume`\nTerraform sub block.\n\n\n\n**Args**:\n - `iops` (`number`): Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume. When `null`, the `iops` field will be omitted from the resulting object.\n - `kms_key_arn` (`string`): Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used. When `null`, the `kms_key_arn` field will be omitted from the resulting object.\n - `size_gib` (`number`): Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource. When `null`, the `size_gib` field will be omitted from the resulting object.\n - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. When `null`, the `throughput` field will be omitted from the resulting object.\n - `volume_type` (`string`): Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3 When `null`, the `volume_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `root_volume` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.container_aws_cluster.control_plane.root_volume.new` constructs a new object with attributes and blocks configured for the `root_volume`\nTerraform sub block.\n\n\n\n**Args**:\n - `iops` (`number`): Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume. When `null`, the `iops` field will be omitted from the resulting object.\n - `kms_key_arn` (`string`): Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used. When `null`, the `kms_key_arn` field will be omitted from the resulting object.\n - `size_gib` (`number`): Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource. When `null`, the `size_gib` field will be omitted from the resulting object.\n - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. If volume type is gp3 and throughput is not specified, the throughput will defaults to 125. When `null`, the `throughput` field will be omitted from the resulting object.\n - `volume_type` (`string`): Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3 When `null`, the `volume_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `root_volume` sub block.\n', args=[]), new( iops=null, kms_key_arn=null, diff --git a/4.x/_gen/resources/container_aws_node_pool.libsonnet b/4.x/_gen/resources/container_aws_node_pool.libsonnet index 6a1e73c5..52fb36db 100644 --- a/4.x/_gen/resources/container_aws_node_pool.libsonnet +++ b/4.x/_gen/resources/container_aws_node_pool.libsonnet @@ -68,7 +68,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, root_volume:: { - '#new':: d.fn(help='\n`google.container_aws_node_pool.config.root_volume.new` constructs a new object with attributes and blocks configured for the `root_volume`\nTerraform sub block.\n\n\n\n**Args**:\n - `iops` (`number`): Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume. When `null`, the `iops` field will be omitted from the resulting object.\n - `kms_key_arn` (`string`): Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used. When `null`, the `kms_key_arn` field will be omitted from the resulting object.\n - `size_gib` (`number`): Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource. When `null`, the `size_gib` field will be omitted from the resulting object.\n - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. When `null`, the `throughput` field will be omitted from the resulting object.\n - `volume_type` (`string`): Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3 When `null`, the `volume_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `root_volume` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.container_aws_node_pool.config.root_volume.new` constructs a new object with attributes and blocks configured for the `root_volume`\nTerraform sub block.\n\n\n\n**Args**:\n - `iops` (`number`): Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume. When `null`, the `iops` field will be omitted from the resulting object.\n - `kms_key_arn` (`string`): Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used. When `null`, the `kms_key_arn` field will be omitted from the resulting object.\n - `size_gib` (`number`): Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource. When `null`, the `size_gib` field will be omitted from the resulting object.\n - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. If volume type is gp3 and throughput is not specified, the throughput will defaults to 125. When `null`, the `throughput` field will be omitted from the resulting object.\n - `volume_type` (`string`): Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3 When `null`, the `volume_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `root_volume` sub block.\n', args=[]), new( iops=null, kms_key_arn=null, diff --git a/4.x/_gen/resources/container_azure_cluster.libsonnet b/4.x/_gen/resources/container_azure_cluster.libsonnet index 264ed8ad..24a3a772 100644 --- a/4.x/_gen/resources/container_azure_cluster.libsonnet +++ b/4.x/_gen/resources/container_azure_cluster.libsonnet @@ -3,6 +3,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='container_azure_cluster', url='', help='`container_azure_cluster` represents the `google_container_azure_cluster` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), authorization:: { + admin_groups:: { + '#new':: d.fn(help='\n`google.container_azure_cluster.authorization.admin_groups.new` constructs a new object with attributes and blocks configured for the `admin_groups`\nTerraform sub block.\n\n\n\n**Args**:\n - `group` (`string`): The name of the group, e.g. `my-group@domain.com`.\n\n**Returns**:\n - An attribute object that represents the `admin_groups` sub block.\n', args=[]), + new( + group + ):: std.prune(a={ + group: group, + }), + }, admin_users:: { '#new':: d.fn(help='\n`google.container_azure_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( @@ -11,10 +19,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); username: username, }), }, - '#new':: d.fn(help='\n`google.container_azure_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 can perform operations as a cluster admin. A new ClusterRoleBinding will be created to grant the cluster-admin ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles 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.container_azure_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':: d.fn(help='\n`google.container_azure_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_groups` (`list[obj]`): Groups of users that can perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the `cluster-admin` ClusterRole to the groups. Up to ten admin groups can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles When `null`, the `admin_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.container_azure_cluster.authorization.admin_groups.new](#fn-authorizationadmin_groupsnew) constructor.\n - `admin_users` (`list[obj]`): Users that can perform operations as a cluster admin. A new ClusterRoleBinding will be created to grant the cluster-admin ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles 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.container_azure_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_groups=null, admin_users=null ):: std.prune(a={ + admin_groups: admin_groups, admin_users: admin_users, }), }, diff --git a/4.x/_gen/resources/container_cluster.libsonnet b/4.x/_gen/resources/container_cluster.libsonnet index 303bdb09..334901d7 100644 --- a/4.x/_gen/resources/container_cluster.libsonnet +++ b/4.x/_gen/resources/container_cluster.libsonnet @@ -288,6 +288,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enabled_apis: enabled_apis, }), }, + fleet:: { + '#new':: d.fn(help='\n`google.container_cluster.fleet.new` constructs a new object with attributes and blocks configured for the `fleet`\nTerraform sub block.\n\n\n\n**Args**:\n - `project` (`string`): The Fleet host project of the cluster. When `null`, the `project` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `fleet` sub block.\n', args=[]), + new( + project=null + ):: std.prune(a={ + project: project, + }), + }, gateway_api_config:: { '#new':: d.fn(help='\n`google.container_cluster.gateway_api_config.new` constructs a new object with attributes and blocks configured for the `gateway_api_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `channel` (`string`): The Gateway API release channel to use for Gateway API.\n\n**Returns**:\n - An attribute object that represents the `gateway_api_config` sub block.\n', args=[]), new( @@ -486,7 +494,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); provider: provider, }), }, - '#new':: d.fn(help="\n`google.container_cluster.new` injects a new `google_container_cluster` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.container_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.container_cluster` using the reference:\n\n $._ref.google_container_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_container_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `allow_net_admin` (`bool`): Enable NET_ADMIN for this cluster. When `null`, the `allow_net_admin` field will be omitted from the resulting object.\n - `cluster_ipv4_cidr` (`string`): The IP address range of the Kubernetes pods in this cluster in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8. This field will only work for routes-based clusters, where ip_allocation_policy is not defined. When `null`, the `cluster_ipv4_cidr` field will be omitted from the resulting object.\n - `datapath_provider` (`string`): The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. When `null`, the `datapath_provider` field will be omitted from the resulting object.\n - `default_max_pods_per_node` (`number`): The default maximum number of pods per node in this cluster. This doesn\u0026#39;t work on \u0026#34;routes-based\u0026#34; clusters, clusters that don\u0026#39;t have IP Aliasing enabled. When `null`, the `default_max_pods_per_node` field will be omitted from the resulting object.\n - `deletion_protection` (`bool`): Whether or not to allow Terraform to destroy the instance. Defaults to true. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the cluster will fail. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `description` (`string`): Description of the cluster. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_autopilot` (`bool`): Enable Autopilot for this cluster. When `null`, the `enable_autopilot` field will be omitted from the resulting object.\n - `enable_intranode_visibility` (`bool`): Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. When `null`, the `enable_intranode_visibility` field will be omitted from the resulting object.\n - `enable_kubernetes_alpha` (`bool`): Whether to enable Kubernetes Alpha features for this cluster. Note that when this option is enabled, the cluster cannot be upgraded and will be automatically deleted after 30 days. When `null`, the `enable_kubernetes_alpha` field will be omitted from the resulting object.\n - `enable_l4_ilb_subsetting` (`bool`): Whether L4ILB Subsetting is enabled for this cluster. When `null`, the `enable_l4_ilb_subsetting` field will be omitted from the resulting object.\n - `enable_legacy_abac` (`bool`): Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. Defaults to false. When `null`, the `enable_legacy_abac` field will be omitted from the resulting object.\n - `enable_shielded_nodes` (`bool`): Enable Shielded Nodes features on all nodes in this cluster. Defaults to true. When `null`, the `enable_shielded_nodes` field will be omitted from the resulting object.\n - `enable_tpu` (`bool`): Whether to enable Cloud TPU resources in this cluster. When `null`, the `enable_tpu` field will be omitted from the resulting object.\n - `initial_node_count` (`number`): The number of nodes to create in this cluster\u0026#39;s default node pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Must be set if node_pool is not set. If you\u0026#39;re using google_container_node_pool objects with no default node pool, you\u0026#39;ll need to set this to a value of at least 1, alongside setting remove_default_node_pool to true. When `null`, the `initial_node_count` field will be omitted from the resulting object.\n - `location` (`string`): The location (region or zone) in which the cluster master will be created, as well as the default node location. If you specify a zone (such as us-central1-a), the cluster will be a zonal cluster with a single cluster master. If you specify a region (such as us-west1), the cluster will be a regional cluster with multiple masters spread across zones in the region, and with default node locations in those zones as well. When `null`, the `location` field will be omitted from the resulting object.\n - `logging_service` (`string`): The logging service that the cluster should write logs to. Available options include logging.googleapis.com(Legacy Stackdriver), logging.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Logging), and none. Defaults to logging.googleapis.com/kubernetes. When `null`, the `logging_service` field will be omitted from the resulting object.\n - `min_master_version` (`string`): The minimum version of the master. GKE will auto-update the master to new versions, so this does not guarantee the current master version--use the read-only master_version field to obtain that. If unset, the cluster\u0026#39;s version will be set by GKE to the version of the most recent official release (which is not necessarily the latest version). When `null`, the `min_master_version` field will be omitted from the resulting object.\n - `monitoring_service` (`string`): The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com(Legacy Stackdriver), monitoring.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Monitoring), and none. Defaults to monitoring.googleapis.com/kubernetes. When `null`, the `monitoring_service` field will be omitted from the resulting object.\n - `name` (`string`): The name of the cluster, unique within the project and location.\n - `network` (`string`): The name or self_link of the Google Compute Engine network to which the cluster is connected. For Shared VPC, set this to the self link of the shared network. When `null`, the `network` field will be omitted from the resulting object.\n - `networking_mode` (`string`): Determines whether alias IPs or routes will be used for pod IPs in the cluster. Defaults to VPC_NATIVE for new clusters. When `null`, the `networking_mode` field will be omitted from the resulting object.\n - `node_locations` (`list`): The list of zones in which the cluster\u0026#39;s nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster\u0026#39;s zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster\u0026#39;s zone. When `null`, the `node_locations` field will be omitted from the resulting object.\n - `node_version` (`string`): The Kubernetes version on the nodes. Must either be unset or set to the same value as min_master_version on create. Defaults to the default version set by GKE which is not necessarily the latest version. This only affects nodes in the default node pool. While a fuzzy version can be specified, it\u0026#39;s recommended that you specify explicit versions as Terraform will see spurious diffs when fuzzy versions are used. See the google_container_engine_versions data source\u0026#39;s version_prefix field to approximate fuzzy versions in a Terraform-compatible way. To update nodes in other node pools, use the version attribute on the node pool. When `null`, the `node_version` field will be omitted from the resulting object.\n - `private_ipv6_google_access` (`string`): The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4). When `null`, the `private_ipv6_google_access` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `remove_default_node_pool` (`bool`): If true, deletes the default node pool upon cluster creation. If you\u0026#39;re using google_container_node_pool resources with no default node pool, this should be set to true, alongside setting initial_node_count to at least 1. When `null`, the `remove_default_node_pool` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the cluster. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `subnetwork` (`string`): The name or self_link of the Google Compute Engine subnetwork in which the cluster\u0026#39;s instances are launched. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `addons_config` (`list[obj]`): The configuration for addons supported by GKE. When `null`, the `addons_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.addons_config.new](#fn-addons_confignew) constructor.\n - `authenticator_groups_config` (`list[obj]`): Configuration for the Google Groups for GKE feature. When `null`, the `authenticator_groups_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.authenticator_groups_config.new](#fn-authenticator_groups_confignew) constructor.\n - `binary_authorization` (`list[obj]`): Configuration options for the Binary Authorization feature. When `null`, the `binary_authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `cluster_autoscaling` (`list[obj]`): Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster\u0026#39;s workload. See the guide to using Node Auto-Provisioning for more details. When `null`, the `cluster_autoscaling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.cluster_autoscaling.new](#fn-cluster_autoscalingnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can\u0026#39;t be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. When `null`, the `confidential_nodes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.confidential_nodes.new](#fn-confidential_nodesnew) constructor.\n - `cost_management_config` (`list[obj]`): Cost management configuration for the cluster. When `null`, the `cost_management_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.cost_management_config.new](#fn-cost_management_confignew) constructor.\n - `database_encryption` (`list[obj]`): Application-layer Secrets Encryption settings. The object format is {state = string, key_name = string}. Valid values of state are: \u0026#34;ENCRYPTED\u0026#34;; \u0026#34;DECRYPTED\u0026#34;. key_name is the name of a CloudKMS key. When `null`, the `database_encryption` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.database_encryption.new](#fn-database_encryptionnew) constructor.\n - `default_snat_status` (`list[obj]`): Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled. When `null`, the `default_snat_status` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.default_snat_status.new](#fn-default_snat_statusnew) constructor.\n - `dns_config` (`list[obj]`): Configuration for Cloud DNS for Kubernetes Engine. When `null`, the `dns_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.dns_config.new](#fn-dns_confignew) constructor.\n - `enable_k8s_beta_apis` (`list[obj]`): Configuration for Kubernetes Beta APIs. When `null`, the `enable_k8s_beta_apis` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.enable_k8s_beta_apis.new](#fn-enable_k8s_beta_apisnew) constructor.\n - `gateway_api_config` (`list[obj]`): Configuration for GKE Gateway API controller. When `null`, the `gateway_api_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.gateway_api_config.new](#fn-gateway_api_confignew) constructor.\n - `identity_service_config` (`list[obj]`): Configuration for Identity Service which allows customers to use external identity providers with the K8S API. When `null`, the `identity_service_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.identity_service_config.new](#fn-identity_service_confignew) constructor.\n - `ip_allocation_policy` (`list[obj]`): Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. When `null`, the `ip_allocation_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.ip_allocation_policy.new](#fn-ip_allocation_policynew) constructor.\n - `logging_config` (`list[obj]`): Logging configuration for the cluster. When `null`, the `logging_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.logging_config.new](#fn-logging_confignew) constructor.\n - `maintenance_policy` (`list[obj]`): The maintenance policy to use for the cluster. When `null`, the `maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.maintenance_policy.new](#fn-maintenance_policynew) constructor.\n - `master_auth` (`list[obj]`): The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff unsetting your client cert, ensure you have the container.clusters.getCredentials permission. When `null`, the `master_auth` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.master_auth.new](#fn-master_authnew) constructor.\n - `master_authorized_networks_config` (`list[obj]`): The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists). When `null`, the `master_authorized_networks_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.master_authorized_networks_config.new](#fn-master_authorized_networks_confignew) constructor.\n - `mesh_certificates` (`list[obj]`): If set, and enable_certificates=true, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster. When `null`, the `mesh_certificates` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.mesh_certificates.new](#fn-mesh_certificatesnew) constructor.\n - `monitoring_config` (`list[obj]`): Monitoring configuration for the cluster. When `null`, the `monitoring_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.monitoring_config.new](#fn-monitoring_confignew) constructor.\n - `network_policy` (`list[obj]`): Configuration options for the NetworkPolicy feature. When `null`, the `network_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.network_policy.new](#fn-network_policynew) constructor.\n - `node_config` (`list[obj]`): The configuration of the nodepool When `null`, the `node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.new](#fn-node_confignew) constructor.\n - `node_pool` (`list[obj]`): List of node pools associated with this cluster. See google_container_node_pool for schema. Warning: node pools defined inside a cluster can\u0026#39;t be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. Unless you absolutely need the ability to say \u0026#34;these are the only node pools associated with this cluster\u0026#34;, use the google_container_node_pool resource instead of this property. When `null`, the `node_pool` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.new](#fn-node_poolnew) constructor.\n - `node_pool_auto_config` (`list[obj]`): Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. When `null`, the `node_pool_auto_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool_auto_config.new](#fn-node_pool_auto_confignew) constructor.\n - `node_pool_defaults` (`list[obj]`): The default nodel pool settings for the entire cluster. When `null`, the `node_pool_defaults` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool_defaults.new](#fn-node_pool_defaultsnew) constructor.\n - `notification_config` (`list[obj]`): The notification config for sending cluster upgrade notifications When `null`, the `notification_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.notification_config.new](#fn-notification_confignew) constructor.\n - `private_cluster_config` (`list[obj]`): Configuration for private clusters, clusters with private nodes. When `null`, the `private_cluster_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.private_cluster_config.new](#fn-private_cluster_confignew) constructor.\n - `release_channel` (`list[obj]`): Configuration options for the Release channel feature, which provide more control over automatic upgrades of your GKE clusters. Note that removing this field from your config will not unenroll it. Instead, use the \u0026#34;UNSPECIFIED\u0026#34; channel. When `null`, the `release_channel` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.release_channel.new](#fn-release_channelnew) constructor.\n - `resource_usage_export_config` (`list[obj]`): Configuration for the ResourceUsageExportConfig feature. When `null`, the `resource_usage_export_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.resource_usage_export_config.new](#fn-resource_usage_export_confignew) constructor.\n - `security_posture_config` (`list[obj]`): Defines the config needed to enable/disable features for the Security Posture API When `null`, the `security_posture_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.security_posture_config.new](#fn-security_posture_confignew) constructor.\n - `service_external_ips_config` (`list[obj]`): If set, and enabled=true, services with external ips field will not be blocked When `null`, the `service_external_ips_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.service_external_ips_config.new](#fn-service_external_ips_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n - `vertical_pod_autoscaling` (`list[obj]`): Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. When `null`, the `vertical_pod_autoscaling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.vertical_pod_autoscaling.new](#fn-vertical_pod_autoscalingnew) constructor.\n - `workload_identity_config` (`list[obj]`): Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. When `null`, the `workload_identity_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.workload_identity_config.new](#fn-workload_identity_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google.container_cluster.new` injects a new `google_container_cluster` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.container_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.container_cluster` using the reference:\n\n $._ref.google_container_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_container_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `allow_net_admin` (`bool`): Enable NET_ADMIN for this cluster. When `null`, the `allow_net_admin` field will be omitted from the resulting object.\n - `cluster_ipv4_cidr` (`string`): The IP address range of the Kubernetes pods in this cluster in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8. This field will only work for routes-based clusters, where ip_allocation_policy is not defined. When `null`, the `cluster_ipv4_cidr` field will be omitted from the resulting object.\n - `datapath_provider` (`string`): The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. When `null`, the `datapath_provider` field will be omitted from the resulting object.\n - `default_max_pods_per_node` (`number`): The default maximum number of pods per node in this cluster. This doesn\u0026#39;t work on \u0026#34;routes-based\u0026#34; clusters, clusters that don\u0026#39;t have IP Aliasing enabled. When `null`, the `default_max_pods_per_node` field will be omitted from the resulting object.\n - `deletion_protection` (`bool`): Whether or not to allow Terraform to destroy the instance. Defaults to true. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the cluster will fail. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `description` (`string`): Description of the cluster. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_autopilot` (`bool`): Enable Autopilot for this cluster. When `null`, the `enable_autopilot` field will be omitted from the resulting object.\n - `enable_intranode_visibility` (`bool`): Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. When `null`, the `enable_intranode_visibility` field will be omitted from the resulting object.\n - `enable_kubernetes_alpha` (`bool`): Whether to enable Kubernetes Alpha features for this cluster. Note that when this option is enabled, the cluster cannot be upgraded and will be automatically deleted after 30 days. When `null`, the `enable_kubernetes_alpha` field will be omitted from the resulting object.\n - `enable_l4_ilb_subsetting` (`bool`): Whether L4ILB Subsetting is enabled for this cluster. When `null`, the `enable_l4_ilb_subsetting` field will be omitted from the resulting object.\n - `enable_legacy_abac` (`bool`): Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. Defaults to false. When `null`, the `enable_legacy_abac` field will be omitted from the resulting object.\n - `enable_shielded_nodes` (`bool`): Enable Shielded Nodes features on all nodes in this cluster. Defaults to true. When `null`, the `enable_shielded_nodes` field will be omitted from the resulting object.\n - `enable_tpu` (`bool`): Whether to enable Cloud TPU resources in this cluster. When `null`, the `enable_tpu` field will be omitted from the resulting object.\n - `initial_node_count` (`number`): The number of nodes to create in this cluster\u0026#39;s default node pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Must be set if node_pool is not set. If you\u0026#39;re using google_container_node_pool objects with no default node pool, you\u0026#39;ll need to set this to a value of at least 1, alongside setting remove_default_node_pool to true. When `null`, the `initial_node_count` field will be omitted from the resulting object.\n - `location` (`string`): The location (region or zone) in which the cluster master will be created, as well as the default node location. If you specify a zone (such as us-central1-a), the cluster will be a zonal cluster with a single cluster master. If you specify a region (such as us-west1), the cluster will be a regional cluster with multiple masters spread across zones in the region, and with default node locations in those zones as well. When `null`, the `location` field will be omitted from the resulting object.\n - `logging_service` (`string`): The logging service that the cluster should write logs to. Available options include logging.googleapis.com(Legacy Stackdriver), logging.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Logging), and none. Defaults to logging.googleapis.com/kubernetes. When `null`, the `logging_service` field will be omitted from the resulting object.\n - `min_master_version` (`string`): The minimum version of the master. GKE will auto-update the master to new versions, so this does not guarantee the current master version--use the read-only master_version field to obtain that. If unset, the cluster\u0026#39;s version will be set by GKE to the version of the most recent official release (which is not necessarily the latest version). When `null`, the `min_master_version` field will be omitted from the resulting object.\n - `monitoring_service` (`string`): The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com(Legacy Stackdriver), monitoring.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Monitoring), and none. Defaults to monitoring.googleapis.com/kubernetes. When `null`, the `monitoring_service` field will be omitted from the resulting object.\n - `name` (`string`): The name of the cluster, unique within the project and location.\n - `network` (`string`): The name or self_link of the Google Compute Engine network to which the cluster is connected. For Shared VPC, set this to the self link of the shared network. When `null`, the `network` field will be omitted from the resulting object.\n - `networking_mode` (`string`): Determines whether alias IPs or routes will be used for pod IPs in the cluster. Defaults to VPC_NATIVE for new clusters. When `null`, the `networking_mode` field will be omitted from the resulting object.\n - `node_locations` (`list`): The list of zones in which the cluster\u0026#39;s nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster\u0026#39;s zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster\u0026#39;s zone. When `null`, the `node_locations` field will be omitted from the resulting object.\n - `node_version` (`string`): The Kubernetes version on the nodes. Must either be unset or set to the same value as min_master_version on create. Defaults to the default version set by GKE which is not necessarily the latest version. This only affects nodes in the default node pool. While a fuzzy version can be specified, it\u0026#39;s recommended that you specify explicit versions as Terraform will see spurious diffs when fuzzy versions are used. See the google_container_engine_versions data source\u0026#39;s version_prefix field to approximate fuzzy versions in a Terraform-compatible way. To update nodes in other node pools, use the version attribute on the node pool. When `null`, the `node_version` field will be omitted from the resulting object.\n - `private_ipv6_google_access` (`string`): The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4). When `null`, the `private_ipv6_google_access` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `remove_default_node_pool` (`bool`): If true, deletes the default node pool upon cluster creation. If you\u0026#39;re using google_container_node_pool resources with no default node pool, this should be set to true, alongside setting initial_node_count to at least 1. When `null`, the `remove_default_node_pool` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the cluster. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `subnetwork` (`string`): The name or self_link of the Google Compute Engine subnetwork in which the cluster\u0026#39;s instances are launched. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `addons_config` (`list[obj]`): The configuration for addons supported by GKE. When `null`, the `addons_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.addons_config.new](#fn-addons_confignew) constructor.\n - `authenticator_groups_config` (`list[obj]`): Configuration for the Google Groups for GKE feature. When `null`, the `authenticator_groups_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.authenticator_groups_config.new](#fn-authenticator_groups_confignew) constructor.\n - `binary_authorization` (`list[obj]`): Configuration options for the Binary Authorization feature. When `null`, the `binary_authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `cluster_autoscaling` (`list[obj]`): Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster\u0026#39;s workload. See the guide to using Node Auto-Provisioning for more details. When `null`, the `cluster_autoscaling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.cluster_autoscaling.new](#fn-cluster_autoscalingnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can\u0026#39;t be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. When `null`, the `confidential_nodes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.confidential_nodes.new](#fn-confidential_nodesnew) constructor.\n - `cost_management_config` (`list[obj]`): Cost management configuration for the cluster. When `null`, the `cost_management_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.cost_management_config.new](#fn-cost_management_confignew) constructor.\n - `database_encryption` (`list[obj]`): Application-layer Secrets Encryption settings. The object format is {state = string, key_name = string}. Valid values of state are: \u0026#34;ENCRYPTED\u0026#34;; \u0026#34;DECRYPTED\u0026#34;. key_name is the name of a CloudKMS key. When `null`, the `database_encryption` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.database_encryption.new](#fn-database_encryptionnew) constructor.\n - `default_snat_status` (`list[obj]`): Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled. When `null`, the `default_snat_status` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.default_snat_status.new](#fn-default_snat_statusnew) constructor.\n - `dns_config` (`list[obj]`): Configuration for Cloud DNS for Kubernetes Engine. When `null`, the `dns_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.dns_config.new](#fn-dns_confignew) constructor.\n - `enable_k8s_beta_apis` (`list[obj]`): Configuration for Kubernetes Beta APIs. When `null`, the `enable_k8s_beta_apis` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.enable_k8s_beta_apis.new](#fn-enable_k8s_beta_apisnew) constructor.\n - `fleet` (`list[obj]`): Fleet configuration of the cluster. When `null`, the `fleet` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.fleet.new](#fn-fleetnew) constructor.\n - `gateway_api_config` (`list[obj]`): Configuration for GKE Gateway API controller. When `null`, the `gateway_api_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.gateway_api_config.new](#fn-gateway_api_confignew) constructor.\n - `identity_service_config` (`list[obj]`): Configuration for Identity Service which allows customers to use external identity providers with the K8S API. When `null`, the `identity_service_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.identity_service_config.new](#fn-identity_service_confignew) constructor.\n - `ip_allocation_policy` (`list[obj]`): Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. When `null`, the `ip_allocation_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.ip_allocation_policy.new](#fn-ip_allocation_policynew) constructor.\n - `logging_config` (`list[obj]`): Logging configuration for the cluster. When `null`, the `logging_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.logging_config.new](#fn-logging_confignew) constructor.\n - `maintenance_policy` (`list[obj]`): The maintenance policy to use for the cluster. When `null`, the `maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.maintenance_policy.new](#fn-maintenance_policynew) constructor.\n - `master_auth` (`list[obj]`): The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff unsetting your client cert, ensure you have the container.clusters.getCredentials permission. When `null`, the `master_auth` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.master_auth.new](#fn-master_authnew) constructor.\n - `master_authorized_networks_config` (`list[obj]`): The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists). When `null`, the `master_authorized_networks_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.master_authorized_networks_config.new](#fn-master_authorized_networks_confignew) constructor.\n - `mesh_certificates` (`list[obj]`): If set, and enable_certificates=true, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster. When `null`, the `mesh_certificates` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.mesh_certificates.new](#fn-mesh_certificatesnew) constructor.\n - `monitoring_config` (`list[obj]`): Monitoring configuration for the cluster. When `null`, the `monitoring_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.monitoring_config.new](#fn-monitoring_confignew) constructor.\n - `network_policy` (`list[obj]`): Configuration options for the NetworkPolicy feature. When `null`, the `network_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.network_policy.new](#fn-network_policynew) constructor.\n - `node_config` (`list[obj]`): The configuration of the nodepool When `null`, the `node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.new](#fn-node_confignew) constructor.\n - `node_pool` (`list[obj]`): List of node pools associated with this cluster. See google_container_node_pool for schema. Warning: node pools defined inside a cluster can\u0026#39;t be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. Unless you absolutely need the ability to say \u0026#34;these are the only node pools associated with this cluster\u0026#34;, use the google_container_node_pool resource instead of this property. When `null`, the `node_pool` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.new](#fn-node_poolnew) constructor.\n - `node_pool_auto_config` (`list[obj]`): Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. When `null`, the `node_pool_auto_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool_auto_config.new](#fn-node_pool_auto_confignew) constructor.\n - `node_pool_defaults` (`list[obj]`): The default nodel pool settings for the entire cluster. When `null`, the `node_pool_defaults` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool_defaults.new](#fn-node_pool_defaultsnew) constructor.\n - `notification_config` (`list[obj]`): The notification config for sending cluster upgrade notifications When `null`, the `notification_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.notification_config.new](#fn-notification_confignew) constructor.\n - `private_cluster_config` (`list[obj]`): Configuration for private clusters, clusters with private nodes. When `null`, the `private_cluster_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.private_cluster_config.new](#fn-private_cluster_confignew) constructor.\n - `release_channel` (`list[obj]`): Configuration options for the Release channel feature, which provide more control over automatic upgrades of your GKE clusters. Note that removing this field from your config will not unenroll it. Instead, use the \u0026#34;UNSPECIFIED\u0026#34; channel. When `null`, the `release_channel` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.release_channel.new](#fn-release_channelnew) constructor.\n - `resource_usage_export_config` (`list[obj]`): Configuration for the ResourceUsageExportConfig feature. When `null`, the `resource_usage_export_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.resource_usage_export_config.new](#fn-resource_usage_export_confignew) constructor.\n - `security_posture_config` (`list[obj]`): Defines the config needed to enable/disable features for the Security Posture API When `null`, the `security_posture_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.security_posture_config.new](#fn-security_posture_confignew) constructor.\n - `service_external_ips_config` (`list[obj]`): If set, and enabled=true, services with external ips field will not be blocked When `null`, the `service_external_ips_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.service_external_ips_config.new](#fn-service_external_ips_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n - `vertical_pod_autoscaling` (`list[obj]`): Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. When `null`, the `vertical_pod_autoscaling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.vertical_pod_autoscaling.new](#fn-vertical_pod_autoscalingnew) constructor.\n - `workload_identity_config` (`list[obj]`): Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. When `null`, the `workload_identity_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.workload_identity_config.new](#fn-workload_identity_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -513,6 +521,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_legacy_abac=null, enable_shielded_nodes=null, enable_tpu=null, + fleet=null, gateway_api_config=null, identity_service_config=null, initial_node_count=null, @@ -578,6 +587,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_legacy_abac=enable_legacy_abac, enable_shielded_nodes=enable_shielded_nodes, enable_tpu=enable_tpu, + fleet=fleet, gateway_api_config=gateway_api_config, identity_service_config=identity_service_config, initial_node_count=initial_node_count, @@ -619,7 +629,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.container_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `container_cluster`\nTerraform resource.\n\nUnlike [google.container_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `allow_net_admin` (`bool`): Enable NET_ADMIN for this cluster. When `null`, the `allow_net_admin` field will be omitted from the resulting object.\n - `cluster_ipv4_cidr` (`string`): The IP address range of the Kubernetes pods in this cluster in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8. This field will only work for routes-based clusters, where ip_allocation_policy is not defined. When `null`, the `cluster_ipv4_cidr` field will be omitted from the resulting object.\n - `datapath_provider` (`string`): The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. When `null`, the `datapath_provider` field will be omitted from the resulting object.\n - `default_max_pods_per_node` (`number`): The default maximum number of pods per node in this cluster. This doesn't work on "routes-based" clusters, clusters that don't have IP Aliasing enabled. When `null`, the `default_max_pods_per_node` field will be omitted from the resulting object.\n - `deletion_protection` (`bool`): Whether or not to allow Terraform to destroy the instance. Defaults to true. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the cluster will fail. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `description` (`string`): Description of the cluster. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_autopilot` (`bool`): Enable Autopilot for this cluster. When `null`, the `enable_autopilot` field will be omitted from the resulting object.\n - `enable_intranode_visibility` (`bool`): Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. When `null`, the `enable_intranode_visibility` field will be omitted from the resulting object.\n - `enable_kubernetes_alpha` (`bool`): Whether to enable Kubernetes Alpha features for this cluster. Note that when this option is enabled, the cluster cannot be upgraded and will be automatically deleted after 30 days. When `null`, the `enable_kubernetes_alpha` field will be omitted from the resulting object.\n - `enable_l4_ilb_subsetting` (`bool`): Whether L4ILB Subsetting is enabled for this cluster. When `null`, the `enable_l4_ilb_subsetting` field will be omitted from the resulting object.\n - `enable_legacy_abac` (`bool`): Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. Defaults to false. When `null`, the `enable_legacy_abac` field will be omitted from the resulting object.\n - `enable_shielded_nodes` (`bool`): Enable Shielded Nodes features on all nodes in this cluster. Defaults to true. When `null`, the `enable_shielded_nodes` field will be omitted from the resulting object.\n - `enable_tpu` (`bool`): Whether to enable Cloud TPU resources in this cluster. When `null`, the `enable_tpu` field will be omitted from the resulting object.\n - `initial_node_count` (`number`): The number of nodes to create in this cluster's default node pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Must be set if node_pool is not set. If you're using google_container_node_pool objects with no default node pool, you'll need to set this to a value of at least 1, alongside setting remove_default_node_pool to true. When `null`, the `initial_node_count` field will be omitted from the resulting object.\n - `location` (`string`): The location (region or zone) in which the cluster master will be created, as well as the default node location. If you specify a zone (such as us-central1-a), the cluster will be a zonal cluster with a single cluster master. If you specify a region (such as us-west1), the cluster will be a regional cluster with multiple masters spread across zones in the region, and with default node locations in those zones as well. When `null`, the `location` field will be omitted from the resulting object.\n - `logging_service` (`string`): The logging service that the cluster should write logs to. Available options include logging.googleapis.com(Legacy Stackdriver), logging.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Logging), and none. Defaults to logging.googleapis.com/kubernetes. When `null`, the `logging_service` field will be omitted from the resulting object.\n - `min_master_version` (`string`): The minimum version of the master. GKE will auto-update the master to new versions, so this does not guarantee the current master version--use the read-only master_version field to obtain that. If unset, the cluster's version will be set by GKE to the version of the most recent official release (which is not necessarily the latest version). When `null`, the `min_master_version` field will be omitted from the resulting object.\n - `monitoring_service` (`string`): The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com(Legacy Stackdriver), monitoring.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Monitoring), and none. Defaults to monitoring.googleapis.com/kubernetes. When `null`, the `monitoring_service` field will be omitted from the resulting object.\n - `name` (`string`): The name of the cluster, unique within the project and location.\n - `network` (`string`): The name or self_link of the Google Compute Engine network to which the cluster is connected. For Shared VPC, set this to the self link of the shared network. When `null`, the `network` field will be omitted from the resulting object.\n - `networking_mode` (`string`): Determines whether alias IPs or routes will be used for pod IPs in the cluster. Defaults to VPC_NATIVE for new clusters. When `null`, the `networking_mode` field will be omitted from the resulting object.\n - `node_locations` (`list`): The list of zones in which the cluster's nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster's zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster's zone. When `null`, the `node_locations` field will be omitted from the resulting object.\n - `node_version` (`string`): The Kubernetes version on the nodes. Must either be unset or set to the same value as min_master_version on create. Defaults to the default version set by GKE which is not necessarily the latest version. This only affects nodes in the default node pool. While a fuzzy version can be specified, it's recommended that you specify explicit versions as Terraform will see spurious diffs when fuzzy versions are used. See the google_container_engine_versions data source's version_prefix field to approximate fuzzy versions in a Terraform-compatible way. To update nodes in other node pools, use the version attribute on the node pool. When `null`, the `node_version` field will be omitted from the resulting object.\n - `private_ipv6_google_access` (`string`): The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4). When `null`, the `private_ipv6_google_access` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `remove_default_node_pool` (`bool`): If true, deletes the default node pool upon cluster creation. If you're using google_container_node_pool resources with no default node pool, this should be set to true, alongside setting initial_node_count to at least 1. When `null`, the `remove_default_node_pool` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the cluster. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `subnetwork` (`string`): The name or self_link of the Google Compute Engine subnetwork in which the cluster's instances are launched. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `addons_config` (`list[obj]`): The configuration for addons supported by GKE. When `null`, the `addons_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.addons_config.new](#fn-addons_confignew) constructor.\n - `authenticator_groups_config` (`list[obj]`): Configuration for the Google Groups for GKE feature. When `null`, the `authenticator_groups_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.authenticator_groups_config.new](#fn-authenticator_groups_confignew) constructor.\n - `binary_authorization` (`list[obj]`): Configuration options for the Binary Authorization feature. When `null`, the `binary_authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `cluster_autoscaling` (`list[obj]`): Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster's workload. See the guide to using Node Auto-Provisioning for more details. When `null`, the `cluster_autoscaling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.cluster_autoscaling.new](#fn-cluster_autoscalingnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. When `null`, the `confidential_nodes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.confidential_nodes.new](#fn-confidential_nodesnew) constructor.\n - `cost_management_config` (`list[obj]`): Cost management configuration for the cluster. When `null`, the `cost_management_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.cost_management_config.new](#fn-cost_management_confignew) constructor.\n - `database_encryption` (`list[obj]`): Application-layer Secrets Encryption settings. The object format is {state = string, key_name = string}. Valid values of state are: "ENCRYPTED"; "DECRYPTED". key_name is the name of a CloudKMS key. When `null`, the `database_encryption` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.database_encryption.new](#fn-database_encryptionnew) constructor.\n - `default_snat_status` (`list[obj]`): Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled. When `null`, the `default_snat_status` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.default_snat_status.new](#fn-default_snat_statusnew) constructor.\n - `dns_config` (`list[obj]`): Configuration for Cloud DNS for Kubernetes Engine. When `null`, the `dns_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.dns_config.new](#fn-dns_confignew) constructor.\n - `enable_k8s_beta_apis` (`list[obj]`): Configuration for Kubernetes Beta APIs. When `null`, the `enable_k8s_beta_apis` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.enable_k8s_beta_apis.new](#fn-enable_k8s_beta_apisnew) constructor.\n - `gateway_api_config` (`list[obj]`): Configuration for GKE Gateway API controller. When `null`, the `gateway_api_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.gateway_api_config.new](#fn-gateway_api_confignew) constructor.\n - `identity_service_config` (`list[obj]`): Configuration for Identity Service which allows customers to use external identity providers with the K8S API. When `null`, the `identity_service_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.identity_service_config.new](#fn-identity_service_confignew) constructor.\n - `ip_allocation_policy` (`list[obj]`): Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. When `null`, the `ip_allocation_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.ip_allocation_policy.new](#fn-ip_allocation_policynew) constructor.\n - `logging_config` (`list[obj]`): Logging configuration for the cluster. When `null`, the `logging_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.logging_config.new](#fn-logging_confignew) constructor.\n - `maintenance_policy` (`list[obj]`): The maintenance policy to use for the cluster. When `null`, the `maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.maintenance_policy.new](#fn-maintenance_policynew) constructor.\n - `master_auth` (`list[obj]`): The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff unsetting your client cert, ensure you have the container.clusters.getCredentials permission. When `null`, the `master_auth` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.master_auth.new](#fn-master_authnew) constructor.\n - `master_authorized_networks_config` (`list[obj]`): The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists). When `null`, the `master_authorized_networks_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.master_authorized_networks_config.new](#fn-master_authorized_networks_confignew) constructor.\n - `mesh_certificates` (`list[obj]`): If set, and enable_certificates=true, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster. When `null`, the `mesh_certificates` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.mesh_certificates.new](#fn-mesh_certificatesnew) constructor.\n - `monitoring_config` (`list[obj]`): Monitoring configuration for the cluster. When `null`, the `monitoring_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.monitoring_config.new](#fn-monitoring_confignew) constructor.\n - `network_policy` (`list[obj]`): Configuration options for the NetworkPolicy feature. When `null`, the `network_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.network_policy.new](#fn-network_policynew) constructor.\n - `node_config` (`list[obj]`): The configuration of the nodepool When `null`, the `node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.new](#fn-node_confignew) constructor.\n - `node_pool` (`list[obj]`): List of node pools associated with this cluster. See google_container_node_pool for schema. Warning: node pools defined inside a cluster can't be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. Unless you absolutely need the ability to say "these are the only node pools associated with this cluster", use the google_container_node_pool resource instead of this property. When `null`, the `node_pool` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.new](#fn-node_poolnew) constructor.\n - `node_pool_auto_config` (`list[obj]`): Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. When `null`, the `node_pool_auto_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool_auto_config.new](#fn-node_pool_auto_confignew) constructor.\n - `node_pool_defaults` (`list[obj]`): The default nodel pool settings for the entire cluster. When `null`, the `node_pool_defaults` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool_defaults.new](#fn-node_pool_defaultsnew) constructor.\n - `notification_config` (`list[obj]`): The notification config for sending cluster upgrade notifications When `null`, the `notification_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.notification_config.new](#fn-notification_confignew) constructor.\n - `private_cluster_config` (`list[obj]`): Configuration for private clusters, clusters with private nodes. When `null`, the `private_cluster_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.private_cluster_config.new](#fn-private_cluster_confignew) constructor.\n - `release_channel` (`list[obj]`): Configuration options for the Release channel feature, which provide more control over automatic upgrades of your GKE clusters. Note that removing this field from your config will not unenroll it. Instead, use the "UNSPECIFIED" channel. When `null`, the `release_channel` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.release_channel.new](#fn-release_channelnew) constructor.\n - `resource_usage_export_config` (`list[obj]`): Configuration for the ResourceUsageExportConfig feature. When `null`, the `resource_usage_export_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.resource_usage_export_config.new](#fn-resource_usage_export_confignew) constructor.\n - `security_posture_config` (`list[obj]`): Defines the config needed to enable/disable features for the Security Posture API When `null`, the `security_posture_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.security_posture_config.new](#fn-security_posture_confignew) constructor.\n - `service_external_ips_config` (`list[obj]`): If set, and enabled=true, services with external ips field will not be blocked When `null`, the `service_external_ips_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.service_external_ips_config.new](#fn-service_external_ips_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n - `vertical_pod_autoscaling` (`list[obj]`): Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. When `null`, the `vertical_pod_autoscaling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.vertical_pod_autoscaling.new](#fn-vertical_pod_autoscalingnew) constructor.\n - `workload_identity_config` (`list[obj]`): Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. When `null`, the `workload_identity_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.workload_identity_config.new](#fn-workload_identity_confignew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `container_cluster` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.container_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `container_cluster`\nTerraform resource.\n\nUnlike [google.container_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `allow_net_admin` (`bool`): Enable NET_ADMIN for this cluster. When `null`, the `allow_net_admin` field will be omitted from the resulting object.\n - `cluster_ipv4_cidr` (`string`): The IP address range of the Kubernetes pods in this cluster in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8. This field will only work for routes-based clusters, where ip_allocation_policy is not defined. When `null`, the `cluster_ipv4_cidr` field will be omitted from the resulting object.\n - `datapath_provider` (`string`): The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. When `null`, the `datapath_provider` field will be omitted from the resulting object.\n - `default_max_pods_per_node` (`number`): The default maximum number of pods per node in this cluster. This doesn't work on "routes-based" clusters, clusters that don't have IP Aliasing enabled. When `null`, the `default_max_pods_per_node` field will be omitted from the resulting object.\n - `deletion_protection` (`bool`): Whether or not to allow Terraform to destroy the instance. Defaults to true. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the cluster will fail. When `null`, the `deletion_protection` field will be omitted from the resulting object.\n - `description` (`string`): Description of the cluster. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_autopilot` (`bool`): Enable Autopilot for this cluster. When `null`, the `enable_autopilot` field will be omitted from the resulting object.\n - `enable_intranode_visibility` (`bool`): Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. When `null`, the `enable_intranode_visibility` field will be omitted from the resulting object.\n - `enable_kubernetes_alpha` (`bool`): Whether to enable Kubernetes Alpha features for this cluster. Note that when this option is enabled, the cluster cannot be upgraded and will be automatically deleted after 30 days. When `null`, the `enable_kubernetes_alpha` field will be omitted from the resulting object.\n - `enable_l4_ilb_subsetting` (`bool`): Whether L4ILB Subsetting is enabled for this cluster. When `null`, the `enable_l4_ilb_subsetting` field will be omitted from the resulting object.\n - `enable_legacy_abac` (`bool`): Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. Defaults to false. When `null`, the `enable_legacy_abac` field will be omitted from the resulting object.\n - `enable_shielded_nodes` (`bool`): Enable Shielded Nodes features on all nodes in this cluster. Defaults to true. When `null`, the `enable_shielded_nodes` field will be omitted from the resulting object.\n - `enable_tpu` (`bool`): Whether to enable Cloud TPU resources in this cluster. When `null`, the `enable_tpu` field will be omitted from the resulting object.\n - `initial_node_count` (`number`): The number of nodes to create in this cluster's default node pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Must be set if node_pool is not set. If you're using google_container_node_pool objects with no default node pool, you'll need to set this to a value of at least 1, alongside setting remove_default_node_pool to true. When `null`, the `initial_node_count` field will be omitted from the resulting object.\n - `location` (`string`): The location (region or zone) in which the cluster master will be created, as well as the default node location. If you specify a zone (such as us-central1-a), the cluster will be a zonal cluster with a single cluster master. If you specify a region (such as us-west1), the cluster will be a regional cluster with multiple masters spread across zones in the region, and with default node locations in those zones as well. When `null`, the `location` field will be omitted from the resulting object.\n - `logging_service` (`string`): The logging service that the cluster should write logs to. Available options include logging.googleapis.com(Legacy Stackdriver), logging.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Logging), and none. Defaults to logging.googleapis.com/kubernetes. When `null`, the `logging_service` field will be omitted from the resulting object.\n - `min_master_version` (`string`): The minimum version of the master. GKE will auto-update the master to new versions, so this does not guarantee the current master version--use the read-only master_version field to obtain that. If unset, the cluster's version will be set by GKE to the version of the most recent official release (which is not necessarily the latest version). When `null`, the `min_master_version` field will be omitted from the resulting object.\n - `monitoring_service` (`string`): The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com(Legacy Stackdriver), monitoring.googleapis.com/kubernetes(Stackdriver Kubernetes Engine Monitoring), and none. Defaults to monitoring.googleapis.com/kubernetes. When `null`, the `monitoring_service` field will be omitted from the resulting object.\n - `name` (`string`): The name of the cluster, unique within the project and location.\n - `network` (`string`): The name or self_link of the Google Compute Engine network to which the cluster is connected. For Shared VPC, set this to the self link of the shared network. When `null`, the `network` field will be omitted from the resulting object.\n - `networking_mode` (`string`): Determines whether alias IPs or routes will be used for pod IPs in the cluster. Defaults to VPC_NATIVE for new clusters. When `null`, the `networking_mode` field will be omitted from the resulting object.\n - `node_locations` (`list`): The list of zones in which the cluster's nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster's zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster's zone. When `null`, the `node_locations` field will be omitted from the resulting object.\n - `node_version` (`string`): The Kubernetes version on the nodes. Must either be unset or set to the same value as min_master_version on create. Defaults to the default version set by GKE which is not necessarily the latest version. This only affects nodes in the default node pool. While a fuzzy version can be specified, it's recommended that you specify explicit versions as Terraform will see spurious diffs when fuzzy versions are used. See the google_container_engine_versions data source's version_prefix field to approximate fuzzy versions in a Terraform-compatible way. To update nodes in other node pools, use the version attribute on the node pool. When `null`, the `node_version` field will be omitted from the resulting object.\n - `private_ipv6_google_access` (`string`): The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4). When `null`, the `private_ipv6_google_access` field will be omitted from the resulting object.\n - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object.\n - `remove_default_node_pool` (`bool`): If true, deletes the default node pool upon cluster creation. If you're using google_container_node_pool resources with no default node pool, this should be set to true, alongside setting initial_node_count to at least 1. When `null`, the `remove_default_node_pool` field will be omitted from the resulting object.\n - `resource_labels` (`obj`): The GCE resource labels (a map of key/value pairs) to be applied to the cluster. When `null`, the `resource_labels` field will be omitted from the resulting object.\n - `subnetwork` (`string`): The name or self_link of the Google Compute Engine subnetwork in which the cluster's instances are launched. When `null`, the `subnetwork` field will be omitted from the resulting object.\n - `addons_config` (`list[obj]`): The configuration for addons supported by GKE. When `null`, the `addons_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.addons_config.new](#fn-addons_confignew) constructor.\n - `authenticator_groups_config` (`list[obj]`): Configuration for the Google Groups for GKE feature. When `null`, the `authenticator_groups_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.authenticator_groups_config.new](#fn-authenticator_groups_confignew) constructor.\n - `binary_authorization` (`list[obj]`): Configuration options for the Binary Authorization feature. When `null`, the `binary_authorization` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.binary_authorization.new](#fn-binary_authorizationnew) constructor.\n - `cluster_autoscaling` (`list[obj]`): Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster's workload. See the guide to using Node Auto-Provisioning for more details. When `null`, the `cluster_autoscaling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.cluster_autoscaling.new](#fn-cluster_autoscalingnew) constructor.\n - `confidential_nodes` (`list[obj]`): Configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Warning: This configuration can't be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. When `null`, the `confidential_nodes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.confidential_nodes.new](#fn-confidential_nodesnew) constructor.\n - `cost_management_config` (`list[obj]`): Cost management configuration for the cluster. When `null`, the `cost_management_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.cost_management_config.new](#fn-cost_management_confignew) constructor.\n - `database_encryption` (`list[obj]`): Application-layer Secrets Encryption settings. The object format is {state = string, key_name = string}. Valid values of state are: "ENCRYPTED"; "DECRYPTED". key_name is the name of a CloudKMS key. When `null`, the `database_encryption` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.database_encryption.new](#fn-database_encryptionnew) constructor.\n - `default_snat_status` (`list[obj]`): Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled. When `null`, the `default_snat_status` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.default_snat_status.new](#fn-default_snat_statusnew) constructor.\n - `dns_config` (`list[obj]`): Configuration for Cloud DNS for Kubernetes Engine. When `null`, the `dns_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.dns_config.new](#fn-dns_confignew) constructor.\n - `enable_k8s_beta_apis` (`list[obj]`): Configuration for Kubernetes Beta APIs. When `null`, the `enable_k8s_beta_apis` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.enable_k8s_beta_apis.new](#fn-enable_k8s_beta_apisnew) constructor.\n - `fleet` (`list[obj]`): Fleet configuration of the cluster. When `null`, the `fleet` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.fleet.new](#fn-fleetnew) constructor.\n - `gateway_api_config` (`list[obj]`): Configuration for GKE Gateway API controller. When `null`, the `gateway_api_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.gateway_api_config.new](#fn-gateway_api_confignew) constructor.\n - `identity_service_config` (`list[obj]`): Configuration for Identity Service which allows customers to use external identity providers with the K8S API. When `null`, the `identity_service_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.identity_service_config.new](#fn-identity_service_confignew) constructor.\n - `ip_allocation_policy` (`list[obj]`): Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. When `null`, the `ip_allocation_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.ip_allocation_policy.new](#fn-ip_allocation_policynew) constructor.\n - `logging_config` (`list[obj]`): Logging configuration for the cluster. When `null`, the `logging_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.logging_config.new](#fn-logging_confignew) constructor.\n - `maintenance_policy` (`list[obj]`): The maintenance policy to use for the cluster. When `null`, the `maintenance_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.maintenance_policy.new](#fn-maintenance_policynew) constructor.\n - `master_auth` (`list[obj]`): The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff unsetting your client cert, ensure you have the container.clusters.getCredentials permission. When `null`, the `master_auth` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.master_auth.new](#fn-master_authnew) constructor.\n - `master_authorized_networks_config` (`list[obj]`): The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists). When `null`, the `master_authorized_networks_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.master_authorized_networks_config.new](#fn-master_authorized_networks_confignew) constructor.\n - `mesh_certificates` (`list[obj]`): If set, and enable_certificates=true, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster. When `null`, the `mesh_certificates` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.mesh_certificates.new](#fn-mesh_certificatesnew) constructor.\n - `monitoring_config` (`list[obj]`): Monitoring configuration for the cluster. When `null`, the `monitoring_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.monitoring_config.new](#fn-monitoring_confignew) constructor.\n - `network_policy` (`list[obj]`): Configuration options for the NetworkPolicy feature. When `null`, the `network_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.network_policy.new](#fn-network_policynew) constructor.\n - `node_config` (`list[obj]`): The configuration of the nodepool When `null`, the `node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_config.new](#fn-node_confignew) constructor.\n - `node_pool` (`list[obj]`): List of node pools associated with this cluster. See google_container_node_pool for schema. Warning: node pools defined inside a cluster can't be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. Unless you absolutely need the ability to say "these are the only node pools associated with this cluster", use the google_container_node_pool resource instead of this property. When `null`, the `node_pool` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool.new](#fn-node_poolnew) constructor.\n - `node_pool_auto_config` (`list[obj]`): Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. When `null`, the `node_pool_auto_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool_auto_config.new](#fn-node_pool_auto_confignew) constructor.\n - `node_pool_defaults` (`list[obj]`): The default nodel pool settings for the entire cluster. When `null`, the `node_pool_defaults` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.node_pool_defaults.new](#fn-node_pool_defaultsnew) constructor.\n - `notification_config` (`list[obj]`): The notification config for sending cluster upgrade notifications When `null`, the `notification_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.notification_config.new](#fn-notification_confignew) constructor.\n - `private_cluster_config` (`list[obj]`): Configuration for private clusters, clusters with private nodes. When `null`, the `private_cluster_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.private_cluster_config.new](#fn-private_cluster_confignew) constructor.\n - `release_channel` (`list[obj]`): Configuration options for the Release channel feature, which provide more control over automatic upgrades of your GKE clusters. Note that removing this field from your config will not unenroll it. Instead, use the "UNSPECIFIED" channel. When `null`, the `release_channel` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.release_channel.new](#fn-release_channelnew) constructor.\n - `resource_usage_export_config` (`list[obj]`): Configuration for the ResourceUsageExportConfig feature. When `null`, the `resource_usage_export_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.resource_usage_export_config.new](#fn-resource_usage_export_confignew) constructor.\n - `security_posture_config` (`list[obj]`): Defines the config needed to enable/disable features for the Security Posture API When `null`, the `security_posture_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.security_posture_config.new](#fn-security_posture_confignew) constructor.\n - `service_external_ips_config` (`list[obj]`): If set, and enabled=true, services with external ips field will not be blocked When `null`, the `service_external_ips_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.service_external_ips_config.new](#fn-service_external_ips_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n - `vertical_pod_autoscaling` (`list[obj]`): Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. When `null`, the `vertical_pod_autoscaling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.vertical_pod_autoscaling.new](#fn-vertical_pod_autoscalingnew) constructor.\n - `workload_identity_config` (`list[obj]`): Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. When `null`, the `workload_identity_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.workload_identity_config.new](#fn-workload_identity_confignew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `container_cluster` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, addons_config=null, @@ -645,6 +655,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_legacy_abac=null, enable_shielded_nodes=null, enable_tpu=null, + fleet=null, gateway_api_config=null, identity_service_config=null, initial_node_count=null, @@ -706,6 +717,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_legacy_abac: enable_legacy_abac, enable_shielded_nodes: enable_shielded_nodes, enable_tpu: enable_tpu, + fleet: fleet, gateway_api_config: gateway_api_config, identity_service_config: identity_service_config, initial_node_count: initial_node_count, @@ -1801,6 +1813,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withFleet':: d.fn(help='`google.list[obj].withFleet` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the fleet field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withFleetMixin](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 `fleet` field.\n', args=[]), + withFleet(resourceLabel, value): { + resource+: { + google_container_cluster+: { + [resourceLabel]+: { + fleet: value, + }, + }, + }, + }, + '#withFleetMixin':: d.fn(help='`google.list[obj].withFleetMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the fleet field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withFleet](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 `fleet` field.\n', args=[]), + withFleetMixin(resourceLabel, value): { + resource+: { + google_container_cluster+: { + [resourceLabel]+: { + fleet+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withGatewayApiConfig':: d.fn(help='`google.list[obj].withGatewayApiConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the gateway_api_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withGatewayApiConfigMixin](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 `gateway_api_config` field.\n', args=[]), withGatewayApiConfig(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/dialogflow_cx_flow.libsonnet b/4.x/_gen/resources/dialogflow_cx_flow.libsonnet index ec7fc894..8da9578a 100644 --- a/4.x/_gen/resources/dialogflow_cx_flow.libsonnet +++ b/4.x/_gen/resources/dialogflow_cx_flow.libsonnet @@ -154,13 +154,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, - '#new':: d.fn(help="\n`google.dialogflow_cx_flow.new` injects a new `google_dialogflow_cx_flow` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.dialogflow_cx_flow.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.dialogflow_cx_flow` using the reference:\n\n $._ref.google_dialogflow_cx_flow.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_dialogflow_cx_flow.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 flow. 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 human-readable name of the flow.\n - `language_code` (`string`): The language of the following fields in flow:\nFlow.event_handlers.trigger_fulfillment.messages\nFlow.event_handlers.trigger_fulfillment.conditional_cases\nFlow.transition_routes.trigger_fulfillment.messages\nFlow.transition_routes.trigger_fulfillment.conditional_cases\nIf not specified, the agent\u0026#39;s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. When `null`, the `language_code` field will be omitted from the resulting object.\n - `parent` (`string`): The agent to create a flow for.\nFormat: projects/\u0026lt;Project ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/agents/\u0026lt;Agent ID\u0026gt;. When `null`, the `parent` field will be omitted from the resulting object.\n - `transition_route_groups` (`list`): A flow\u0026#39;s transition route group serve two purposes:\nThey are responsible for matching the user\u0026#39;s first utterances in the flow.\nThey are inherited by every page\u0026#39;s [transition route groups][Page.transition_route_groups]. Transition route groups defined in the page have higher priority than those defined in the flow.\nFormat:projects/\u0026lt;Project ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/agents/\u0026lt;Agent ID\u0026gt;/flows/\u0026lt;Flow ID\u0026gt;/transitionRouteGroups/\u0026lt;TransitionRouteGroup ID\u0026gt;. When `null`, the `transition_route_groups` field will be omitted from the resulting object.\n - `advanced_settings` (`list[obj]`): Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.\nHierarchy: Agent-\u0026gt;Flow-\u0026gt;Page-\u0026gt;Fulfillment/Parameter. When `null`, the `advanced_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.advanced_settings.new](#fn-advanced_settingsnew) constructor.\n - `event_handlers` (`list[obj]`): A flow\u0026#39;s event handlers serve two purposes:\nThey are responsible for handling events (e.g. no match, webhook errors) in the flow.\nThey are inherited by every page\u0026#39;s [event handlers][Page.event_handlers], which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.\nUnlike transitionRoutes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. When `null`, the `event_handlers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.new](#fn-event_handlersnew) constructor.\n - `nlu_settings` (`list[obj]`): NLU related settings of the flow. When `null`, the `nlu_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.nlu_settings.new](#fn-nlu_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.timeouts.new](#fn-timeoutsnew) constructor.\n - `transition_routes` (`list[obj]`): A flow\u0026#39;s transition routes serve two purposes:\nThey are responsible for matching the user\u0026#39;s first utterances in the flow.\nThey are inherited by every page\u0026#39;s [transition routes][Page.transition_routes] and can support use cases such as the user saying \u0026#34;help\u0026#34; or \u0026#34;can I talk to a human?\u0026#34;, which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.\n\nTransitionRoutes are evalauted in the following order:\n TransitionRoutes with intent specified.\n TransitionRoutes with only condition specified.\n TransitionRoutes with intent specified are inherited by pages in the flow. When `null`, the `transition_routes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.new](#fn-transition_routesnew) 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.dialogflow_cx_flow.new` injects a new `google_dialogflow_cx_flow` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.dialogflow_cx_flow.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.dialogflow_cx_flow` using the reference:\n\n $._ref.google_dialogflow_cx_flow.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_dialogflow_cx_flow.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 flow. 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 human-readable name of the flow.\n - `is_default_start_flow` (`bool`): Marks this as the [Default Start Flow](https://cloud.google.com/dialogflow/cx/docs/concept/flow#start) for an agent. When you create an agent, the Default Start Flow is created automatically.\nThe Default Start Flow cannot be deleted; deleting the \u0026#39;google_dialogflow_cx_flow\u0026#39; resource does nothing to the underlying GCP resources.\n\n~\u0026gt; Avoid having multiple \u0026#39;google_dialogflow_cx_flow\u0026#39; resources linked to the same agent with \u0026#39;is_default_start_flow = true\u0026#39; because they will compete to control a single Default Start Flow resource in GCP. When `null`, the `is_default_start_flow` field will be omitted from the resulting object.\n - `language_code` (`string`): The language of the following fields in flow:\nFlow.event_handlers.trigger_fulfillment.messages\nFlow.event_handlers.trigger_fulfillment.conditional_cases\nFlow.transition_routes.trigger_fulfillment.messages\nFlow.transition_routes.trigger_fulfillment.conditional_cases\nIf not specified, the agent\u0026#39;s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. When `null`, the `language_code` field will be omitted from the resulting object.\n - `parent` (`string`): The agent to create a flow for.\nFormat: projects/\u0026lt;Project ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/agents/\u0026lt;Agent ID\u0026gt;. When `null`, the `parent` field will be omitted from the resulting object.\n - `transition_route_groups` (`list`): A flow\u0026#39;s transition route group serve two purposes:\nThey are responsible for matching the user\u0026#39;s first utterances in the flow.\nThey are inherited by every page\u0026#39;s [transition route groups][Page.transition_route_groups]. Transition route groups defined in the page have higher priority than those defined in the flow.\nFormat:projects/\u0026lt;Project ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/agents/\u0026lt;Agent ID\u0026gt;/flows/\u0026lt;Flow ID\u0026gt;/transitionRouteGroups/\u0026lt;TransitionRouteGroup ID\u0026gt;. When `null`, the `transition_route_groups` field will be omitted from the resulting object.\n - `advanced_settings` (`list[obj]`): Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.\nHierarchy: Agent-\u0026gt;Flow-\u0026gt;Page-\u0026gt;Fulfillment/Parameter. When `null`, the `advanced_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.advanced_settings.new](#fn-advanced_settingsnew) constructor.\n - `event_handlers` (`list[obj]`): A flow\u0026#39;s event handlers serve two purposes:\nThey are responsible for handling events (e.g. no match, webhook errors) in the flow.\nThey are inherited by every page\u0026#39;s [event handlers][Page.event_handlers], which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.\nUnlike transitionRoutes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. When `null`, the `event_handlers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.new](#fn-event_handlersnew) constructor.\n - `nlu_settings` (`list[obj]`): NLU related settings of the flow. When `null`, the `nlu_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.nlu_settings.new](#fn-nlu_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.timeouts.new](#fn-timeoutsnew) constructor.\n - `transition_routes` (`list[obj]`): A flow\u0026#39;s transition routes serve two purposes:\nThey are responsible for matching the user\u0026#39;s first utterances in the flow.\nThey are inherited by every page\u0026#39;s [transition routes][Page.transition_routes] and can support use cases such as the user saying \u0026#34;help\u0026#34; or \u0026#34;can I talk to a human?\u0026#34;, which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.\n\nTransitionRoutes are evalauted in the following order:\n TransitionRoutes with intent specified.\n TransitionRoutes with only condition specified.\n TransitionRoutes with intent specified are inherited by pages in the flow. When `null`, the `transition_routes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.new](#fn-transition_routesnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name, advanced_settings=null, description=null, event_handlers=null, + is_default_start_flow=null, language_code=null, nlu_settings=null, parent=null, @@ -176,6 +177,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); description=description, display_name=display_name, event_handlers=event_handlers, + is_default_start_flow=is_default_start_flow, language_code=language_code, nlu_settings=nlu_settings, parent=parent, @@ -185,12 +187,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.dialogflow_cx_flow.newAttrs` constructs a new object with attributes and blocks configured for the `dialogflow_cx_flow`\nTerraform resource.\n\nUnlike [google.dialogflow_cx_flow.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 flow. 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 human-readable name of the flow.\n - `language_code` (`string`): The language of the following fields in flow:\nFlow.event_handlers.trigger_fulfillment.messages\nFlow.event_handlers.trigger_fulfillment.conditional_cases\nFlow.transition_routes.trigger_fulfillment.messages\nFlow.transition_routes.trigger_fulfillment.conditional_cases\nIf not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. When `null`, the `language_code` field will be omitted from the resulting object.\n - `parent` (`string`): The agent to create a flow for.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. When `null`, the `parent` field will be omitted from the resulting object.\n - `transition_route_groups` (`list`): A flow's transition route group serve two purposes:\nThey are responsible for matching the user's first utterances in the flow.\nThey are inherited by every page's [transition route groups][Page.transition_route_groups]. Transition route groups defined in the page have higher priority than those defined in the flow.\nFormat:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>. When `null`, the `transition_route_groups` field will be omitted from the resulting object.\n - `advanced_settings` (`list[obj]`): Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.\nHierarchy: Agent->Flow->Page->Fulfillment/Parameter. When `null`, the `advanced_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.advanced_settings.new](#fn-advanced_settingsnew) constructor.\n - `event_handlers` (`list[obj]`): A flow's event handlers serve two purposes:\nThey are responsible for handling events (e.g. no match, webhook errors) in the flow.\nThey are inherited by every page's [event handlers][Page.event_handlers], which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.\nUnlike transitionRoutes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. When `null`, the `event_handlers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.new](#fn-event_handlersnew) constructor.\n - `nlu_settings` (`list[obj]`): NLU related settings of the flow. When `null`, the `nlu_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.nlu_settings.new](#fn-nlu_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.timeouts.new](#fn-timeoutsnew) constructor.\n - `transition_routes` (`list[obj]`): A flow's transition routes serve two purposes:\nThey are responsible for matching the user's first utterances in the flow.\nThey are inherited by every page's [transition routes][Page.transition_routes] and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.\n\nTransitionRoutes are evalauted in the following order:\n TransitionRoutes with intent specified.\n TransitionRoutes with only condition specified.\n TransitionRoutes with intent specified are inherited by pages in the flow. When `null`, the `transition_routes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.new](#fn-transition_routesnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `dialogflow_cx_flow` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.dialogflow_cx_flow.newAttrs` constructs a new object with attributes and blocks configured for the `dialogflow_cx_flow`\nTerraform resource.\n\nUnlike [google.dialogflow_cx_flow.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 flow. 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 human-readable name of the flow.\n - `is_default_start_flow` (`bool`): Marks this as the [Default Start Flow](https://cloud.google.com/dialogflow/cx/docs/concept/flow#start) for an agent. When you create an agent, the Default Start Flow is created automatically.\nThe Default Start Flow cannot be deleted; deleting the 'google_dialogflow_cx_flow' resource does nothing to the underlying GCP resources.\n\n~> Avoid having multiple 'google_dialogflow_cx_flow' resources linked to the same agent with 'is_default_start_flow = true' because they will compete to control a single Default Start Flow resource in GCP. When `null`, the `is_default_start_flow` field will be omitted from the resulting object.\n - `language_code` (`string`): The language of the following fields in flow:\nFlow.event_handlers.trigger_fulfillment.messages\nFlow.event_handlers.trigger_fulfillment.conditional_cases\nFlow.transition_routes.trigger_fulfillment.messages\nFlow.transition_routes.trigger_fulfillment.conditional_cases\nIf not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. When `null`, the `language_code` field will be omitted from the resulting object.\n - `parent` (`string`): The agent to create a flow for.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. When `null`, the `parent` field will be omitted from the resulting object.\n - `transition_route_groups` (`list`): A flow's transition route group serve two purposes:\nThey are responsible for matching the user's first utterances in the flow.\nThey are inherited by every page's [transition route groups][Page.transition_route_groups]. Transition route groups defined in the page have higher priority than those defined in the flow.\nFormat:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>. When `null`, the `transition_route_groups` field will be omitted from the resulting object.\n - `advanced_settings` (`list[obj]`): Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.\nHierarchy: Agent->Flow->Page->Fulfillment/Parameter. When `null`, the `advanced_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.advanced_settings.new](#fn-advanced_settingsnew) constructor.\n - `event_handlers` (`list[obj]`): A flow's event handlers serve two purposes:\nThey are responsible for handling events (e.g. no match, webhook errors) in the flow.\nThey are inherited by every page's [event handlers][Page.event_handlers], which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.\nUnlike transitionRoutes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. When `null`, the `event_handlers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.event_handlers.new](#fn-event_handlersnew) constructor.\n - `nlu_settings` (`list[obj]`): NLU related settings of the flow. When `null`, the `nlu_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.nlu_settings.new](#fn-nlu_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.timeouts.new](#fn-timeoutsnew) constructor.\n - `transition_routes` (`list[obj]`): A flow's transition routes serve two purposes:\nThey are responsible for matching the user's first utterances in the flow.\nThey are inherited by every page's [transition routes][Page.transition_routes] and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.\n\nTransitionRoutes are evalauted in the following order:\n TransitionRoutes with intent specified.\n TransitionRoutes with only condition specified.\n TransitionRoutes with intent specified are inherited by pages in the flow. When `null`, the `transition_routes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_flow.transition_routes.new](#fn-transition_routesnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `dialogflow_cx_flow` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, advanced_settings=null, description=null, event_handlers=null, + is_default_start_flow=null, language_code=null, nlu_settings=null, parent=null, @@ -202,6 +205,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); description: description, display_name: display_name, event_handlers: event_handlers, + is_default_start_flow: is_default_start_flow, language_code: language_code, nlu_settings: nlu_settings, parent: parent, @@ -417,6 +421,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withIsDefaultStartFlow':: d.fn(help='`google.bool.withIsDefaultStartFlow` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the is_default_start_flow field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `is_default_start_flow` field.\n', args=[]), + withIsDefaultStartFlow(resourceLabel, value): { + resource+: { + google_dialogflow_cx_flow+: { + [resourceLabel]+: { + is_default_start_flow: value, + }, + }, + }, + }, '#withLanguageCode':: d.fn(help='`google.string.withLanguageCode` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the language_code 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 `language_code` field.\n', args=[]), withLanguageCode(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/dialogflow_cx_intent.libsonnet b/4.x/_gen/resources/dialogflow_cx_intent.libsonnet index 0fb789b6..337460ce 100644 --- a/4.x/_gen/resources/dialogflow_cx_intent.libsonnet +++ b/4.x/_gen/resources/dialogflow_cx_intent.libsonnet @@ -2,11 +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='dialogflow_cx_intent', url='', help='`dialogflow_cx_intent` represents the `google_dialogflow_cx_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.dialogflow_cx_intent.new` injects a new `google_dialogflow_cx_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.dialogflow_cx_intent.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.dialogflow_cx_intent` using the reference:\n\n $._ref.google_dialogflow_cx_intent.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_dialogflow_cx_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 - `description` (`string`): Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable name of the intent, unique within the agent.\n - `is_fallback` (`bool`): Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation.\nAdding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. When `null`, the `is_fallback` field will be omitted from the resulting object.\n - `labels` (`obj`): The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols \u0026#39;-\u0026#39; and \u0026#39;_\u0026#39;. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes.\nPrefix \u0026#34;sys-\u0026#34; is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \u0026#34;sys-head\u0026#34; means the intent is a head intent. \u0026#34;sys.contextual\u0026#34; means the intent is a contextual intent.\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; }.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `language_code` (`string`): The language of the following fields in intent:\nIntent.training_phrases.parts.text\nIf not specified, the agent\u0026#39;s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. When `null`, the `language_code` field will be omitted from the resulting object.\n - `parent` (`string`): The agent to create an intent for.\nFormat: projects/\u0026lt;Project ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/agents/\u0026lt;Agent ID\u0026gt;. When `null`, the `parent` field will be omitted from the resulting object.\n - `priority` (`number`): The priority of this intent. Higher numbers represent higher priorities.\nIf the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console.\nIf 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 - `parameters` (`list[obj]`): The collection of parameters associated with the intent. When `null`, the `parameters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.parameters.new](#fn-parametersnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.timeouts.new](#fn-timeoutsnew) constructor.\n - `training_phrases` (`list[obj]`): The collection of training phrases the agent is trained on to identify the intent. When `null`, the `training_phrases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.training_phrases.new](#fn-training_phrasesnew) 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.dialogflow_cx_intent.new` injects a new `google_dialogflow_cx_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.dialogflow_cx_intent.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.dialogflow_cx_intent` using the reference:\n\n $._ref.google_dialogflow_cx_intent.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_dialogflow_cx_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 - `description` (`string`): Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable name of the intent, unique within the agent.\n - `is_default_negative_intent` (`bool`): Marks this as the [Default Negative Intent](https://cloud.google.com/dialogflow/cx/docs/concept/intent#negative) for an agent. When you create an agent, a Default Negative Intent is created automatically.\nThe Default Negative Intent cannot be deleted; deleting the \u0026#39;google_dialogflow_cx_intent\u0026#39; resource does nothing to the underlying GCP resources.\n\n~\u0026gt; Avoid having multiple \u0026#39;google_dialogflow_cx_intent\u0026#39; resources linked to the same agent with \u0026#39;is_default_negative_intent = true\u0026#39; because they will compete to control a single Default Negative Intent resource in GCP. When `null`, the `is_default_negative_intent` field will be omitted from the resulting object.\n - `is_default_welcome_intent` (`bool`): Marks this as the [Default Welcome Intent](https://cloud.google.com/dialogflow/cx/docs/concept/intent#welcome) for an agent. When you create an agent, a Default Welcome Intent is created automatically.\nThe Default Welcome Intent cannot be deleted; deleting the \u0026#39;google_dialogflow_cx_intent\u0026#39; resource does nothing to the underlying GCP resources.\n\n~\u0026gt; Avoid having multiple \u0026#39;google_dialogflow_cx_intent\u0026#39; resources linked to the same agent with \u0026#39;is_default_welcome_intent = true\u0026#39; because they will compete to control a single Default Welcome Intent resource in GCP. When `null`, the `is_default_welcome_intent` field will be omitted from the resulting object.\n - `is_fallback` (`bool`): Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation.\nAdding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.\nTo manage the fallback intent, set \u0026#39;is_default_negative_intent = true\u0026#39; When `null`, the `is_fallback` field will be omitted from the resulting object.\n - `labels` (`obj`): The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols \u0026#39;-\u0026#39; and \u0026#39;_\u0026#39;. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes.\nPrefix \u0026#34;sys-\u0026#34; is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \u0026#34;sys-head\u0026#34; means the intent is a head intent. \u0026#34;sys.contextual\u0026#34; means the intent is a contextual intent.\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; }.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `language_code` (`string`): The language of the following fields in intent:\nIntent.training_phrases.parts.text\nIf not specified, the agent\u0026#39;s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. When `null`, the `language_code` field will be omitted from the resulting object.\n - `parent` (`string`): The agent to create an intent for.\nFormat: projects/\u0026lt;Project ID\u0026gt;/locations/\u0026lt;Location ID\u0026gt;/agents/\u0026lt;Agent ID\u0026gt;. When `null`, the `parent` field will be omitted from the resulting object.\n - `priority` (`number`): The priority of this intent. Higher numbers represent higher priorities.\nIf the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console.\nIf 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 - `parameters` (`list[obj]`): The collection of parameters associated with the intent. When `null`, the `parameters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.parameters.new](#fn-parametersnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.timeouts.new](#fn-timeoutsnew) constructor.\n - `training_phrases` (`list[obj]`): The collection of training phrases the agent is trained on to identify the intent. When `null`, the `training_phrases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.training_phrases.new](#fn-training_phrasesnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name, description=null, + is_default_negative_intent=null, + is_default_welcome_intent=null, is_fallback=null, labels=null, language_code=null, @@ -22,6 +24,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs( description=description, display_name=display_name, + is_default_negative_intent=is_default_negative_intent, + is_default_welcome_intent=is_default_welcome_intent, is_fallback=is_fallback, labels=labels, language_code=language_code, @@ -33,10 +37,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.dialogflow_cx_intent.newAttrs` constructs a new object with attributes and blocks configured for the `dialogflow_cx_intent`\nTerraform resource.\n\nUnlike [google.dialogflow_cx_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 - `description` (`string`): Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable name of the intent, unique within the agent.\n - `is_fallback` (`bool`): Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation.\nAdding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. When `null`, the `is_fallback` field will be omitted from the resulting object.\n - `labels` (`obj`): The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes.\nPrefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.\nAn object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `language_code` (`string`): The language of the following fields in intent:\nIntent.training_phrases.parts.text\nIf not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. When `null`, the `language_code` field will be omitted from the resulting object.\n - `parent` (`string`): The agent to create an intent for.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. When `null`, the `parent` field will be omitted from the resulting object.\n - `priority` (`number`): The priority of this intent. Higher numbers represent higher priorities.\nIf the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console.\nIf 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 - `parameters` (`list[obj]`): The collection of parameters associated with the intent. When `null`, the `parameters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.parameters.new](#fn-parametersnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.timeouts.new](#fn-timeoutsnew) constructor.\n - `training_phrases` (`list[obj]`): The collection of training phrases the agent is trained on to identify the intent. When `null`, the `training_phrases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.training_phrases.new](#fn-training_phrasesnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `dialogflow_cx_intent` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.dialogflow_cx_intent.newAttrs` constructs a new object with attributes and blocks configured for the `dialogflow_cx_intent`\nTerraform resource.\n\nUnlike [google.dialogflow_cx_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 - `description` (`string`): Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The human-readable name of the intent, unique within the agent.\n - `is_default_negative_intent` (`bool`): Marks this as the [Default Negative Intent](https://cloud.google.com/dialogflow/cx/docs/concept/intent#negative) for an agent. When you create an agent, a Default Negative Intent is created automatically.\nThe Default Negative Intent cannot be deleted; deleting the 'google_dialogflow_cx_intent' resource does nothing to the underlying GCP resources.\n\n~> Avoid having multiple 'google_dialogflow_cx_intent' resources linked to the same agent with 'is_default_negative_intent = true' because they will compete to control a single Default Negative Intent resource in GCP. When `null`, the `is_default_negative_intent` field will be omitted from the resulting object.\n - `is_default_welcome_intent` (`bool`): Marks this as the [Default Welcome Intent](https://cloud.google.com/dialogflow/cx/docs/concept/intent#welcome) for an agent. When you create an agent, a Default Welcome Intent is created automatically.\nThe Default Welcome Intent cannot be deleted; deleting the 'google_dialogflow_cx_intent' resource does nothing to the underlying GCP resources.\n\n~> Avoid having multiple 'google_dialogflow_cx_intent' resources linked to the same agent with 'is_default_welcome_intent = true' because they will compete to control a single Default Welcome Intent resource in GCP. When `null`, the `is_default_welcome_intent` field will be omitted from the resulting object.\n - `is_fallback` (`bool`): Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation.\nAdding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.\nTo manage the fallback intent, set 'is_default_negative_intent = true' When `null`, the `is_fallback` field will be omitted from the resulting object.\n - `labels` (`obj`): The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes.\nPrefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.\nAn object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `language_code` (`string`): The language of the following fields in intent:\nIntent.training_phrases.parts.text\nIf not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. When `null`, the `language_code` field will be omitted from the resulting object.\n - `parent` (`string`): The agent to create an intent for.\nFormat: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. When `null`, the `parent` field will be omitted from the resulting object.\n - `priority` (`number`): The priority of this intent. Higher numbers represent higher priorities.\nIf the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console.\nIf 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 - `parameters` (`list[obj]`): The collection of parameters associated with the intent. When `null`, the `parameters` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.parameters.new](#fn-parametersnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.timeouts.new](#fn-timeoutsnew) constructor.\n - `training_phrases` (`list[obj]`): The collection of training phrases the agent is trained on to identify the intent. When `null`, the `training_phrases` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.dialogflow_cx_intent.training_phrases.new](#fn-training_phrasesnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `dialogflow_cx_intent` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, description=null, + is_default_negative_intent=null, + is_default_welcome_intent=null, is_fallback=null, labels=null, language_code=null, @@ -48,6 +54,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ):: std.prune(a={ description: description, display_name: display_name, + is_default_negative_intent: is_default_negative_intent, + is_default_welcome_intent: is_default_welcome_intent, is_fallback: is_fallback, labels: labels, language_code: language_code, @@ -121,6 +129,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withIsDefaultNegativeIntent':: d.fn(help='`google.bool.withIsDefaultNegativeIntent` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the is_default_negative_intent field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `is_default_negative_intent` field.\n', args=[]), + withIsDefaultNegativeIntent(resourceLabel, value): { + resource+: { + google_dialogflow_cx_intent+: { + [resourceLabel]+: { + is_default_negative_intent: value, + }, + }, + }, + }, + '#withIsDefaultWelcomeIntent':: d.fn(help='`google.bool.withIsDefaultWelcomeIntent` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the is_default_welcome_intent field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `is_default_welcome_intent` field.\n', args=[]), + withIsDefaultWelcomeIntent(resourceLabel, value): { + resource+: { + google_dialogflow_cx_intent+: { + [resourceLabel]+: { + is_default_welcome_intent: value, + }, + }, + }, + }, '#withIsFallback':: d.fn(help='`google.bool.withIsFallback` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the is_fallback field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `is_fallback` field.\n', args=[]), withIsFallback(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/gke_hub_feature.libsonnet b/4.x/_gen/resources/gke_hub_feature.libsonnet index 35d72e26..9b988618 100644 --- a/4.x/_gen/resources/gke_hub_feature.libsonnet +++ b/4.x/_gen/resources/gke_hub_feature.libsonnet @@ -2,10 +2,89 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='gke_hub_feature', url='', help='`gke_hub_feature` represents the `google_gke_hub_feature` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google.gke_hub_feature.new` injects a new `google_gke_hub_feature` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.gke_hub_feature.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_hub_feature` using the reference:\n\n $._ref.google_gke_hub_feature.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_hub_feature.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 - `labels` (`obj`): GCP labels for this Feature.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The full, unique name of this Feature resource 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 - `spec` (`list[obj]`): Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. When `null`, the `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.gke_hub_feature.spec.new](#fn-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.gke_hub_feature.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + fleet_default_member_config:: { + configmanagement:: { + config_sync:: { + git:: { + '#new':: d.fn(help='\n`google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.git.new` constructs a new object with attributes and blocks configured for the `git`\nTerraform sub block.\n\n\n\n**Args**:\n - `gcp_service_account_email` (`string`): The Google Cloud Service Account Email used for auth when secretType is gcpServiceAccount When `null`, the `gcp_service_account_email` field will be omitted from the resulting object.\n - `https_proxy` (`string`): URL for the HTTPS Proxy to be used when communicating with the Git repo When `null`, the `https_proxy` field will be omitted from the resulting object.\n - `policy_dir` (`string`): The path within the Git repository that represents the top level of the repo to sync When `null`, the `policy_dir` field will be omitted from the resulting object.\n - `secret_type` (`string`): Type of secret configured for access to the Git repo\n - `sync_branch` (`string`): The branch of the repository to sync from. Default: master When `null`, the `sync_branch` field will be omitted from the resulting object.\n - `sync_repo` (`string`): The URL of the Git repository to use as the source of truth When `null`, the `sync_repo` field will be omitted from the resulting object.\n - `sync_rev` (`string`): Git revision (tag or hash) to check out. Default HEAD When `null`, the `sync_rev` field will be omitted from the resulting object.\n - `sync_wait_secs` (`string`): Period in seconds between consecutive syncs. Default: 15 When `null`, the `sync_wait_secs` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `git` sub block.\n', args=[]), + new( + secret_type, + gcp_service_account_email=null, + https_proxy=null, + policy_dir=null, + sync_branch=null, + sync_repo=null, + sync_rev=null, + sync_wait_secs=null + ):: std.prune(a={ + gcp_service_account_email: gcp_service_account_email, + https_proxy: https_proxy, + policy_dir: policy_dir, + secret_type: secret_type, + sync_branch: sync_branch, + sync_repo: sync_repo, + sync_rev: sync_rev, + sync_wait_secs: sync_wait_secs, + }), + }, + '#new':: d.fn(help='\n`google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.new` constructs a new object with attributes and blocks configured for the `config_sync`\nTerraform sub block.\n\n\n\n**Args**:\n - `source_format` (`string`): Specifies whether the Config Sync Repo is in hierarchical or unstructured mode When `null`, the `source_format` field will be omitted from the resulting object.\n - `git` (`list[obj]`): Git repo configuration for the cluster When `null`, the `git` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.git.new](#fn-fleet_default_member_configfleet_default_member_configconfigmanagementgitnew) constructor.\n - `oci` (`list[obj]`): OCI repo configuration for the cluster When `null`, the `oci` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.oci.new](#fn-fleet_default_member_configfleet_default_member_configconfigmanagementocinew) constructor.\n\n**Returns**:\n - An attribute object that represents the `config_sync` sub block.\n', args=[]), + new( + git=null, + oci=null, + source_format=null + ):: std.prune(a={ + git: git, + oci: oci, + source_format: source_format, + }), + oci:: { + '#new':: d.fn(help='\n`google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.oci.new` constructs a new object with attributes and blocks configured for the `oci`\nTerraform sub block.\n\n\n\n**Args**:\n - `gcp_service_account_email` (`string`): The Google Cloud Service Account Email used for auth when secretType is gcpServiceAccount When `null`, the `gcp_service_account_email` field will be omitted from the resulting object.\n - `policy_dir` (`string`): The absolute path of the directory that contains the local resources. Default: the root directory of the image When `null`, the `policy_dir` field will be omitted from the resulting object.\n - `secret_type` (`string`): Type of secret configured for access to the Git repo\n - `sync_repo` (`string`): The OCI image repository URL for the package to sync from When `null`, the `sync_repo` field will be omitted from the resulting object.\n - `sync_wait_secs` (`string`): Period in seconds between consecutive syncs. Default: 15 When `null`, the `sync_wait_secs` field will be omitted from the resulting object.\n - `version` (`string`): Version of ACM installed When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `oci` sub block.\n', args=[]), + new( + secret_type, + gcp_service_account_email=null, + policy_dir=null, + sync_repo=null, + sync_wait_secs=null, + version=null + ):: std.prune(a={ + gcp_service_account_email: gcp_service_account_email, + policy_dir: policy_dir, + secret_type: secret_type, + sync_repo: sync_repo, + sync_wait_secs: sync_wait_secs, + version: version, + }), + }, + }, + '#new':: d.fn(help='\n`google.gke_hub_feature.fleet_default_member_config.configmanagement.new` constructs a new object with attributes and blocks configured for the `configmanagement`\nTerraform sub block.\n\n\n\n**Args**:\n - `config_sync` (`list[obj]`): ConfigSync configuration for the cluster When `null`, the `config_sync` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.new](#fn-fleet_default_member_configfleet_default_member_configconfig_syncnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `configmanagement` sub block.\n', args=[]), + new( + config_sync=null + ):: std.prune(a={ + config_sync: config_sync, + }), + }, + mesh:: { + '#new':: d.fn(help='\n`google.gke_hub_feature.fleet_default_member_config.mesh.new` constructs a new object with attributes and blocks configured for the `mesh`\nTerraform sub block.\n\n\n\n**Args**:\n - `management` (`string`): Whether to automatically manage Service Mesh Possible values: ["MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", "MANAGEMENT_MANUAL"]\n\n**Returns**:\n - An attribute object that represents the `mesh` sub block.\n', args=[]), + new( + management + ):: std.prune(a={ + management: management, + }), + }, + '#new':: d.fn(help='\n`google.gke_hub_feature.fleet_default_member_config.new` constructs a new object with attributes and blocks configured for the `fleet_default_member_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `configmanagement` (`list[obj]`): Config Management spec When `null`, the `configmanagement` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.configmanagement.new](#fn-fleet_default_member_configconfigmanagementnew) constructor.\n - `mesh` (`list[obj]`): Service Mesh spec When `null`, the `mesh` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.mesh.new](#fn-fleet_default_member_configmeshnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `fleet_default_member_config` sub block.\n', args=[]), + new( + configmanagement=null, + mesh=null + ):: std.prune(a={ + configmanagement: configmanagement, + mesh: mesh, + }), + }, + '#new':: d.fn(help="\n`google.gke_hub_feature.new` injects a new `google_gke_hub_feature` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.gke_hub_feature.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.gke_hub_feature` using the reference:\n\n $._ref.google_gke_hub_feature.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_gke_hub_feature.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 - `labels` (`obj`): GCP labels for this Feature.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The full, unique name of this Feature resource 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 - `fleet_default_member_config` (`list[obj]`): Optional. Fleet Default Membership Configuration. When `null`, the `fleet_default_member_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.new](#fn-fleet_default_member_confignew) constructor.\n - `spec` (`list[obj]`): Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. When `null`, the `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.gke_hub_feature.spec.new](#fn-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.gke_hub_feature.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, + fleet_default_member_config=null, labels=null, name=null, project=null, @@ -16,6 +95,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='google_gke_hub_feature', label=resourceLabel, attrs=self.newAttrs( + fleet_default_member_config=fleet_default_member_config, labels=labels, location=location, name=name, @@ -25,15 +105,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.gke_hub_feature.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_feature`\nTerraform resource.\n\nUnlike [google.gke_hub_feature.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 - `labels` (`obj`): GCP labels for this Feature.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The full, unique name of this Feature resource 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 - `spec` (`list[obj]`): Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. When `null`, the `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.gke_hub_feature.spec.new](#fn-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.gke_hub_feature.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `gke_hub_feature` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.gke_hub_feature.newAttrs` constructs a new object with attributes and blocks configured for the `gke_hub_feature`\nTerraform resource.\n\nUnlike [google.gke_hub_feature.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 - `labels` (`obj`): GCP labels for this Feature.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location for the resource\n - `name` (`string`): The full, unique name of this Feature resource 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 - `fleet_default_member_config` (`list[obj]`): Optional. Fleet Default Membership Configuration. When `null`, the `fleet_default_member_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.new](#fn-fleet_default_member_confignew) constructor.\n - `spec` (`list[obj]`): Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. When `null`, the `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.gke_hub_feature.spec.new](#fn-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.gke_hub_feature.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `gke_hub_feature` resource into the root Terraform configuration.\n', args=[]), newAttrs( location, + fleet_default_member_config=null, labels=null, name=null, project=null, spec=null, timeouts=null ):: std.prune(a={ + fleet_default_member_config: fleet_default_member_config, labels: labels, location: location, name: name, @@ -105,6 +187,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withFleetDefaultMemberConfig':: d.fn(help='`google.list[obj].withFleetDefaultMemberConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the fleet_default_member_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withFleetDefaultMemberConfigMixin](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 `fleet_default_member_config` field.\n', args=[]), + withFleetDefaultMemberConfig(resourceLabel, value): { + resource+: { + google_gke_hub_feature+: { + [resourceLabel]+: { + fleet_default_member_config: value, + }, + }, + }, + }, + '#withFleetDefaultMemberConfigMixin':: d.fn(help='`google.list[obj].withFleetDefaultMemberConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the fleet_default_member_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withFleetDefaultMemberConfig](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 `fleet_default_member_config` field.\n', args=[]), + withFleetDefaultMemberConfigMixin(resourceLabel, value): { + resource+: { + google_gke_hub_feature+: { + [resourceLabel]+: { + fleet_default_member_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withLabels':: d.fn(help='`google.obj.withLabels` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the labels field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `labels` field.\n', args=[]), withLabels(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/gke_hub_feature_membership.libsonnet b/4.x/_gen/resources/gke_hub_feature_membership.libsonnet index f147f40a..666eb358 100644 --- a/4.x/_gen/resources/gke_hub_feature_membership.libsonnet +++ b/4.x/_gen/resources/gke_hub_feature_membership.libsonnet @@ -34,14 +34,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); sync_wait_secs: sync_wait_secs, }), }, - '#new':: d.fn(help='\n`google.gke_hub_feature_membership.configmanagement.config_sync.new` constructs a new object with attributes and blocks configured for the `config_sync`\nTerraform sub block.\n\n\n\n**Args**:\n - `prevent_drift` (`bool`): Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. When `null`, the `prevent_drift` field will be omitted from the resulting object.\n - `source_format` (`string`): Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. When `null`, the `source_format` field will be omitted from the resulting object.\n - `git` (`list[obj]`): Set the `git` field on the resulting object. When `null`, the `git` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature_membership.configmanagement.config_sync.git.new](#fn-configmanagementconfigmanagementgitnew) constructor.\n - `oci` (`list[obj]`): Set the `oci` field on the resulting object. When `null`, the `oci` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature_membership.configmanagement.config_sync.oci.new](#fn-configmanagementconfigmanagementocinew) constructor.\n\n**Returns**:\n - An attribute object that represents the `config_sync` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.gke_hub_feature_membership.configmanagement.config_sync.new` constructs a new object with attributes and blocks configured for the `config_sync`\nTerraform sub block.\n\n\n\n**Args**:\n - `metrics_gcp_service_account_email` (`string`): The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring. The GSA should have the Monitoring Metric Writer(roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. When `null`, the `metrics_gcp_service_account_email` field will be omitted from the resulting object.\n - `prevent_drift` (`bool`): Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. When `null`, the `prevent_drift` field will be omitted from the resulting object.\n - `source_format` (`string`): Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. When `null`, the `source_format` field will be omitted from the resulting object.\n - `git` (`list[obj]`): Set the `git` field on the resulting object. When `null`, the `git` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature_membership.configmanagement.config_sync.git.new](#fn-configmanagementconfigmanagementgitnew) constructor.\n - `oci` (`list[obj]`): Set the `oci` field on the resulting object. When `null`, the `oci` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature_membership.configmanagement.config_sync.oci.new](#fn-configmanagementconfigmanagementocinew) constructor.\n\n**Returns**:\n - An attribute object that represents the `config_sync` sub block.\n', args=[]), new( git=null, + metrics_gcp_service_account_email=null, oci=null, prevent_drift=null, source_format=null ):: std.prune(a={ git: git, + metrics_gcp_service_account_email: metrics_gcp_service_account_email, oci: oci, prevent_drift: prevent_drift, source_format: source_format, diff --git a/4.x/_gen/resources/integration_connectors_connection.libsonnet b/4.x/_gen/resources/integration_connectors_connection.libsonnet new file mode 100644 index 00000000..ad010e59 --- /dev/null +++ b/4.x/_gen/resources/integration_connectors_connection.libsonnet @@ -0,0 +1,872 @@ +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='integration_connectors_connection', url='', help='`integration_connectors_connection` represents the `google_integration_connectors_connection` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + auth_config:: { + additional_variable:: { + encryption_key_value:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.additional_variable.encryption_key_value.new` constructs a new object with attributes and blocks configured for the `encryption_key_value`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_name` (`string`): The [KMS key name] with which the content of the Operation is encrypted. The expected\nformat: projects/*/locations/*/keyRings/*/cryptoKeys/*.\nWill be empty string if google managed. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `type` (`string`): Type of Encription Key Possible values: ["GOOGLE_MANAGED", "CUSTOMER_MANAGED"]\n\n**Returns**:\n - An attribute object that represents the `encryption_key_value` sub block.\n', args=[]), + new( + type, + kms_key_name=null + ):: std.prune(a={ + kms_key_name: kms_key_name, + type: type, + }), + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.additional_variable.new` constructs a new object with attributes and blocks configured for the `additional_variable`\nTerraform sub block.\n\n\n\n**Args**:\n - `boolean_value` (`bool`): Boolean Value of configVariable. When `null`, the `boolean_value` field will be omitted from the resulting object.\n - `integer_value` (`number`): Integer Value of configVariable. When `null`, the `integer_value` field will be omitted from the resulting object.\n - `key` (`string`): Key for the configVariable\n - `string_value` (`string`): String Value of configVariabley. When `null`, the `string_value` field will be omitted from the resulting object.\n - `encryption_key_value` (`list[obj]`): Encription key value of configVariable. When `null`, the `encryption_key_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.additional_variable.encryption_key_value.new](#fn-auth_configauth_configencryption_key_valuenew) constructor.\n - `secret_value` (`list[obj]`): Secret value of configVariable. When `null`, the `secret_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.additional_variable.secret_value.new](#fn-auth_configauth_configsecret_valuenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `additional_variable` sub block.\n', args=[]), + new( + key, + boolean_value=null, + encryption_key_value=null, + integer_value=null, + secret_value=null, + string_value=null + ):: std.prune(a={ + boolean_value: boolean_value, + encryption_key_value: encryption_key_value, + integer_value: integer_value, + key: key, + secret_value: secret_value, + string_value: string_value, + }), + secret_value:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.additional_variable.secret_value.new` constructs a new object with attributes and blocks configured for the `secret_value`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): Secret version of Secret Value for Config variable.\n\n**Returns**:\n - An attribute object that represents the `secret_value` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.new` constructs a new object with attributes and blocks configured for the `auth_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `auth_key` (`string`): The type of authentication configured. When `null`, the `auth_key` field will be omitted from the resulting object.\n - `auth_type` (`string`): authType of the Connection Possible values: ["USER_PASSWORD", "OAUTH2_JWT_BEARER", "OAUTH2_CLIENT_CREDENTIALS", "SSH_PUBLIC_KEY", "OAUTH2_AUTH_CODE_FLOW"]\n - `additional_variable` (`list[obj]`): List containing additional auth configs. When `null`, the `additional_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.additional_variable.new](#fn-auth_configadditional_variablenew) constructor.\n - `oauth2_auth_code_flow` (`list[obj]`): Parameters to support Oauth 2.0 Auth Code Grant Authentication. When `null`, the `oauth2_auth_code_flow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.oauth2_auth_code_flow.new](#fn-auth_configoauth2_auth_code_flownew) constructor.\n - `oauth2_client_credentials` (`list[obj]`): OAuth3 Client Credentials for Authentication. When `null`, the `oauth2_client_credentials` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.oauth2_client_credentials.new](#fn-auth_configoauth2_client_credentialsnew) constructor.\n - `oauth2_jwt_bearer` (`list[obj]`): OAuth2 JWT Bearer for Authentication. When `null`, the `oauth2_jwt_bearer` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.oauth2_jwt_bearer.new](#fn-auth_configoauth2_jwt_bearernew) constructor.\n - `ssh_public_key` (`list[obj]`): SSH Public Key for Authentication. When `null`, the `ssh_public_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.integration_connectors_connection.auth_config.ssh_public_key.new](#fn-auth_configssh_public_keynew) constructor.\n - `user_password` (`list[obj]`): User password for Authentication. When `null`, the `user_password` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.user_password.new](#fn-auth_configuser_passwordnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `auth_config` sub block.\n', args=[]), + new( + auth_type, + additional_variable=null, + auth_key=null, + oauth2_auth_code_flow=null, + oauth2_client_credentials=null, + oauth2_jwt_bearer=null, + ssh_public_key=null, + user_password=null + ):: std.prune(a={ + additional_variable: additional_variable, + auth_key: auth_key, + auth_type: auth_type, + oauth2_auth_code_flow: oauth2_auth_code_flow, + oauth2_client_credentials: oauth2_client_credentials, + oauth2_jwt_bearer: oauth2_jwt_bearer, + ssh_public_key: ssh_public_key, + user_password: user_password, + }), + oauth2_auth_code_flow:: { + client_secret:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.oauth2_auth_code_flow.client_secret.new` constructs a new object with attributes and blocks configured for the `client_secret`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): The resource name of the secret version in the format,\nformat as: projects/*/secrets/*/versions/*.\n\n**Returns**:\n - An attribute object that represents the `client_secret` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.oauth2_auth_code_flow.new` constructs a new object with attributes and blocks configured for the `oauth2_auth_code_flow`\nTerraform sub block.\n\n\n\n**Args**:\n - `auth_uri` (`string`): Auth URL for Authorization Code Flow. When `null`, the `auth_uri` field will be omitted from the resulting object.\n - `client_id` (`string`): Client ID for user-provided OAuth app. When `null`, the `client_id` field will be omitted from the resulting object.\n - `enable_pkce` (`bool`): Whether to enable PKCE when the user performs the auth code flow. When `null`, the `enable_pkce` field will be omitted from the resulting object.\n - `scopes` (`list`): Scopes the connection will request when the user performs the auth code flow. When `null`, the `scopes` field will be omitted from the resulting object.\n - `client_secret` (`list[obj]`): Client secret for user-provided OAuth app. When `null`, the `client_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.integration_connectors_connection.auth_config.oauth2_auth_code_flow.client_secret.new](#fn-auth_configauth_configclient_secretnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `oauth2_auth_code_flow` sub block.\n', args=[]), + new( + auth_uri=null, + client_id=null, + client_secret=null, + enable_pkce=null, + scopes=null + ):: std.prune(a={ + auth_uri: auth_uri, + client_id: client_id, + client_secret: client_secret, + enable_pkce: enable_pkce, + scopes: scopes, + }), + }, + oauth2_client_credentials:: { + client_secret:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.oauth2_client_credentials.client_secret.new` constructs a new object with attributes and blocks configured for the `client_secret`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): The resource name of the secret version in the format,\nformat as: projects/*/secrets/*/versions/*.\n\n**Returns**:\n - An attribute object that represents the `client_secret` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.oauth2_client_credentials.new` constructs a new object with attributes and blocks configured for the `oauth2_client_credentials`\nTerraform sub block.\n\n\n\n**Args**:\n - `client_id` (`string`): Secret version of Password for Authentication.\n - `client_secret` (`list[obj]`): Secret version reference containing the client secret. When `null`, the `client_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.integration_connectors_connection.auth_config.oauth2_client_credentials.client_secret.new](#fn-auth_configauth_configclient_secretnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `oauth2_client_credentials` sub block.\n', args=[]), + new( + client_id, + client_secret=null + ):: std.prune(a={ + client_id: client_id, + client_secret: client_secret, + }), + }, + oauth2_jwt_bearer:: { + client_key:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.oauth2_jwt_bearer.client_key.new` constructs a new object with attributes and blocks configured for the `client_key`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): The resource name of the secret version in the format,\nformat as: projects/*/secrets/*/versions/*.\n\n**Returns**:\n - An attribute object that represents the `client_key` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + jwt_claims:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.oauth2_jwt_bearer.jwt_claims.new` constructs a new object with attributes and blocks configured for the `jwt_claims`\nTerraform sub block.\n\n\n\n**Args**:\n - `audience` (`string`): Value for the "aud" claim. When `null`, the `audience` field will be omitted from the resulting object.\n - `issuer` (`string`): Value for the "iss" claim. When `null`, the `issuer` field will be omitted from the resulting object.\n - `subject` (`string`): Value for the "sub" claim. When `null`, the `subject` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `jwt_claims` sub block.\n', args=[]), + new( + audience=null, + issuer=null, + subject=null + ):: std.prune(a={ + audience: audience, + issuer: issuer, + subject: subject, + }), + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.oauth2_jwt_bearer.new` constructs a new object with attributes and blocks configured for the `oauth2_jwt_bearer`\nTerraform sub block.\n\n\n\n**Args**:\n - `client_key` (`list[obj]`): Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate.\nThis private key will be used to sign JWTs used for the jwt-bearer authorization grant.\nSpecified in the form as: projects/*/secrets/*/versions/*. When `null`, the `client_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.integration_connectors_connection.auth_config.oauth2_jwt_bearer.client_key.new](#fn-auth_configauth_configclient_keynew) constructor.\n - `jwt_claims` (`list[obj]`): JwtClaims providers fields to generate the token. When `null`, the `jwt_claims` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.oauth2_jwt_bearer.jwt_claims.new](#fn-auth_configauth_configjwt_claimsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `oauth2_jwt_bearer` sub block.\n', args=[]), + new( + client_key=null, + jwt_claims=null + ):: std.prune(a={ + client_key: client_key, + jwt_claims: jwt_claims, + }), + }, + ssh_public_key:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.ssh_public_key.new` constructs a new object with attributes and blocks configured for the `ssh_public_key`\nTerraform sub block.\n\n\n\n**Args**:\n - `cert_type` (`string`): Format of SSH Client cert. When `null`, the `cert_type` field will be omitted from the resulting object.\n - `username` (`string`): The user account used to authenticate.\n - `ssh_client_cert` (`list[obj]`): SSH Client Cert. It should contain both public and private key. When `null`, the `ssh_client_cert` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.ssh_public_key.ssh_client_cert.new](#fn-auth_configauth_configssh_client_certnew) constructor.\n - `ssh_client_cert_pass` (`list[obj]`): Password (passphrase) for ssh client certificate if it has one. When `null`, the `ssh_client_cert_pass` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.ssh_public_key.ssh_client_cert_pass.new](#fn-auth_configauth_configssh_client_cert_passnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ssh_public_key` sub block.\n', args=[]), + new( + username, + cert_type=null, + ssh_client_cert=null, + ssh_client_cert_pass=null + ):: std.prune(a={ + cert_type: cert_type, + ssh_client_cert: ssh_client_cert, + ssh_client_cert_pass: ssh_client_cert_pass, + username: username, + }), + ssh_client_cert:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.ssh_public_key.ssh_client_cert.new` constructs a new object with attributes and blocks configured for the `ssh_client_cert`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): The resource name of the secret version in the format,\nformat as: projects/*/secrets/*/versions/*.\n\n**Returns**:\n - An attribute object that represents the `ssh_client_cert` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + ssh_client_cert_pass:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.ssh_public_key.ssh_client_cert_pass.new` constructs a new object with attributes and blocks configured for the `ssh_client_cert_pass`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): The resource name of the secret version in the format,\nformat as: projects/*/secrets/*/versions/*.\n\n**Returns**:\n - An attribute object that represents the `ssh_client_cert_pass` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + }, + user_password:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.user_password.new` constructs a new object with attributes and blocks configured for the `user_password`\nTerraform sub block.\n\n\n\n**Args**:\n - `username` (`string`): Username for Authentication.\n - `password` (`list[obj]`): Password for Authentication. When `null`, the `password` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.user_password.password.new](#fn-auth_configauth_configpasswordnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `user_password` sub block.\n', args=[]), + new( + username, + password=null + ):: std.prune(a={ + password: password, + username: username, + }), + password:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.auth_config.user_password.password.new` constructs a new object with attributes and blocks configured for the `password`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): The resource name of the secret version in the format,\nformat as: projects/*/secrets/*/versions/*.\n\n**Returns**:\n - An attribute object that represents the `password` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + }, + }, + config_variable:: { + encryption_key_value:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.config_variable.encryption_key_value.new` constructs a new object with attributes and blocks configured for the `encryption_key_value`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_name` (`string`): The [KMS key name] with which the content of the Operation is encrypted. The expected\nformat: projects/*/locations/*/keyRings/*/cryptoKeys/*.\nWill be empty string if google managed. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `type` (`string`): Type of Encription Key Possible values: ["GOOGLE_MANAGED", "CUSTOMER_MANAGED"]\n\n**Returns**:\n - An attribute object that represents the `encryption_key_value` sub block.\n', args=[]), + new( + type, + kms_key_name=null + ):: std.prune(a={ + kms_key_name: kms_key_name, + type: type, + }), + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.config_variable.new` constructs a new object with attributes and blocks configured for the `config_variable`\nTerraform sub block.\n\n\n\n**Args**:\n - `boolean_value` (`bool`): Boolean Value of configVariable When `null`, the `boolean_value` field will be omitted from the resulting object.\n - `integer_value` (`number`): Integer Value of configVariable When `null`, the `integer_value` field will be omitted from the resulting object.\n - `key` (`string`): Key for the configVariable\n - `string_value` (`string`): String Value of configVariabley When `null`, the `string_value` field will be omitted from the resulting object.\n - `encryption_key_value` (`list[obj]`): Encription key value of configVariable. When `null`, the `encryption_key_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.config_variable.encryption_key_value.new](#fn-config_variableencryption_key_valuenew) constructor.\n - `secret_value` (`list[obj]`): Secret value of configVariable. When `null`, the `secret_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.config_variable.secret_value.new](#fn-config_variablesecret_valuenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `config_variable` sub block.\n', args=[]), + new( + key, + boolean_value=null, + encryption_key_value=null, + integer_value=null, + secret_value=null, + string_value=null + ):: std.prune(a={ + boolean_value: boolean_value, + encryption_key_value: encryption_key_value, + integer_value: integer_value, + key: key, + secret_value: secret_value, + string_value: string_value, + }), + secret_value:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.config_variable.secret_value.new` constructs a new object with attributes and blocks configured for the `secret_value`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): Secret version of Secret Value for Config variable.\n\n**Returns**:\n - An attribute object that represents the `secret_value` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + }, + destination_config:: { + destination:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.destination_config.destination.new` constructs a new object with attributes and blocks configured for the `destination`\nTerraform sub block.\n\n\n\n**Args**:\n - `host` (`string`): For publicly routable host. When `null`, the `host` field will be omitted from the resulting object.\n - `port` (`number`): The port is the target port number that is accepted by the destination. When `null`, the `port` field will be omitted from the resulting object.\n - `service_attachment` (`string`): PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* When `null`, the `service_attachment` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `destination` sub block.\n', args=[]), + new( + host=null, + port=null, + service_attachment=null + ):: std.prune(a={ + host: host, + port: port, + service_attachment: service_attachment, + }), + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.destination_config.new` constructs a new object with attributes and blocks configured for the `destination_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `key` (`string`): The key is the destination identifier that is supported by the Connector.\n - `destination` (`list[obj]`): The destinations for the key. When `null`, the `destination` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.destination_config.destination.new](#fn-destination_configdestinationnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `destination_config` sub block.\n', args=[]), + new( + key, + destination=null + ):: std.prune(a={ + destination: destination, + key: key, + }), + }, + eventing_config:: { + additional_variable:: { + encryption_key_value:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.additional_variable.encryption_key_value.new` constructs a new object with attributes and blocks configured for the `encryption_key_value`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_name` (`string`): The [KMS key name] with which the content of the Operation is encrypted. The expected\nformat: projects/*/locations/*/keyRings/*/cryptoKeys/*.\nWill be empty string if google managed. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `type` (`string`): Type of Encryption Key Possible values: ["GOOGLE_MANAGED", "CUSTOMER_MANAGED"] When `null`, the `type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `encryption_key_value` sub block.\n', args=[]), + new( + kms_key_name=null, + type=null + ):: std.prune(a={ + kms_key_name: kms_key_name, + type: type, + }), + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.additional_variable.new` constructs a new object with attributes and blocks configured for the `additional_variable`\nTerraform sub block.\n\n\n\n**Args**:\n - `boolean_value` (`bool`): Boolean Value of configVariable. When `null`, the `boolean_value` field will be omitted from the resulting object.\n - `integer_value` (`number`): Integer Value of configVariable. When `null`, the `integer_value` field will be omitted from the resulting object.\n - `key` (`string`): Key for the configVariable\n - `string_value` (`string`): String Value of configVariabley. When `null`, the `string_value` field will be omitted from the resulting object.\n - `encryption_key_value` (`list[obj]`): Encription key value of configVariable. When `null`, the `encryption_key_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.additional_variable.encryption_key_value.new](#fn-eventing_configeventing_configencryption_key_valuenew) constructor.\n - `secret_value` (`list[obj]`): Secret value of configVariable When `null`, the `secret_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.additional_variable.secret_value.new](#fn-eventing_configeventing_configsecret_valuenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `additional_variable` sub block.\n', args=[]), + new( + key, + boolean_value=null, + encryption_key_value=null, + integer_value=null, + secret_value=null, + string_value=null + ):: std.prune(a={ + boolean_value: boolean_value, + encryption_key_value: encryption_key_value, + integer_value: integer_value, + key: key, + secret_value: secret_value, + string_value: string_value, + }), + secret_value:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.additional_variable.secret_value.new` constructs a new object with attributes and blocks configured for the `secret_value`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): Secret version of Secret Value for Config variable.\n\n**Returns**:\n - An attribute object that represents the `secret_value` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + }, + auth_config:: { + additional_variable:: { + encryption_key_value:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.auth_config.additional_variable.encryption_key_value.new` constructs a new object with attributes and blocks configured for the `encryption_key_value`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_name` (`string`): The [KMS key name] with which the content of the Operation is encrypted. The expected\nformat: projects/*/locations/*/keyRings/*/cryptoKeys/*.\nWill be empty string if google managed. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `type` (`string`): Type of Encription Key Possible values: ["GOOGLE_MANAGED", "CUSTOMER_MANAGED"] When `null`, the `type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `encryption_key_value` sub block.\n', args=[]), + new( + kms_key_name=null, + type=null + ):: std.prune(a={ + kms_key_name: kms_key_name, + type: type, + }), + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.auth_config.additional_variable.new` constructs a new object with attributes and blocks configured for the `additional_variable`\nTerraform sub block.\n\n\n\n**Args**:\n - `boolean_value` (`bool`): Boolean Value of configVariable. When `null`, the `boolean_value` field will be omitted from the resulting object.\n - `integer_value` (`number`): Integer Value of configVariable. When `null`, the `integer_value` field will be omitted from the resulting object.\n - `key` (`string`): Key for the configVariable\n - `string_value` (`string`): String Value of configVariabley. When `null`, the `string_value` field will be omitted from the resulting object.\n - `encryption_key_value` (`list[obj]`): Encription key value of configVariable When `null`, the `encryption_key_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.additional_variable.encryption_key_value.new](#fn-eventing_configeventing_configauth_configencryption_key_valuenew) constructor.\n - `secret_value` (`list[obj]`): Secret value of configVariable When `null`, the `secret_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.additional_variable.secret_value.new](#fn-eventing_configeventing_configauth_configsecret_valuenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `additional_variable` sub block.\n', args=[]), + new( + key, + boolean_value=null, + encryption_key_value=null, + integer_value=null, + secret_value=null, + string_value=null + ):: std.prune(a={ + boolean_value: boolean_value, + encryption_key_value: encryption_key_value, + integer_value: integer_value, + key: key, + secret_value: secret_value, + string_value: string_value, + }), + secret_value:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.auth_config.additional_variable.secret_value.new` constructs a new object with attributes and blocks configured for the `secret_value`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): Secret version of Secret Value for Config variable.\n\n**Returns**:\n - An attribute object that represents the `secret_value` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.auth_config.new` constructs a new object with attributes and blocks configured for the `auth_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `auth_key` (`string`): The type of authentication configured. When `null`, the `auth_key` field will be omitted from the resulting object.\n - `auth_type` (`string`): authType of the Connection Possible values: ["USER_PASSWORD"]\n - `additional_variable` (`list[obj]`): List containing additional auth configs. When `null`, the `additional_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.additional_variable.new](#fn-eventing_configeventing_configadditional_variablenew) constructor.\n - `user_password` (`list[obj]`): User password for Authentication. When `null`, the `user_password` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.user_password.new](#fn-eventing_configeventing_configuser_passwordnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `auth_config` sub block.\n', args=[]), + new( + auth_type, + additional_variable=null, + auth_key=null, + user_password=null + ):: std.prune(a={ + additional_variable: additional_variable, + auth_key: auth_key, + auth_type: auth_type, + user_password: user_password, + }), + user_password:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.auth_config.user_password.new` constructs a new object with attributes and blocks configured for the `user_password`\nTerraform sub block.\n\n\n\n**Args**:\n - `username` (`string`): Username for Authentication. When `null`, the `username` field will be omitted from the resulting object.\n - `password` (`list[obj]`): Password for Authentication. When `null`, the `password` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.user_password.password.new](#fn-eventing_configeventing_configauth_configpasswordnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `user_password` sub block.\n', args=[]), + new( + password=null, + username=null + ):: std.prune(a={ + password: password, + username: username, + }), + password:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.auth_config.user_password.password.new` constructs a new object with attributes and blocks configured for the `password`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): The resource name of the secret version in the format,\nformat as: projects/*/secrets/*/versions/*.\n\n**Returns**:\n - An attribute object that represents the `password` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + }, + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.new` constructs a new object with attributes and blocks configured for the `eventing_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `enrichment_enabled` (`bool`): Enrichment Enabled. When `null`, the `enrichment_enabled` field will be omitted from the resulting object.\n - `additional_variable` (`list[obj]`): List containing additional auth configs. When `null`, the `additional_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.additional_variable.new](#fn-eventing_configadditional_variablenew) constructor.\n - `auth_config` (`list[obj]`): authConfig for Eventing Configuration. When `null`, the `auth_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.new](#fn-eventing_configauth_confignew) constructor.\n - `registration_destination_config` (`list[obj]`): registrationDestinationConfig When `null`, the `registration_destination_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.registration_destination_config.new](#fn-eventing_configregistration_destination_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `eventing_config` sub block.\n', args=[]), + new( + additional_variable=null, + auth_config=null, + enrichment_enabled=null, + registration_destination_config=null + ):: std.prune(a={ + additional_variable: additional_variable, + auth_config: auth_config, + enrichment_enabled: enrichment_enabled, + registration_destination_config: registration_destination_config, + }), + registration_destination_config:: { + destination:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.registration_destination_config.destination.new` constructs a new object with attributes and blocks configured for the `destination`\nTerraform sub block.\n\n\n\n**Args**:\n - `host` (`string`): Host When `null`, the `host` field will be omitted from the resulting object.\n - `port` (`number`): port number When `null`, the `port` field will be omitted from the resulting object.\n - `service_attachment` (`string`): Service Attachment When `null`, the `service_attachment` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `destination` sub block.\n', args=[]), + new( + host=null, + port=null, + service_attachment=null + ):: std.prune(a={ + host: host, + port: port, + service_attachment: service_attachment, + }), + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.eventing_config.registration_destination_config.new` constructs a new object with attributes and blocks configured for the `registration_destination_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `key` (`string`): Key for the connection When `null`, the `key` field will be omitted from the resulting object.\n - `destination` (`list[obj]`): destinations for the connection When `null`, the `destination` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.registration_destination_config.destination.new](#fn-eventing_configeventing_configdestinationnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `registration_destination_config` sub block.\n', args=[]), + new( + destination=null, + key=null + ):: std.prune(a={ + destination: destination, + key: key, + }), + }, + }, + lock_config:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.lock_config.new` constructs a new object with attributes and blocks configured for the `lock_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `locked` (`bool`): Indicates whether or not the connection is locked.\n - `reason` (`string`): Describes why a connection is locked. When `null`, the `reason` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `lock_config` sub block.\n', args=[]), + new( + locked, + reason=null + ):: std.prune(a={ + locked: locked, + reason: reason, + }), + }, + log_config:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.log_config.new` constructs a new object with attributes and blocks configured for the `log_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Enabled represents whether logging is enabled or not for a connection.\n\n**Returns**:\n - An attribute object that represents the `log_config` sub block.\n', args=[]), + new( + enabled + ):: std.prune(a={ + enabled: enabled, + }), + }, + '#new':: d.fn(help="\n`google.integration_connectors_connection.new` injects a new `google_integration_connectors_connection` 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.integration_connectors_connection.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.integration_connectors_connection` using the reference:\n\n $._ref.google_integration_connectors_connection.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_integration_connectors_connection.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 - `connector_version` (`string`): connectorVersion of the Connector.\n - `description` (`string`): An arbitrary description for the Conection. When `null`, the `description` field will be omitted from the resulting object.\n - `eventing_enablement_type` (`string`): Eventing enablement type. Will be nil if eventing is not enabled. Possible values: [\u0026#34;EVENTING_AND_CONNECTION\u0026#34;, \u0026#34;ONLY_EVENTING\u0026#34;] When `null`, the `eventing_enablement_type` field will be omitted from the resulting object.\n - `labels` (`obj`): Resource labels to represent user provided metadata.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): Location in which Connection needs to be created.\n - `name` (`string`): Name of Connection needs 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 - `service_account` (`string`): Service account needed for runtime plane to access Google Cloud resources. When `null`, the `service_account` field will be omitted from the resulting object.\n - `suspended` (`bool`): Suspended indicates if a user has suspended a connection or not. When `null`, the `suspended` field will be omitted from the resulting object.\n - `auth_config` (`list[obj]`): authConfig for the connection. When `null`, the `auth_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.new](#fn-auth_confignew) constructor.\n - `config_variable` (`list[obj]`): Config Variables for the connection. When `null`, the `config_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.config_variable.new](#fn-config_variablenew) constructor.\n - `destination_config` (`list[obj]`): Define the Connectors target endpoint. When `null`, the `destination_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.destination_config.new](#fn-destination_confignew) constructor.\n - `eventing_config` (`list[obj]`): Eventing Configuration of a connection When `null`, the `eventing_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.new](#fn-eventing_confignew) constructor.\n - `lock_config` (`list[obj]`): Determines whether or no a connection is locked. If locked, a reason must be specified. When `null`, the `lock_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.lock_config.new](#fn-lock_confignew) constructor.\n - `log_config` (`list[obj]`): Log configuration for the connection. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.log_config.new](#fn-log_confignew) constructor.\n - `node_config` (`list[obj]`): Node configuration for the connection. When `null`, the `node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.node_config.new](#fn-node_confignew) constructor.\n - `ssl_config` (`list[obj]`): SSL Configuration of a connection When `null`, the `ssl_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.new](#fn-ssl_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.integration_connectors_connection.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, + connector_version, + location, + name, + auth_config=null, + config_variable=null, + description=null, + destination_config=null, + eventing_config=null, + eventing_enablement_type=null, + labels=null, + lock_config=null, + log_config=null, + node_config=null, + project=null, + service_account=null, + ssl_config=null, + suspended=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_integration_connectors_connection', + label=resourceLabel, + attrs=self.newAttrs( + auth_config=auth_config, + config_variable=config_variable, + connector_version=connector_version, + description=description, + destination_config=destination_config, + eventing_config=eventing_config, + eventing_enablement_type=eventing_enablement_type, + labels=labels, + location=location, + lock_config=lock_config, + log_config=log_config, + name=name, + node_config=node_config, + project=project, + service_account=service_account, + ssl_config=ssl_config, + suspended=suspended, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.integration_connectors_connection.newAttrs` constructs a new object with attributes and blocks configured for the `integration_connectors_connection`\nTerraform resource.\n\nUnlike [google.integration_connectors_connection.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 - `connector_version` (`string`): connectorVersion of the Connector.\n - `description` (`string`): An arbitrary description for the Conection. When `null`, the `description` field will be omitted from the resulting object.\n - `eventing_enablement_type` (`string`): Eventing enablement type. Will be nil if eventing is not enabled. Possible values: ["EVENTING_AND_CONNECTION", "ONLY_EVENTING"] When `null`, the `eventing_enablement_type` field will be omitted from the resulting object.\n - `labels` (`obj`): Resource labels to represent user provided metadata.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): Location in which Connection needs to be created.\n - `name` (`string`): Name of Connection needs 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 - `service_account` (`string`): Service account needed for runtime plane to access Google Cloud resources. When `null`, the `service_account` field will be omitted from the resulting object.\n - `suspended` (`bool`): Suspended indicates if a user has suspended a connection or not. When `null`, the `suspended` field will be omitted from the resulting object.\n - `auth_config` (`list[obj]`): authConfig for the connection. When `null`, the `auth_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.new](#fn-auth_confignew) constructor.\n - `config_variable` (`list[obj]`): Config Variables for the connection. When `null`, the `config_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.config_variable.new](#fn-config_variablenew) constructor.\n - `destination_config` (`list[obj]`): Define the Connectors target endpoint. When `null`, the `destination_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.destination_config.new](#fn-destination_confignew) constructor.\n - `eventing_config` (`list[obj]`): Eventing Configuration of a connection When `null`, the `eventing_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.new](#fn-eventing_confignew) constructor.\n - `lock_config` (`list[obj]`): Determines whether or no a connection is locked. If locked, a reason must be specified. When `null`, the `lock_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.lock_config.new](#fn-lock_confignew) constructor.\n - `log_config` (`list[obj]`): Log configuration for the connection. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.log_config.new](#fn-log_confignew) constructor.\n - `node_config` (`list[obj]`): Node configuration for the connection. When `null`, the `node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.node_config.new](#fn-node_confignew) constructor.\n - `ssl_config` (`list[obj]`): SSL Configuration of a connection When `null`, the `ssl_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.new](#fn-ssl_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.integration_connectors_connection.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 `integration_connectors_connection` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + connector_version, + location, + name, + auth_config=null, + config_variable=null, + description=null, + destination_config=null, + eventing_config=null, + eventing_enablement_type=null, + labels=null, + lock_config=null, + log_config=null, + node_config=null, + project=null, + service_account=null, + ssl_config=null, + suspended=null, + timeouts=null + ):: std.prune(a={ + auth_config: auth_config, + config_variable: config_variable, + connector_version: connector_version, + description: description, + destination_config: destination_config, + eventing_config: eventing_config, + eventing_enablement_type: eventing_enablement_type, + labels: labels, + location: location, + lock_config: lock_config, + log_config: log_config, + name: name, + node_config: node_config, + project: project, + service_account: service_account, + ssl_config: ssl_config, + suspended: suspended, + timeouts: timeouts, + }), + node_config:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.node_config.new` constructs a new object with attributes and blocks configured for the `node_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_node_count` (`number`): Minimum number of nodes in the runtime nodes. When `null`, the `max_node_count` field will be omitted from the resulting object.\n - `min_node_count` (`number`): Minimum number of nodes in the runtime nodes. When `null`, the `min_node_count` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `node_config` sub block.\n', args=[]), + new( + max_node_count=null, + min_node_count=null + ):: std.prune(a={ + max_node_count: max_node_count, + min_node_count: min_node_count, + }), + }, + ssl_config:: { + additional_variable:: { + encryption_key_value:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.ssl_config.additional_variable.encryption_key_value.new` constructs a new object with attributes and blocks configured for the `encryption_key_value`\nTerraform sub block.\n\n\n\n**Args**:\n - `kms_key_name` (`string`): The [KMS key name] with which the content of the Operation is encrypted. The expected\nformat: projects/*/locations/*/keyRings/*/cryptoKeys/*.\nWill be empty string if google managed. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `type` (`string`): Type of Encription Key Possible values: ["GOOGLE_MANAGED", "CUSTOMER_MANAGED"] When `null`, the `type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `encryption_key_value` sub block.\n', args=[]), + new( + kms_key_name=null, + type=null + ):: std.prune(a={ + kms_key_name: kms_key_name, + type: type, + }), + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.ssl_config.additional_variable.new` constructs a new object with attributes and blocks configured for the `additional_variable`\nTerraform sub block.\n\n\n\n**Args**:\n - `boolean_value` (`bool`): Boolean Value of configVariable. When `null`, the `boolean_value` field will be omitted from the resulting object.\n - `integer_value` (`number`): Integer Value of configVariable. When `null`, the `integer_value` field will be omitted from the resulting object.\n - `key` (`string`): Key for the configVariable\n - `string_value` (`string`): String Value of configVariabley. When `null`, the `string_value` field will be omitted from the resulting object.\n - `encryption_key_value` (`list[obj]`): Encription key value of configVariable When `null`, the `encryption_key_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.additional_variable.encryption_key_value.new](#fn-ssl_configssl_configencryption_key_valuenew) constructor.\n - `secret_value` (`list[obj]`): Secret value of configVariable When `null`, the `secret_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.additional_variable.secret_value.new](#fn-ssl_configssl_configsecret_valuenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `additional_variable` sub block.\n', args=[]), + new( + key, + boolean_value=null, + encryption_key_value=null, + integer_value=null, + secret_value=null, + string_value=null + ):: std.prune(a={ + boolean_value: boolean_value, + encryption_key_value: encryption_key_value, + integer_value: integer_value, + key: key, + secret_value: secret_value, + string_value: string_value, + }), + secret_value:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.ssl_config.additional_variable.secret_value.new` constructs a new object with attributes and blocks configured for the `secret_value`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): Secret version of Secret Value for Config variable.\n\n**Returns**:\n - An attribute object that represents the `secret_value` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + }, + client_certificate:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.ssl_config.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 - `secret_version` (`string`): Secret version of Secret Value for Config variable.\n\n**Returns**:\n - An attribute object that represents the `client_certificate` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + client_private_key:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.ssl_config.client_private_key.new` constructs a new object with attributes and blocks configured for the `client_private_key`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): Secret version of Secret Value for Config variable.\n\n**Returns**:\n - An attribute object that represents the `client_private_key` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + client_private_key_pass:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.ssl_config.client_private_key_pass.new` constructs a new object with attributes and blocks configured for the `client_private_key_pass`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): Secret version of Secret Value for Config variable.\n\n**Returns**:\n - An attribute object that represents the `client_private_key_pass` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + '#new':: d.fn(help='\n`google.integration_connectors_connection.ssl_config.new` constructs a new object with attributes and blocks configured for the `ssl_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `client_cert_type` (`string`): Type of Client Cert (PEM/JKS/.. etc.) Possible values: ["PEM"] When `null`, the `client_cert_type` field will be omitted from the resulting object.\n - `server_cert_type` (`string`): Type of Server Cert (PEM/JKS/.. etc.) Possible values: ["PEM"] When `null`, the `server_cert_type` field will be omitted from the resulting object.\n - `trust_model` (`string`): Enum for Trust Model Possible values: ["PUBLIC", "PRIVATE", "INSECURE"] When `null`, the `trust_model` field will be omitted from the resulting object.\n - `type` (`string`): Enum for controlling the SSL Type (TLS/MTLS) Possible values: ["TLS", "MTLS"]\n - `use_ssl` (`bool`): Bool for enabling SSL When `null`, the `use_ssl` field will be omitted from the resulting object.\n - `additional_variable` (`list[obj]`): Additional SSL related field values. When `null`, the `additional_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.additional_variable.new](#fn-ssl_configadditional_variablenew) constructor.\n - `client_certificate` (`list[obj]`): Client Certificate 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.integration_connectors_connection.ssl_config.client_certificate.new](#fn-ssl_configclient_certificatenew) constructor.\n - `client_private_key` (`list[obj]`): Client Private Key When `null`, the `client_private_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.integration_connectors_connection.ssl_config.client_private_key.new](#fn-ssl_configclient_private_keynew) constructor.\n - `client_private_key_pass` (`list[obj]`): Secret containing the passphrase protecting the Client Private Key When `null`, the `client_private_key_pass` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.client_private_key_pass.new](#fn-ssl_configclient_private_key_passnew) constructor.\n - `private_server_certificate` (`list[obj]`): Private Server Certificate. Needs to be specified if trust model is PRIVATE. When `null`, the `private_server_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.integration_connectors_connection.ssl_config.private_server_certificate.new](#fn-ssl_configprivate_server_certificatenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ssl_config` sub block.\n', args=[]), + new( + type, + additional_variable=null, + client_cert_type=null, + client_certificate=null, + client_private_key=null, + client_private_key_pass=null, + private_server_certificate=null, + server_cert_type=null, + trust_model=null, + use_ssl=null + ):: std.prune(a={ + additional_variable: additional_variable, + client_cert_type: client_cert_type, + client_certificate: client_certificate, + client_private_key: client_private_key, + client_private_key_pass: client_private_key_pass, + private_server_certificate: private_server_certificate, + server_cert_type: server_cert_type, + trust_model: trust_model, + type: type, + use_ssl: use_ssl, + }), + private_server_certificate:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.ssl_config.private_server_certificate.new` constructs a new object with attributes and blocks configured for the `private_server_certificate`\nTerraform sub block.\n\n\n\n**Args**:\n - `secret_version` (`string`): Secret version of Secret Value for Config variable.\n\n**Returns**:\n - An attribute object that represents the `private_server_certificate` sub block.\n', args=[]), + new( + secret_version + ):: std.prune(a={ + secret_version: secret_version, + }), + }, + }, + timeouts:: { + '#new':: d.fn(help='\n`google.integration_connectors_connection.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, + }), + }, + '#withAuthConfig':: d.fn(help='`google.list[obj].withAuthConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the auth_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withAuthConfigMixin](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 `auth_config` field.\n', args=[]), + withAuthConfig(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + auth_config: value, + }, + }, + }, + }, + '#withAuthConfigMixin':: d.fn(help='`google.list[obj].withAuthConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the auth_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withAuthConfig](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 `auth_config` field.\n', args=[]), + withAuthConfigMixin(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + auth_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withConfigVariable':: d.fn(help='`google.list[obj].withConfigVariable` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the config_variable field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withConfigVariableMixin](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_variable` field.\n', args=[]), + withConfigVariable(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + config_variable: value, + }, + }, + }, + }, + '#withConfigVariableMixin':: d.fn(help='`google.list[obj].withConfigVariableMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the config_variable field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withConfigVariable](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_variable` field.\n', args=[]), + withConfigVariableMixin(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + config_variable+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withConnectorVersion':: d.fn(help='`google.string.withConnectorVersion` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the connector_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 `connector_version` field.\n', args=[]), + withConnectorVersion(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + connector_version: value, + }, + }, + }, + }, + '#withDescription':: d.fn(help='`google.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withDestinationConfig':: d.fn(help='`google.list[obj].withDestinationConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the destination_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withDestinationConfigMixin](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 `destination_config` field.\n', args=[]), + withDestinationConfig(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + destination_config: value, + }, + }, + }, + }, + '#withDestinationConfigMixin':: d.fn(help='`google.list[obj].withDestinationConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the destination_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withDestinationConfig](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 `destination_config` field.\n', args=[]), + withDestinationConfigMixin(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + destination_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withEventingConfig':: d.fn(help='`google.list[obj].withEventingConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the eventing_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withEventingConfigMixin](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 `eventing_config` field.\n', args=[]), + withEventingConfig(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + eventing_config: value, + }, + }, + }, + }, + '#withEventingConfigMixin':: d.fn(help='`google.list[obj].withEventingConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the eventing_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withEventingConfig](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 `eventing_config` field.\n', args=[]), + withEventingConfigMixin(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + eventing_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withEventingEnablementType':: d.fn(help='`google.string.withEventingEnablementType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the eventing_enablement_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 `eventing_enablement_type` field.\n', args=[]), + withEventingEnablementType(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + eventing_enablement_type: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google.obj.withLabels` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the labels field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `labels` field.\n', args=[]), + withLabels(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withLockConfig':: d.fn(help='`google.list[obj].withLockConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the lock_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withLockConfigMixin](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 `lock_config` field.\n', args=[]), + withLockConfig(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + lock_config: value, + }, + }, + }, + }, + '#withLockConfigMixin':: d.fn(help='`google.list[obj].withLockConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the lock_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withLockConfig](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 `lock_config` field.\n', args=[]), + withLockConfigMixin(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + lock_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withLogConfig':: d.fn(help='`google.list[obj].withLogConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the log_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withLogConfigMixin](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 `log_config` field.\n', args=[]), + withLogConfig(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + log_config: value, + }, + }, + }, + }, + '#withLogConfigMixin':: d.fn(help='`google.list[obj].withLogConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the log_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withLogConfig](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 `log_config` field.\n', args=[]), + withLogConfigMixin(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + log_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withNodeConfig':: d.fn(help='`google.list[obj].withNodeConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the node_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withNodeConfigMixin](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_config` field.\n', args=[]), + withNodeConfig(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + node_config: value, + }, + }, + }, + }, + '#withNodeConfigMixin':: d.fn(help='`google.list[obj].withNodeConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the node_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withNodeConfig](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_config` field.\n', args=[]), + withNodeConfigMixin(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + node_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withServiceAccount':: d.fn(help='`google.string.withServiceAccount` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the service_account 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_account` field.\n', args=[]), + withServiceAccount(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + service_account: value, + }, + }, + }, + }, + '#withSslConfig':: d.fn(help='`google.list[obj].withSslConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the ssl_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withSslConfigMixin](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 `ssl_config` field.\n', args=[]), + withSslConfig(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + ssl_config: value, + }, + }, + }, + }, + '#withSslConfigMixin':: d.fn(help='`google.list[obj].withSslConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the ssl_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withSslConfig](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 `ssl_config` field.\n', args=[]), + withSslConfigMixin(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + ssl_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withSuspended':: d.fn(help='`google.bool.withSuspended` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the suspended 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 `suspended` field.\n', args=[]), + withSuspended(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + suspended: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_integration_connectors_connection+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/logging_billing_account_bucket_config.libsonnet b/4.x/_gen/resources/logging_billing_account_bucket_config.libsonnet index 376c36cd..44cae7cc 100644 --- a/4.x/_gen/resources/logging_billing_account_bucket_config.libsonnet +++ b/4.x/_gen/resources/logging_billing_account_bucket_config.libsonnet @@ -10,7 +10,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); kms_key_name: kms_key_name, }), }, - '#new':: d.fn(help="\n`google.logging_billing_account_bucket_config.new` injects a new `google_logging_billing_account_bucket_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.logging_billing_account_bucket_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.logging_billing_account_bucket_config` using the reference:\n\n $._ref.google_logging_billing_account_bucket_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_logging_billing_account_bucket_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 - `billing_account` (`string`): The parent resource that contains the logging bucket.\n - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_billing_account_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + index_configs:: { + '#new':: d.fn(help='\n`google.logging_billing_account_bucket_config.index_configs.new` constructs a new object with attributes and blocks configured for the `index_configs`\nTerraform sub block.\n\n\n\n**Args**:\n - `field_path` (`string`): The LogEntry field path to index.\n - `type` (`string`): The type of data in this index\nNote that some paths are automatically indexed, and other paths are not eligible for indexing. See [indexing documentation]( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.\nFor example: jsonPayload.request.status\n\n**Returns**:\n - An attribute object that represents the `index_configs` sub block.\n', args=[]), + new( + field_path, + type + ):: std.prune(a={ + field_path: field_path, + type: type, + }), + }, + '#new':: d.fn(help="\n`google.logging_billing_account_bucket_config.new` injects a new `google_logging_billing_account_bucket_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.logging_billing_account_bucket_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.logging_billing_account_bucket_config` using the reference:\n\n $._ref.google_logging_billing_account_bucket_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_logging_billing_account_bucket_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 - `billing_account` (`string`): The parent resource that contains the logging bucket.\n - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_billing_account_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_billing_account_bucket_config.index_configs.new](#fn-index_configsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, billing_account, @@ -18,6 +28,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); location, cmek_settings=null, description=null, + index_configs=null, retention_days=null, _meta={} ):: tf.withResource( @@ -28,24 +39,27 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); bucket_id=bucket_id, cmek_settings=cmek_settings, description=description, + index_configs=index_configs, location=location, retention_days=retention_days ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.logging_billing_account_bucket_config.newAttrs` constructs a new object with attributes and blocks configured for the `logging_billing_account_bucket_config`\nTerraform resource.\n\nUnlike [google.logging_billing_account_bucket_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 - `billing_account` (`string`): The parent resource that contains the logging bucket.\n - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_billing_account_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) 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 `logging_billing_account_bucket_config` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.logging_billing_account_bucket_config.newAttrs` constructs a new object with attributes and blocks configured for the `logging_billing_account_bucket_config`\nTerraform resource.\n\nUnlike [google.logging_billing_account_bucket_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 - `billing_account` (`string`): The parent resource that contains the logging bucket.\n - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_billing_account_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_billing_account_bucket_config.index_configs.new](#fn-index_configsnew) 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 `logging_billing_account_bucket_config` resource into the root Terraform configuration.\n', args=[]), newAttrs( billing_account, bucket_id, location, cmek_settings=null, description=null, + index_configs=null, retention_days=null ):: std.prune(a={ billing_account: billing_account, bucket_id: bucket_id, cmek_settings: cmek_settings, description: description, + index_configs: index_configs, location: location, retention_days: retention_days, }), @@ -99,6 +113,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withIndexConfigs':: d.fn(help='`google.list[obj].withIndexConfigs` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the index_configs field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withIndexConfigsMixin](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 `index_configs` field.\n', args=[]), + withIndexConfigs(resourceLabel, value): { + resource+: { + google_logging_billing_account_bucket_config+: { + [resourceLabel]+: { + index_configs: value, + }, + }, + }, + }, + '#withIndexConfigsMixin':: d.fn(help='`google.list[obj].withIndexConfigsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the index_configs field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withIndexConfigs](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 `index_configs` field.\n', args=[]), + withIndexConfigsMixin(resourceLabel, value): { + resource+: { + google_logging_billing_account_bucket_config+: { + [resourceLabel]+: { + index_configs+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `location` field.\n', args=[]), withLocation(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/logging_folder_bucket_config.libsonnet b/4.x/_gen/resources/logging_folder_bucket_config.libsonnet index 0764221f..6ceef933 100644 --- a/4.x/_gen/resources/logging_folder_bucket_config.libsonnet +++ b/4.x/_gen/resources/logging_folder_bucket_config.libsonnet @@ -10,7 +10,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); kms_key_name: kms_key_name, }), }, - '#new':: d.fn(help="\n`google.logging_folder_bucket_config.new` injects a new `google_logging_folder_bucket_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.logging_folder_bucket_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.logging_folder_bucket_config` using the reference:\n\n $._ref.google_logging_folder_bucket_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_logging_folder_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `folder` (`string`): The parent resource that contains the logging bucket.\n - `location` (`string`): The location of the bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_folder_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + index_configs:: { + '#new':: d.fn(help='\n`google.logging_folder_bucket_config.index_configs.new` constructs a new object with attributes and blocks configured for the `index_configs`\nTerraform sub block.\n\n\n\n**Args**:\n - `field_path` (`string`): The LogEntry field path to index.\n - `type` (`string`): The type of data in this index\nNote that some paths are automatically indexed, and other paths are not eligible for indexing. See [indexing documentation]( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.\nFor example: jsonPayload.request.status\n\n**Returns**:\n - An attribute object that represents the `index_configs` sub block.\n', args=[]), + new( + field_path, + type + ):: std.prune(a={ + field_path: field_path, + type: type, + }), + }, + '#new':: d.fn(help="\n`google.logging_folder_bucket_config.new` injects a new `google_logging_folder_bucket_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.logging_folder_bucket_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.logging_folder_bucket_config` using the reference:\n\n $._ref.google_logging_folder_bucket_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_logging_folder_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `folder` (`string`): The parent resource that contains the logging bucket.\n - `location` (`string`): The location of the bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_folder_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_folder_bucket_config.index_configs.new](#fn-index_configsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, bucket_id, @@ -18,6 +28,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); location, cmek_settings=null, description=null, + index_configs=null, retention_days=null, _meta={} ):: tf.withResource( @@ -28,24 +39,27 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); cmek_settings=cmek_settings, description=description, folder=folder, + index_configs=index_configs, location=location, retention_days=retention_days ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.logging_folder_bucket_config.newAttrs` constructs a new object with attributes and blocks configured for the `logging_folder_bucket_config`\nTerraform resource.\n\nUnlike [google.logging_folder_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `folder` (`string`): The parent resource that contains the logging bucket.\n - `location` (`string`): The location of the bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_folder_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) 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 `logging_folder_bucket_config` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.logging_folder_bucket_config.newAttrs` constructs a new object with attributes and blocks configured for the `logging_folder_bucket_config`\nTerraform resource.\n\nUnlike [google.logging_folder_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `folder` (`string`): The parent resource that contains the logging bucket.\n - `location` (`string`): The location of the bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_folder_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_folder_bucket_config.index_configs.new](#fn-index_configsnew) 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 `logging_folder_bucket_config` resource into the root Terraform configuration.\n', args=[]), newAttrs( bucket_id, folder, location, cmek_settings=null, description=null, + index_configs=null, retention_days=null ):: std.prune(a={ bucket_id: bucket_id, cmek_settings: cmek_settings, description: description, folder: folder, + index_configs: index_configs, location: location, retention_days: retention_days, }), @@ -99,6 +113,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withIndexConfigs':: d.fn(help='`google.list[obj].withIndexConfigs` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the index_configs field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withIndexConfigsMixin](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 `index_configs` field.\n', args=[]), + withIndexConfigs(resourceLabel, value): { + resource+: { + google_logging_folder_bucket_config+: { + [resourceLabel]+: { + index_configs: value, + }, + }, + }, + }, + '#withIndexConfigsMixin':: d.fn(help='`google.list[obj].withIndexConfigsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the index_configs field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withIndexConfigs](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 `index_configs` field.\n', args=[]), + withIndexConfigsMixin(resourceLabel, value): { + resource+: { + google_logging_folder_bucket_config+: { + [resourceLabel]+: { + index_configs+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `location` field.\n', args=[]), withLocation(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/logging_organization_bucket_config.libsonnet b/4.x/_gen/resources/logging_organization_bucket_config.libsonnet index 7485db52..a9f3062f 100644 --- a/4.x/_gen/resources/logging_organization_bucket_config.libsonnet +++ b/4.x/_gen/resources/logging_organization_bucket_config.libsonnet @@ -10,7 +10,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); kms_key_name: kms_key_name, }), }, - '#new':: d.fn(help="\n`google.logging_organization_bucket_config.new` injects a new `google_logging_organization_bucket_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.logging_organization_bucket_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.logging_organization_bucket_config` using the reference:\n\n $._ref.google_logging_organization_bucket_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_logging_organization_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `organization` (`string`): The parent resource that contains the logging bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_organization_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + index_configs:: { + '#new':: d.fn(help='\n`google.logging_organization_bucket_config.index_configs.new` constructs a new object with attributes and blocks configured for the `index_configs`\nTerraform sub block.\n\n\n\n**Args**:\n - `field_path` (`string`): The LogEntry field path to index.\n - `type` (`string`): The type of data in this index\nNote that some paths are automatically indexed, and other paths are not eligible for indexing. See [indexing documentation]( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.\nFor example: jsonPayload.request.status\n\n**Returns**:\n - An attribute object that represents the `index_configs` sub block.\n', args=[]), + new( + field_path, + type + ):: std.prune(a={ + field_path: field_path, + type: type, + }), + }, + '#new':: d.fn(help="\n`google.logging_organization_bucket_config.new` injects a new `google_logging_organization_bucket_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.logging_organization_bucket_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.logging_organization_bucket_config` using the reference:\n\n $._ref.google_logging_organization_bucket_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_logging_organization_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `organization` (`string`): The parent resource that contains the logging bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_organization_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_organization_bucket_config.index_configs.new](#fn-index_configsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, bucket_id, @@ -18,6 +28,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); organization, cmek_settings=null, description=null, + index_configs=null, retention_days=null, _meta={} ):: tf.withResource( @@ -27,24 +38,27 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); bucket_id=bucket_id, cmek_settings=cmek_settings, description=description, + index_configs=index_configs, location=location, organization=organization, retention_days=retention_days ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.logging_organization_bucket_config.newAttrs` constructs a new object with attributes and blocks configured for the `logging_organization_bucket_config`\nTerraform resource.\n\nUnlike [google.logging_organization_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `organization` (`string`): The parent resource that contains the logging bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_organization_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) 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 `logging_organization_bucket_config` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.logging_organization_bucket_config.newAttrs` constructs a new object with attributes and blocks configured for the `logging_organization_bucket_config`\nTerraform resource.\n\nUnlike [google.logging_organization_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `organization` (`string`): The parent resource that contains the logging bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_organization_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_organization_bucket_config.index_configs.new](#fn-index_configsnew) 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 `logging_organization_bucket_config` resource into the root Terraform configuration.\n', args=[]), newAttrs( bucket_id, location, organization, cmek_settings=null, description=null, + index_configs=null, retention_days=null ):: std.prune(a={ bucket_id: bucket_id, cmek_settings: cmek_settings, description: description, + index_configs: index_configs, location: location, organization: organization, retention_days: retention_days, @@ -89,6 +103,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withIndexConfigs':: d.fn(help='`google.list[obj].withIndexConfigs` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the index_configs field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withIndexConfigsMixin](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 `index_configs` field.\n', args=[]), + withIndexConfigs(resourceLabel, value): { + resource+: { + google_logging_organization_bucket_config+: { + [resourceLabel]+: { + index_configs: value, + }, + }, + }, + }, + '#withIndexConfigsMixin':: d.fn(help='`google.list[obj].withIndexConfigsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the index_configs field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withIndexConfigs](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 `index_configs` field.\n', args=[]), + withIndexConfigsMixin(resourceLabel, value): { + resource+: { + google_logging_organization_bucket_config+: { + [resourceLabel]+: { + index_configs+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `location` field.\n', args=[]), withLocation(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/logging_project_bucket_config.libsonnet b/4.x/_gen/resources/logging_project_bucket_config.libsonnet index 8b0ae6e0..26eb9dd8 100644 --- a/4.x/_gen/resources/logging_project_bucket_config.libsonnet +++ b/4.x/_gen/resources/logging_project_bucket_config.libsonnet @@ -10,7 +10,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); kms_key_name: kms_key_name, }), }, - '#new':: d.fn(help="\n`google.logging_project_bucket_config.new` injects a new `google_logging_project_bucket_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.logging_project_bucket_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.logging_project_bucket_config` using the reference:\n\n $._ref.google_logging_project_bucket_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_logging_project_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_analytics` (`bool`): Enable log analytics for the bucket. Cannot be disabled once enabled. When `null`, the `enable_analytics` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `locked` (`bool`): Whether the bucket is locked. The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty. When `null`, the `locked` field will be omitted from the resulting object.\n - `project` (`string`): The parent project that contains the logging bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_project_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + index_configs:: { + '#new':: d.fn(help='\n`google.logging_project_bucket_config.index_configs.new` constructs a new object with attributes and blocks configured for the `index_configs`\nTerraform sub block.\n\n\n\n**Args**:\n - `field_path` (`string`): The LogEntry field path to index.\n - `type` (`string`): The type of data in this index\nNote that some paths are automatically indexed, and other paths are not eligible for indexing. See [indexing documentation]( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.\nFor example: jsonPayload.request.status\n\n**Returns**:\n - An attribute object that represents the `index_configs` sub block.\n', args=[]), + new( + field_path, + type + ):: std.prune(a={ + field_path: field_path, + type: type, + }), + }, + '#new':: d.fn(help="\n`google.logging_project_bucket_config.new` injects a new `google_logging_project_bucket_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.logging_project_bucket_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.logging_project_bucket_config` using the reference:\n\n $._ref.google_logging_project_bucket_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_logging_project_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_analytics` (`bool`): Enable log analytics for the bucket. Cannot be disabled once enabled. When `null`, the `enable_analytics` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `locked` (`bool`): Whether the bucket is locked. The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty. When `null`, the `locked` field will be omitted from the resulting object.\n - `project` (`string`): The parent project that contains the logging bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_project_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_project_bucket_config.index_configs.new](#fn-index_configsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, bucket_id, @@ -19,6 +29,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); cmek_settings=null, description=null, enable_analytics=null, + index_configs=null, locked=null, retention_days=null, _meta={} @@ -30,6 +41,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); cmek_settings=cmek_settings, description=description, enable_analytics=enable_analytics, + index_configs=index_configs, location=location, locked=locked, project=project, @@ -37,7 +49,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.logging_project_bucket_config.newAttrs` constructs a new object with attributes and blocks configured for the `logging_project_bucket_config`\nTerraform resource.\n\nUnlike [google.logging_project_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_analytics` (`bool`): Enable log analytics for the bucket. Cannot be disabled once enabled. When `null`, the `enable_analytics` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `locked` (`bool`): Whether the bucket is locked. The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty. When `null`, the `locked` field will be omitted from the resulting object.\n - `project` (`string`): The parent project that contains the logging bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_project_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) 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 `logging_project_bucket_config` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.logging_project_bucket_config.newAttrs` constructs a new object with attributes and blocks configured for the `logging_project_bucket_config`\nTerraform resource.\n\nUnlike [google.logging_project_bucket_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 - `bucket_id` (`string`): The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.\n - `description` (`string`): An optional description for this bucket. When `null`, the `description` field will be omitted from the resulting object.\n - `enable_analytics` (`bool`): Enable log analytics for the bucket. Cannot be disabled once enabled. When `null`, the `enable_analytics` field will be omitted from the resulting object.\n - `location` (`string`): The location of the bucket.\n - `locked` (`bool`): Whether the bucket is locked. The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty. When `null`, the `locked` field will be omitted from the resulting object.\n - `project` (`string`): The parent project that contains the logging bucket.\n - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object.\n - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_project_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor.\n - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_project_bucket_config.index_configs.new](#fn-index_configsnew) 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 `logging_project_bucket_config` resource into the root Terraform configuration.\n', args=[]), newAttrs( bucket_id, location, @@ -45,6 +57,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); cmek_settings=null, description=null, enable_analytics=null, + index_configs=null, locked=null, retention_days=null ):: std.prune(a={ @@ -52,6 +65,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); cmek_settings: cmek_settings, description: description, enable_analytics: enable_analytics, + index_configs: index_configs, location: location, locked: locked, project: project, @@ -107,6 +121,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withIndexConfigs':: d.fn(help='`google.list[obj].withIndexConfigs` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the index_configs field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withIndexConfigsMixin](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 `index_configs` field.\n', args=[]), + withIndexConfigs(resourceLabel, value): { + resource+: { + google_logging_project_bucket_config+: { + [resourceLabel]+: { + index_configs: value, + }, + }, + }, + }, + '#withIndexConfigsMixin':: d.fn(help='`google.list[obj].withIndexConfigsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the index_configs field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withIndexConfigs](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 `index_configs` field.\n', args=[]), + withIndexConfigsMixin(resourceLabel, value): { + resource+: { + google_logging_project_bucket_config+: { + [resourceLabel]+: { + index_configs+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `location` field.\n', args=[]), withLocation(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/monitoring_uptime_check_config.libsonnet b/4.x/_gen/resources/monitoring_uptime_check_config.libsonnet index 20a527d7..e05defd7 100644 --- a/4.x/_gen/resources/monitoring_uptime_check_config.libsonnet +++ b/4.x/_gen/resources/monitoring_uptime_check_config.libsonnet @@ -45,15 +45,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); username: username, }), }, - '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.http_check.new` constructs a new object with attributes and blocks configured for the `http_check`\nTerraform sub block.\n\n\n\n**Args**:\n - `body` (`string`): The request body associated with the HTTP POST request. If contentType is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the requestMethod is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g. "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=". When `null`, the `body` field will be omitted from the resulting object.\n - `content_type` (`string`): The content type to use for the check. Possible values: ["TYPE_UNSPECIFIED", "URL_ENCODED"] When `null`, the `content_type` field will be omitted from the resulting object.\n - `headers` (`obj`): The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. When `null`, the `headers` field will be omitted from the resulting object.\n - `mask_headers` (`bool`): Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******. When `null`, the `mask_headers` field will be omitted from the resulting object.\n - `path` (`string`): The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically. Optional (defaults to "/"). When `null`, the `path` field will be omitted from the resulting object.\n - `port` (`number`): The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL). When `null`, the `port` field will be omitted from the resulting object.\n - `request_method` (`string`): The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then requestMethod defaults to GET. Default value: "GET" Possible values: ["METHOD_UNSPECIFIED", "GET", "POST"] When `null`, the `request_method` field will be omitted from the resulting object.\n - `use_ssl` (`bool`): If true, use HTTPS instead of HTTP to run the check. When `null`, the `use_ssl` field will be omitted from the resulting object.\n - `validate_ssl` (`bool`): Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitoredResource is set to uptime_url. If useSsl is false, setting validateSsl to true has no effect. When `null`, the `validate_ssl` field will be omitted from the resulting object.\n - `accepted_response_status_codes` (`list[obj]`): If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. When `null`, the `accepted_response_status_codes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.accepted_response_status_codes.new](#fn-http_checkaccepted_response_status_codesnew) constructor.\n - `auth_info` (`list[obj]`): The authentication information. Optional when creating an HTTP check; defaults to empty. When `null`, the `auth_info` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.auth_info.new](#fn-http_checkauth_infonew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_check` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.http_check.new` constructs a new object with attributes and blocks configured for the `http_check`\nTerraform sub block.\n\n\n\n**Args**:\n - `body` (`string`): The request body associated with the HTTP POST request. If contentType is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the requestMethod is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g. "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=". When `null`, the `body` field will be omitted from the resulting object.\n - `content_type` (`string`): The content type to use for the check. Possible values: ["TYPE_UNSPECIFIED", "URL_ENCODED", "USER_PROVIDED"] When `null`, the `content_type` field will be omitted from the resulting object.\n - `custom_content_type` (`string`): A user provided content type header to use for the check. The invalid configurations outlined in the 'content_type' field apply to custom_content_type', as well as the following 1. 'content_type' is 'URL_ENCODED' and 'custom_content_type' is set. 2. 'content_type' is 'USER_PROVIDED' and 'custom_content_type' is not set. When `null`, the `custom_content_type` field will be omitted from the resulting object.\n - `headers` (`obj`): The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. When `null`, the `headers` field will be omitted from the resulting object.\n - `mask_headers` (`bool`): Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******. When `null`, the `mask_headers` field will be omitted from the resulting object.\n - `path` (`string`): The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically. Optional (defaults to "/"). When `null`, the `path` field will be omitted from the resulting object.\n - `port` (`number`): The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL). When `null`, the `port` field will be omitted from the resulting object.\n - `request_method` (`string`): The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then requestMethod defaults to GET. Default value: "GET" Possible values: ["METHOD_UNSPECIFIED", "GET", "POST"] When `null`, the `request_method` field will be omitted from the resulting object.\n - `use_ssl` (`bool`): If true, use HTTPS instead of HTTP to run the check. When `null`, the `use_ssl` field will be omitted from the resulting object.\n - `validate_ssl` (`bool`): Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitoredResource is set to uptime_url. If useSsl is false, setting validateSsl to true has no effect. When `null`, the `validate_ssl` field will be omitted from the resulting object.\n - `accepted_response_status_codes` (`list[obj]`): If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. When `null`, the `accepted_response_status_codes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.accepted_response_status_codes.new](#fn-http_checkaccepted_response_status_codesnew) constructor.\n - `auth_info` (`list[obj]`): The authentication information. Optional when creating an HTTP check; defaults to empty. When `null`, the `auth_info` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.auth_info.new](#fn-http_checkauth_infonew) constructor.\n - `ping_config` (`list[obj]`): Contains information needed to add pings to an HTTP check. When `null`, the `ping_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.ping_config.new](#fn-http_checkping_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `http_check` sub block.\n', args=[]), new( accepted_response_status_codes=null, auth_info=null, body=null, content_type=null, + custom_content_type=null, headers=null, mask_headers=null, path=null, + ping_config=null, port=null, request_method=null, use_ssl=null, @@ -63,14 +65,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); auth_info: auth_info, body: body, content_type: content_type, + custom_content_type: custom_content_type, headers: headers, mask_headers: mask_headers, path: path, + ping_config: ping_config, port: port, request_method: request_method, use_ssl: use_ssl, validate_ssl: validate_ssl, }), + ping_config:: { + '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.http_check.ping_config.new` constructs a new object with attributes and blocks configured for the `ping_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `pings_count` (`number`): Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.\n\n**Returns**:\n - An attribute object that represents the `ping_config` sub block.\n', args=[]), + new( + pings_count + ):: std.prune(a={ + pings_count: pings_count, + }), + }, }, monitored_resource:: { '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.monitored_resource.new` constructs a new object with attributes and blocks configured for the `monitored_resource`\nTerraform sub block.\n\n\n\n**Args**:\n - `labels` (`obj`): Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone".\n - `type` (`string`): The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.monitoredResourceDescriptors#MonitoredResourceDescriptor) object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).\n\n**Returns**:\n - An attribute object that represents the `monitored_resource` sub block.\n', args=[]), @@ -82,7 +94,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type: type, }), }, - '#new':: d.fn(help="\n`google.monitoring_uptime_check_config.new` injects a new `google_monitoring_uptime_check_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.monitoring_uptime_check_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.monitoring_uptime_check_config` using the reference:\n\n $._ref.google_monitoring_uptime_check_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_monitoring_uptime_check_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 - `checker_type` (`string`): The checker type to use for the check. If the monitored resource type is servicedirectory_service, checkerType must be set to VPC_CHECKERS. Possible values: [\u0026#34;STATIC_IP_CHECKERS\u0026#34;, \u0026#34;VPC_CHECKERS\u0026#34;] When `null`, the `checker_type` field will be omitted from the resulting object.\n - `display_name` (`string`): A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.\n - `period` (`string`): How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s. When `null`, the `period` 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 - `selected_regions` (`list`): The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. When `null`, the `selected_regions` field will be omitted from the resulting object.\n - `timeout` (`string`): The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration\n - `content_matchers` (`list[obj]`): The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response\u0026#39;s content. This field is optional and should only be specified if a content match is required. When `null`, the `content_matchers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.content_matchers.new](#fn-content_matchersnew) constructor.\n - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor.\n - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_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.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor.\n - `resource_group` (`list[obj]`): The group resource associated with the configuration. When `null`, the `resource_group` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.resource_group.new](#fn-resource_groupnew) constructor.\n - `synthetic_monitor` (`list[obj]`): A Synthetic Monitor deployed to a Cloud Functions V2 instance. When `null`, the `synthetic_monitor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.synthetic_monitor.new](#fn-synthetic_monitornew) constructor.\n - `tcp_check` (`list[obj]`): Contains information needed to make a TCP check. When `null`, the `tcp_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.new](#fn-tcp_checknew) 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.monitoring_uptime_check_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.monitoring_uptime_check_config.new` injects a new `google_monitoring_uptime_check_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.monitoring_uptime_check_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.monitoring_uptime_check_config` using the reference:\n\n $._ref.google_monitoring_uptime_check_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_monitoring_uptime_check_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 - `checker_type` (`string`): The checker type to use for the check. If the monitored resource type is servicedirectory_service, checkerType must be set to VPC_CHECKERS. Possible values: [\u0026#34;STATIC_IP_CHECKERS\u0026#34;, \u0026#34;VPC_CHECKERS\u0026#34;] When `null`, the `checker_type` field will be omitted from the resulting object.\n - `display_name` (`string`): A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.\n - `period` (`string`): How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s. When `null`, the `period` 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 - `selected_regions` (`list`): The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. When `null`, the `selected_regions` field will be omitted from the resulting object.\n - `timeout` (`string`): The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration\n - `user_labels` (`obj`): User-supplied key/value data to be used for organizing and identifying the \u0026#39;UptimeCheckConfig\u0026#39; objects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. When `null`, the `user_labels` field will be omitted from the resulting object.\n - `content_matchers` (`list[obj]`): The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response\u0026#39;s content. This field is optional and should only be specified if a content match is required. When `null`, the `content_matchers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.content_matchers.new](#fn-content_matchersnew) constructor.\n - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor.\n - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_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.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor.\n - `resource_group` (`list[obj]`): The group resource associated with the configuration. When `null`, the `resource_group` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.resource_group.new](#fn-resource_groupnew) constructor.\n - `synthetic_monitor` (`list[obj]`): A Synthetic Monitor deployed to a Cloud Functions V2 instance. When `null`, the `synthetic_monitor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.synthetic_monitor.new](#fn-synthetic_monitornew) constructor.\n - `tcp_check` (`list[obj]`): Contains information needed to make a TCP check. When `null`, the `tcp_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.new](#fn-tcp_checknew) 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.monitoring_uptime_check_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, display_name, @@ -98,6 +110,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); synthetic_monitor=null, tcp_check=null, timeouts=null, + user_labels=null, _meta={} ):: tf.withResource( type='google_monitoring_uptime_check_config', @@ -115,11 +128,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); synthetic_monitor=synthetic_monitor, tcp_check=tcp_check, timeout=timeout, - timeouts=timeouts + timeouts=timeouts, + user_labels=user_labels ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.monitoring_uptime_check_config.newAttrs` constructs a new object with attributes and blocks configured for the `monitoring_uptime_check_config`\nTerraform resource.\n\nUnlike [google.monitoring_uptime_check_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 - `checker_type` (`string`): The checker type to use for the check. If the monitored resource type is servicedirectory_service, checkerType must be set to VPC_CHECKERS. Possible values: ["STATIC_IP_CHECKERS", "VPC_CHECKERS"] When `null`, the `checker_type` field will be omitted from the resulting object.\n - `display_name` (`string`): A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.\n - `period` (`string`): How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s. When `null`, the `period` 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 - `selected_regions` (`list`): The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. When `null`, the `selected_regions` field will be omitted from the resulting object.\n - `timeout` (`string`): The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration\n - `content_matchers` (`list[obj]`): The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required. When `null`, the `content_matchers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.content_matchers.new](#fn-content_matchersnew) constructor.\n - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor.\n - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_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.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor.\n - `resource_group` (`list[obj]`): The group resource associated with the configuration. When `null`, the `resource_group` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.resource_group.new](#fn-resource_groupnew) constructor.\n - `synthetic_monitor` (`list[obj]`): A Synthetic Monitor deployed to a Cloud Functions V2 instance. When `null`, the `synthetic_monitor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.synthetic_monitor.new](#fn-synthetic_monitornew) constructor.\n - `tcp_check` (`list[obj]`): Contains information needed to make a TCP check. When `null`, the `tcp_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.new](#fn-tcp_checknew) 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.monitoring_uptime_check_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 `monitoring_uptime_check_config` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.monitoring_uptime_check_config.newAttrs` constructs a new object with attributes and blocks configured for the `monitoring_uptime_check_config`\nTerraform resource.\n\nUnlike [google.monitoring_uptime_check_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 - `checker_type` (`string`): The checker type to use for the check. If the monitored resource type is servicedirectory_service, checkerType must be set to VPC_CHECKERS. Possible values: ["STATIC_IP_CHECKERS", "VPC_CHECKERS"] When `null`, the `checker_type` field will be omitted from the resulting object.\n - `display_name` (`string`): A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.\n - `period` (`string`): How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s. When `null`, the `period` 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 - `selected_regions` (`list`): The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. When `null`, the `selected_regions` field will be omitted from the resulting object.\n - `timeout` (`string`): The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration\n - `user_labels` (`obj`): User-supplied key/value data to be used for organizing and identifying the 'UptimeCheckConfig' objects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. When `null`, the `user_labels` field will be omitted from the resulting object.\n - `content_matchers` (`list[obj]`): The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required. When `null`, the `content_matchers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.content_matchers.new](#fn-content_matchersnew) constructor.\n - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor.\n - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_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.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor.\n - `resource_group` (`list[obj]`): The group resource associated with the configuration. When `null`, the `resource_group` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.resource_group.new](#fn-resource_groupnew) constructor.\n - `synthetic_monitor` (`list[obj]`): A Synthetic Monitor deployed to a Cloud Functions V2 instance. When `null`, the `synthetic_monitor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.synthetic_monitor.new](#fn-synthetic_monitornew) constructor.\n - `tcp_check` (`list[obj]`): Contains information needed to make a TCP check. When `null`, the `tcp_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.new](#fn-tcp_checknew) 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.monitoring_uptime_check_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 `monitoring_uptime_check_config` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, timeout, @@ -133,7 +147,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); selected_regions=null, synthetic_monitor=null, tcp_check=null, - timeouts=null + timeouts=null, + user_labels=null ):: std.prune(a={ checker_type: checker_type, content_matchers: content_matchers, @@ -148,6 +163,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); tcp_check: tcp_check, timeout: timeout, timeouts: timeouts, + user_labels: user_labels, }), resource_group:: { '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.resource_group.new` constructs a new object with attributes and blocks configured for the `resource_group`\nTerraform sub block.\n\n\n\n**Args**:\n - `group_id` (`string`): The group of resources being monitored. Should be the 'name' of a group When `null`, the `group_id` field will be omitted from the resulting object.\n - `resource_type` (`string`): The resource type of the group members. Possible values: ["RESOURCE_TYPE_UNSPECIFIED", "INSTANCE", "AWS_ELB_LOAD_BALANCER"] When `null`, the `resource_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `resource_group` sub block.\n', args=[]), @@ -176,12 +192,22 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, tcp_check:: { - '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.tcp_check.new` constructs a new object with attributes and blocks configured for the `tcp_check`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.\n\n**Returns**:\n - An attribute object that represents the `tcp_check` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.tcp_check.new` constructs a new object with attributes and blocks configured for the `tcp_check`\nTerraform sub block.\n\n\n\n**Args**:\n - `port` (`number`): The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.\n - `ping_config` (`list[obj]`): Contains information needed to add pings to a TCP check. When `null`, the `ping_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.ping_config.new](#fn-tcp_checkping_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `tcp_check` sub block.\n', args=[]), new( - port + port, + ping_config=null ):: std.prune(a={ + ping_config: ping_config, port: port, }), + ping_config:: { + '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.tcp_check.ping_config.new` constructs a new object with attributes and blocks configured for the `ping_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `pings_count` (`number`): Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.\n\n**Returns**:\n - An attribute object that represents the `ping_config` sub block.\n', args=[]), + new( + pings_count + ):: std.prune(a={ + pings_count: pings_count, + }), + }, }, timeouts:: { '#new':: d.fn(help='\n`google.monitoring_uptime_check_config.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), @@ -395,4 +421,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withUserLabels':: d.fn(help='`google.obj.withUserLabels` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the user_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 `user_labels` field.\n', args=[]), + withUserLabels(resourceLabel, value): { + resource+: { + google_monitoring_uptime_check_config+: { + [resourceLabel]+: { + user_labels: value, + }, + }, + }, + }, } diff --git a/4.x/_gen/resources/org_policy_policy.libsonnet b/4.x/_gen/resources/org_policy_policy.libsonnet index cda8fbe3..fd25ed6c 100644 --- a/4.x/_gen/resources/org_policy_policy.libsonnet +++ b/4.x/_gen/resources/org_policy_policy.libsonnet @@ -2,11 +2,64 @@ 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='org_policy_policy', url='', help='`org_policy_policy` represents the `google_org_policy_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.org_policy_policy.new` injects a new `google_org_policy_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.org_policy_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.org_policy_policy` using the reference:\n\n $._ref.google_org_policy_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_org_policy_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 - `name` (`string`): Immutable. The resource name of the Policy. Must be one of the following forms, where constraint_name is the name of the constraint which this Policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, \u0026#34;projects/123/policies/compute.disableSerialPortAccess\u0026#34;. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.\n - `parent` (`string`): The parent of the resource.\n - `spec` (`list[obj]`): Basic information about the Organization Policy. When `null`, the `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.org_policy_policy.spec.new](#fn-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.org_policy_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=[]), + dry_run_spec:: { + '#new':: d.fn(help='\n`google.org_policy_policy.dry_run_spec.new` constructs a new object with attributes and blocks configured for the `dry_run_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `inherit_from_parent` (`bool`): Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints. When `null`, the `inherit_from_parent` field will be omitted from the resulting object.\n - `reset` (`bool`): Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false. When `null`, the `reset` field will be omitted from the resulting object.\n - `rules` (`list[obj]`): In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset. - Boolean policy rules with conditions must set `enforced` to the opposite of the policy rule without a condition. - During policy evaluation, policy rules with conditions that are true for a target resource take precedence. 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.org_policy_policy.dry_run_spec.rules.new](#fn-dry_run_specrulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `dry_run_spec` sub block.\n', args=[]), + new( + inherit_from_parent=null, + reset=null, + rules=null + ):: std.prune(a={ + inherit_from_parent: inherit_from_parent, + reset: reset, + rules: rules, + }), + rules:: { + condition:: { + '#new':: d.fn(help='\n`google.org_policy_policy.dry_run_spec.rules.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`): Optional. 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.\n - `expression` (`string`): Textual representation of an expression in Common Expression Language syntax. When `null`, the `expression` field will be omitted from the resulting object.\n - `location` (`string`): Optional. 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.\n - `title` (`string`): Optional. 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.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), + new( + description=null, + expression=null, + location=null, + title=null + ):: std.prune(a={ + description: description, + expression: expression, + location: location, + title: title, + }), + }, + '#new':: d.fn(help='\n`google.org_policy_policy.dry_run_spec.rules.new` constructs a new object with attributes and blocks configured for the `rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `allow_all` (`string`): Setting this to true means that all values are allowed. This field can be set only in policies for list constraints. When `null`, the `allow_all` field will be omitted from the resulting object.\n - `deny_all` (`string`): Setting this to true means that all values are denied. This field can be set only in policies for list constraints. When `null`, the `deny_all` field will be omitted from the resulting object.\n - `enforce` (`string`): If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. When `null`, the `enforce` field will be omitted from the resulting object.\n - `condition` (`list[obj]`): A condition which determines whether this rule is used in the evaluation of the policy. When set, the `expression` field in the `Expr' must include from 1 to 10 subexpressions, joined by the "||" or "&&" operators. Each subexpression must be of the form "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: "resource.matchTag('123456789/environment, 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". 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.org_policy_policy.dry_run_spec.rules.condition.new](#fn-dry_run_specdry_run_specconditionnew) constructor.\n - `values` (`list[obj]`): List of values to be used for this policy rule. This field can be set only in policies for list constraints. When `null`, the `values` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.org_policy_policy.dry_run_spec.rules.values.new](#fn-dry_run_specdry_run_specvaluesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rules` sub block.\n', args=[]), + new( + allow_all=null, + condition=null, + deny_all=null, + enforce=null, + values=null + ):: std.prune(a={ + allow_all: allow_all, + condition: condition, + deny_all: deny_all, + enforce: enforce, + values: values, + }), + values:: { + '#new':: d.fn(help='\n`google.org_policy_policy.dry_run_spec.rules.values.new` constructs a new object with attributes and blocks configured for the `values`\nTerraform sub block.\n\n\n\n**Args**:\n - `allowed_values` (`list`): List of values allowed at this resource. When `null`, the `allowed_values` field will be omitted from the resulting object.\n - `denied_values` (`list`): List of values denied at this resource. When `null`, the `denied_values` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `values` sub block.\n', args=[]), + new( + allowed_values=null, + denied_values=null + ):: std.prune(a={ + allowed_values: allowed_values, + denied_values: denied_values, + }), + }, + }, + }, + '#new':: d.fn(help="\n`google.org_policy_policy.new` injects a new `google_org_policy_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.org_policy_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.org_policy_policy` using the reference:\n\n $._ref.google_org_policy_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_org_policy_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 - `name` (`string`): Immutable. The resource name of the Policy. Must be one of the following forms, where constraint_name is the name of the constraint which this Policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, \u0026#34;projects/123/policies/compute.disableSerialPortAccess\u0026#34;. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.\n - `parent` (`string`): The parent of the resource.\n - `dry_run_spec` (`list[obj]`): Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it\u0026#39;s enforced. When `null`, the `dry_run_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.org_policy_policy.dry_run_spec.new](#fn-dry_run_specnew) constructor.\n - `spec` (`list[obj]`): Basic information about the Organization Policy. When `null`, the `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.org_policy_policy.spec.new](#fn-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.org_policy_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, parent, + dry_run_spec=null, spec=null, timeouts=null, _meta={} @@ -14,6 +67,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='google_org_policy_policy', label=resourceLabel, attrs=self.newAttrs( + dry_run_spec=dry_run_spec, name=name, parent=parent, spec=spec, @@ -21,13 +75,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.org_policy_policy.newAttrs` constructs a new object with attributes and blocks configured for the `org_policy_policy`\nTerraform resource.\n\nUnlike [google.org_policy_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 - `name` (`string`): Immutable. The resource name of the Policy. Must be one of the following forms, where constraint_name is the name of the constraint which this Policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, "projects/123/policies/compute.disableSerialPortAccess". Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.\n - `parent` (`string`): The parent of the resource.\n - `spec` (`list[obj]`): Basic information about the Organization Policy. When `null`, the `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.org_policy_policy.spec.new](#fn-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.org_policy_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 `org_policy_policy` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.org_policy_policy.newAttrs` constructs a new object with attributes and blocks configured for the `org_policy_policy`\nTerraform resource.\n\nUnlike [google.org_policy_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 - `name` (`string`): Immutable. The resource name of the Policy. Must be one of the following forms, where constraint_name is the name of the constraint which this Policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, "projects/123/policies/compute.disableSerialPortAccess". Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number.\n - `parent` (`string`): The parent of the resource.\n - `dry_run_spec` (`list[obj]`): Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it's enforced. When `null`, the `dry_run_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.org_policy_policy.dry_run_spec.new](#fn-dry_run_specnew) constructor.\n - `spec` (`list[obj]`): Basic information about the Organization Policy. When `null`, the `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.org_policy_policy.spec.new](#fn-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.org_policy_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 `org_policy_policy` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, parent, + dry_run_spec=null, spec=null, timeouts=null ):: std.prune(a={ + dry_run_spec: dry_run_spec, name: name, parent: parent, spec: spec, @@ -97,6 +153,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withDryRunSpec':: d.fn(help='`google.list[obj].withDryRunSpec` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the dry_run_spec field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withDryRunSpecMixin](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 `dry_run_spec` field.\n', args=[]), + withDryRunSpec(resourceLabel, value): { + resource+: { + google_org_policy_policy+: { + [resourceLabel]+: { + dry_run_spec: value, + }, + }, + }, + }, + '#withDryRunSpecMixin':: d.fn(help='`google.list[obj].withDryRunSpecMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the dry_run_spec field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withDryRunSpec](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 `dry_run_spec` field.\n', args=[]), + withDryRunSpecMixin(resourceLabel, value): { + resource+: { + google_org_policy_policy+: { + [resourceLabel]+: { + dry_run_spec+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), withName(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/pubsub_topic.libsonnet b/4.x/_gen/resources/pubsub_topic.libsonnet index a88b4ab1..a3917152 100644 --- a/4.x/_gen/resources/pubsub_topic.libsonnet +++ b/4.x/_gen/resources/pubsub_topic.libsonnet @@ -10,7 +10,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); allowed_persistence_regions: allowed_persistence_regions, }), }, - '#new':: d.fn(help="\n`google.pubsub_topic.new` injects a new `google_pubsub_topic` 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.pubsub_topic.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.pubsub_topic` using the reference:\n\n $._ref.google_pubsub_topic.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_pubsub_topic.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 - `kms_key_name` (`string`): The resource name of the Cloud KMS CryptoKey to be used to protect access\nto messages published on this topic. Your project\u0026#39;s PubSub service account\n(\u0026#39;service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com\u0026#39;) must have\n\u0026#39;roles/cloudkms.cryptoKeyEncrypterDecrypter\u0026#39; to use this feature.\nThe expected format is \u0026#39;projects/*/locations/*/keyRings/*/cryptoKeys/*\u0026#39; When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Topic.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `message_retention_duration` (`string`): Indicates the minimum duration to retain a message after it is published\nto the topic. If this field is set, messages published to the topic in\nthe last messageRetentionDuration are always available to subscribers.\nFor instance, it allows any attached subscription to seek to a timestamp\nthat is up to messageRetentionDuration in the past. If this field is not\nset, message retention is controlled by settings on individual subscriptions.\nCannot be more than 31 days or less than 10 minutes. When `null`, the `message_retention_duration` field will be omitted from the resulting object.\n - `name` (`string`): Name of the topic.\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 - `message_storage_policy` (`list[obj]`): Policy constraining the set of Google Cloud Platform regions where\nmessages published to the topic may be stored. If not present, then no\nconstraints are in effect. When `null`, the `message_storage_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.pubsub_topic.message_storage_policy.new](#fn-message_storage_policynew) constructor.\n - `schema_settings` (`list[obj]`): Settings for validating messages published against a schema. When `null`, the `schema_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.pubsub_topic.schema_settings.new](#fn-schema_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.pubsub_topic.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.pubsub_topic.new` injects a new `google_pubsub_topic` 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.pubsub_topic.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.pubsub_topic` using the reference:\n\n $._ref.google_pubsub_topic.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_pubsub_topic.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 - `kms_key_name` (`string`): The resource name of the Cloud KMS CryptoKey to be used to protect access\nto messages published on this topic. Your project\u0026#39;s PubSub service account\n(\u0026#39;service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com\u0026#39;) must have\n\u0026#39;roles/cloudkms.cryptoKeyEncrypterDecrypter\u0026#39; to use this feature.\nThe expected format is \u0026#39;projects/*/locations/*/keyRings/*/cryptoKeys/*\u0026#39; When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Topic.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `message_retention_duration` (`string`): Indicates the minimum duration to retain a message after it is published\nto the topic. If this field is set, messages published to the topic in\nthe last messageRetentionDuration are always available to subscribers.\nFor instance, it allows any attached subscription to seek to a timestamp\nthat is up to messageRetentionDuration in the past. If this field is not\nset, message retention is controlled by settings on individual subscriptions.\nThe rotation period has the format of a decimal number, followed by the\nletter \u0026#39;s\u0026#39; (seconds). Cannot be more than 31 days or less than 10 minutes. When `null`, the `message_retention_duration` field will be omitted from the resulting object.\n - `name` (`string`): Name of the topic.\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 - `message_storage_policy` (`list[obj]`): Policy constraining the set of Google Cloud Platform regions where\nmessages published to the topic may be stored. If not present, then no\nconstraints are in effect. When `null`, the `message_storage_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.pubsub_topic.message_storage_policy.new](#fn-message_storage_policynew) constructor.\n - `schema_settings` (`list[obj]`): Settings for validating messages published against a schema. When `null`, the `schema_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.pubsub_topic.schema_settings.new](#fn-schema_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.pubsub_topic.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, @@ -37,7 +37,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.pubsub_topic.newAttrs` constructs a new object with attributes and blocks configured for the `pubsub_topic`\nTerraform resource.\n\nUnlike [google.pubsub_topic.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 - `kms_key_name` (`string`): The resource name of the Cloud KMS CryptoKey to be used to protect access\nto messages published on this topic. Your project's PubSub service account\n('service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com') must have\n'roles/cloudkms.cryptoKeyEncrypterDecrypter' to use this feature.\nThe expected format is 'projects/*/locations/*/keyRings/*/cryptoKeys/*' When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Topic.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `message_retention_duration` (`string`): Indicates the minimum duration to retain a message after it is published\nto the topic. If this field is set, messages published to the topic in\nthe last messageRetentionDuration are always available to subscribers.\nFor instance, it allows any attached subscription to seek to a timestamp\nthat is up to messageRetentionDuration in the past. If this field is not\nset, message retention is controlled by settings on individual subscriptions.\nCannot be more than 31 days or less than 10 minutes. When `null`, the `message_retention_duration` field will be omitted from the resulting object.\n - `name` (`string`): Name of the topic.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `message_storage_policy` (`list[obj]`): Policy constraining the set of Google Cloud Platform regions where\nmessages published to the topic may be stored. If not present, then no\nconstraints are in effect. When `null`, the `message_storage_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.pubsub_topic.message_storage_policy.new](#fn-message_storage_policynew) constructor.\n - `schema_settings` (`list[obj]`): Settings for validating messages published against a schema. When `null`, the `schema_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.pubsub_topic.schema_settings.new](#fn-schema_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.pubsub_topic.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 `pubsub_topic` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.pubsub_topic.newAttrs` constructs a new object with attributes and blocks configured for the `pubsub_topic`\nTerraform resource.\n\nUnlike [google.pubsub_topic.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 - `kms_key_name` (`string`): The resource name of the Cloud KMS CryptoKey to be used to protect access\nto messages published on this topic. Your project's PubSub service account\n('service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com') must have\n'roles/cloudkms.cryptoKeyEncrypterDecrypter' to use this feature.\nThe expected format is 'projects/*/locations/*/keyRings/*/cryptoKeys/*' When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): A set of key/value label pairs to assign to this Topic.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\n - `message_retention_duration` (`string`): Indicates the minimum duration to retain a message after it is published\nto the topic. If this field is set, messages published to the topic in\nthe last messageRetentionDuration are always available to subscribers.\nFor instance, it allows any attached subscription to seek to a timestamp\nthat is up to messageRetentionDuration in the past. If this field is not\nset, message retention is controlled by settings on individual subscriptions.\nThe rotation period has the format of a decimal number, followed by the\nletter 's' (seconds). Cannot be more than 31 days or less than 10 minutes. When `null`, the `message_retention_duration` field will be omitted from the resulting object.\n - `name` (`string`): Name of the topic.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `message_storage_policy` (`list[obj]`): Policy constraining the set of Google Cloud Platform regions where\nmessages published to the topic may be stored. If not present, then no\nconstraints are in effect. When `null`, the `message_storage_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.pubsub_topic.message_storage_policy.new](#fn-message_storage_policynew) constructor.\n - `schema_settings` (`list[obj]`): Settings for validating messages published against a schema. When `null`, the `schema_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.pubsub_topic.schema_settings.new](#fn-schema_settingsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.pubsub_topic.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 `pubsub_topic` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, kms_key_name=null, diff --git a/4.x/_gen/resources/spanner_instance.libsonnet b/4.x/_gen/resources/spanner_instance.libsonnet index 54a00d86..6603d5b4 100644 --- a/4.x/_gen/resources/spanner_instance.libsonnet +++ b/4.x/_gen/resources/spanner_instance.libsonnet @@ -2,11 +2,42 @@ 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='spanner_instance', url='', help='`spanner_instance` represents the `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.spanner_instance.new` injects a new `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.spanner_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.spanner_instance` using the reference:\n\n $._ref.google_spanner_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ 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; }.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. 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.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=[]), + autoscaling_config:: { + autoscaling_limits:: { + '#new':: d.fn(help='\n`google.spanner_instance.autoscaling_config.autoscaling_limits.new` constructs a new object with attributes and blocks configured for the `autoscaling_limits`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_processing_units` (`number`): Specifies maximum number of processing units allocated to the instance.\nIf set, this number should be multiples of 1000 and be greater than or equal to\nmin_processing_units. When `null`, the `max_processing_units` field will be omitted from the resulting object.\n - `min_processing_units` (`number`): Specifies minimum number of processing units allocated to the instance.\nIf set, this number should be multiples of 1000. When `null`, the `min_processing_units` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `autoscaling_limits` sub block.\n', args=[]), + new( + max_processing_units=null, + min_processing_units=null + ):: std.prune(a={ + max_processing_units: max_processing_units, + min_processing_units: min_processing_units, + }), + }, + autoscaling_targets:: { + '#new':: d.fn(help='\n`google.spanner_instance.autoscaling_config.autoscaling_targets.new` constructs a new object with attributes and blocks configured for the `autoscaling_targets`\nTerraform sub block.\n\n\n\n**Args**:\n - `high_priority_cpu_utilization_percent` (`number`): Specifies the target high priority cpu utilization percentage that the autoscaler\nshould be trying to achieve for the instance.\nThis number is on a scale from 0 (no utilization) to 100 (full utilization).. When `null`, the `high_priority_cpu_utilization_percent` field will be omitted from the resulting object.\n - `storage_utilization_percent` (`number`): Specifies the target storage utilization percentage that the autoscaler\nshould be trying to achieve for the instance.\nThis number is on a scale from 0 (no utilization) to 100 (full utilization). When `null`, the `storage_utilization_percent` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `autoscaling_targets` sub block.\n', args=[]), + new( + high_priority_cpu_utilization_percent=null, + storage_utilization_percent=null + ):: std.prune(a={ + high_priority_cpu_utilization_percent: high_priority_cpu_utilization_percent, + storage_utilization_percent: storage_utilization_percent, + }), + }, + '#new':: d.fn(help='\n`google.spanner_instance.autoscaling_config.new` constructs a new object with attributes and blocks configured for the `autoscaling_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `autoscaling_limits` (`list[obj]`): Defines scale in controls to reduce the risk of response latency\nand outages due to abrupt scale-in events When `null`, the `autoscaling_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.spanner_instance.autoscaling_config.autoscaling_limits.new](#fn-autoscaling_configautoscaling_limitsnew) constructor.\n - `autoscaling_targets` (`list[obj]`): Defines scale in controls to reduce the risk of response latency\nand outages due to abrupt scale-in events When `null`, the `autoscaling_targets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.spanner_instance.autoscaling_config.autoscaling_targets.new](#fn-autoscaling_configautoscaling_targetsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `autoscaling_config` sub block.\n', args=[]), + new( + autoscaling_limits=null, + autoscaling_targets=null + ):: std.prune(a={ + autoscaling_limits: autoscaling_limits, + autoscaling_targets: autoscaling_targets, + }), + }, + '#new':: d.fn(help="\n`google.spanner_instance.new` injects a new `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.spanner_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.spanner_instance` using the reference:\n\n $._ref.google_spanner_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ 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; }.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. 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 - `autoscaling_config` (`list[obj]`): The autoscaling configuration. Autoscaling is enabled if this field is set.\nWhen autoscaling is enabled, num_nodes and processing_units are treated as,\nOUTPUT_ONLY fields and reflect the current compute capacity allocated to\nthe instance. When `null`, the `autoscaling_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.spanner_instance.autoscaling_config.new](#fn-autoscaling_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.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, display_name, + autoscaling_config=null, force_destroy=null, labels=null, name=null, @@ -19,6 +50,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='google_spanner_instance', label=resourceLabel, attrs=self.newAttrs( + autoscaling_config=autoscaling_config, config=config, display_name=display_name, force_destroy=force_destroy, @@ -31,10 +63,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.spanner_instance.newAttrs` constructs a new object with attributes and blocks configured for the `spanner_instance`\nTerraform resource.\n\nUnlike [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" }.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field 'effective_labels' for all of the labels present on the resource. 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.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 `spanner_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.spanner_instance.newAttrs` constructs a new object with attributes and blocks configured for the `spanner_instance`\nTerraform resource.\n\nUnlike [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" }.\n\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field 'effective_labels' for all of the labels present on the resource. 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 - `autoscaling_config` (`list[obj]`): The autoscaling configuration. Autoscaling is enabled if this field is set.\nWhen autoscaling is enabled, num_nodes and processing_units are treated as,\nOUTPUT_ONLY fields and reflect the current compute capacity allocated to\nthe instance. When `null`, the `autoscaling_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.spanner_instance.autoscaling_config.new](#fn-autoscaling_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.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 `spanner_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( config, display_name, + autoscaling_config=null, force_destroy=null, labels=null, name=null, @@ -43,6 +76,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); project=null, timeouts=null ):: std.prune(a={ + autoscaling_config: autoscaling_config, config: config, display_name: display_name, force_destroy: force_destroy, @@ -65,6 +99,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withAutoscalingConfig':: d.fn(help='`google.list[obj].withAutoscalingConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the autoscaling_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withAutoscalingConfigMixin](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 `autoscaling_config` field.\n', args=[]), + withAutoscalingConfig(resourceLabel, value): { + resource+: { + google_spanner_instance+: { + [resourceLabel]+: { + autoscaling_config: value, + }, + }, + }, + }, + '#withAutoscalingConfigMixin':: d.fn(help='`google.list[obj].withAutoscalingConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the autoscaling_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withAutoscalingConfig](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 `autoscaling_config` field.\n', args=[]), + withAutoscalingConfigMixin(resourceLabel, value): { + resource+: { + google_spanner_instance+: { + [resourceLabel]+: { + autoscaling_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withConfig':: d.fn(help='`google.string.withConfig` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the config field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `config` field.\n', args=[]), withConfig(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/sql_database_instance.libsonnet b/4.x/_gen/resources/sql_database_instance.libsonnet index 6c809b99..1e1663a1 100644 --- a/4.x/_gen/resources/sql_database_instance.libsonnet +++ b/4.x/_gen/resources/sql_database_instance.libsonnet @@ -239,7 +239,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); value: value, }), }, - '#new':: d.fn(help='\n`google.sql_database_instance.settings.ip_configuration.new` constructs a new object with attributes and blocks configured for the `ip_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `allocated_ip_range` (`string`): The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. When `null`, the `allocated_ip_range` field will be omitted from the resulting object.\n - `enable_private_path_for_google_cloud_services` (`bool`): Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported. When `null`, the `enable_private_path_for_google_cloud_services` field will be omitted from the resulting object.\n - `ipv4_enabled` (`bool`): Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured. When `null`, the `ipv4_enabled` field will be omitted from the resulting object.\n - `private_network` (`string`): The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. 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.\n - `require_ssl` (`bool`): Set the `require_ssl` field on the resulting object. When `null`, the `require_ssl` field will be omitted from the resulting object.\n - `authorized_networks` (`list[obj]`): Set the `authorized_networks` field on the resulting object. 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.sql_database_instance.settings.ip_configuration.authorized_networks.new](#fn-settingssettingsauthorized_networksnew) constructor.\n - `psc_config` (`list[obj]`): PSC settings for a Cloud SQL instance. When `null`, the `psc_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.settings.ip_configuration.psc_config.new](#fn-settingssettingspsc_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ip_configuration` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google.sql_database_instance.settings.ip_configuration.new` constructs a new object with attributes and blocks configured for the `ip_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `allocated_ip_range` (`string`): The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. When `null`, the `allocated_ip_range` field will be omitted from the resulting object.\n - `enable_private_path_for_google_cloud_services` (`bool`): Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported. When `null`, the `enable_private_path_for_google_cloud_services` field will be omitted from the resulting object.\n - `ipv4_enabled` (`bool`): Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured. When `null`, the `ipv4_enabled` field will be omitted from the resulting object.\n - `private_network` (`string`): The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. 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.\n - `require_ssl` (`bool`): Whether SSL connections over IP are enforced or not. To change this field, also set the corresponding value in ssl_mode if it has been set too. When `null`, the `require_ssl` field will be omitted from the resulting object.\n - `ssl_mode` (`string`): Specify how SSL connection should be enforced in DB connections. This field provides more SSL enforcment options compared to require_ssl. To change this field, also set the correspoding value in require_ssl. When `null`, the `ssl_mode` field will be omitted from the resulting object.\n - `authorized_networks` (`list[obj]`): Set the `authorized_networks` field on the resulting object. 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.sql_database_instance.settings.ip_configuration.authorized_networks.new](#fn-settingssettingsauthorized_networksnew) constructor.\n - `psc_config` (`list[obj]`): PSC settings for a Cloud SQL instance. When `null`, the `psc_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.settings.ip_configuration.psc_config.new](#fn-settingssettingspsc_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ip_configuration` sub block.\n', args=[]), new( allocated_ip_range=null, authorized_networks=null, @@ -247,7 +247,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ipv4_enabled=null, private_network=null, psc_config=null, - require_ssl=null + require_ssl=null, + ssl_mode=null ):: std.prune(a={ allocated_ip_range: allocated_ip_range, authorized_networks: authorized_networks, @@ -256,6 +257,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); private_network: private_network, psc_config: psc_config, require_ssl: require_ssl, + ssl_mode: ssl_mode, }), psc_config:: { '#new':: d.fn(help='\n`google.sql_database_instance.settings.ip_configuration.psc_config.new` constructs a new object with attributes and blocks configured for the `psc_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `allowed_consumer_projects` (`list`): List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). When `null`, the `allowed_consumer_projects` field will be omitted from the resulting object.\n - `psc_enabled` (`bool`): Whether PSC connectivity is enabled for this instance. When `null`, the `psc_enabled` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `psc_config` sub block.\n', args=[]), diff --git a/4.x/_gen/resources/vertex_ai_index_endpoint.libsonnet b/4.x/_gen/resources/vertex_ai_index_endpoint.libsonnet index 986c7328..e7c73c8f 100644 --- a/4.x/_gen/resources/vertex_ai_index_endpoint.libsonnet +++ b/4.x/_gen/resources/vertex_ai_index_endpoint.libsonnet @@ -2,13 +2,14 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='vertex_ai_index_endpoint', url='', help='`vertex_ai_index_endpoint` represents the `google_vertex_ai_index_endpoint` 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.vertex_ai_index_endpoint.new` injects a new `google_vertex_ai_index_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.vertex_ai_index_endpoint.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.vertex_ai_index_endpoint` using the reference:\n\n $._ref.google_vertex_ai_index_endpoint.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_vertex_ai_index_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 Index. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the Index. 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 Indexes.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\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 index endpoint should be peered.\nPrivate services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network.\n[Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): \u0026#39;projects/{project}/global/networks/{network}\u0026#39;.\nWhere \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 - `public_endpoint_enabled` (`bool`): If true, the deployed index will be accessible through public endpoint. When `null`, the `public_endpoint_enabled` field will be omitted from the resulting object.\n - `region` (`string`): The region of the index endpoint. eg us-central1 When `null`, the `region` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.vertex_ai_index_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.vertex_ai_index_endpoint.new` injects a new `google_vertex_ai_index_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.vertex_ai_index_endpoint.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.vertex_ai_index_endpoint` using the reference:\n\n $._ref.google_vertex_ai_index_endpoint.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_vertex_ai_index_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 Index. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the Index. 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 Indexes.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field \u0026#39;effective_labels\u0026#39; for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\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 index endpoint should be peered.\nPrivate services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network.\n[Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): \u0026#39;projects/{project}/global/networks/{network}\u0026#39;.\nWhere \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 - `public_endpoint_enabled` (`bool`): If true, the deployed index will be accessible through public endpoint. When `null`, the `public_endpoint_enabled` field will be omitted from the resulting object.\n - `region` (`string`): The region of the index endpoint. eg us-central1 When `null`, the `region` field will be omitted from the resulting object.\n - `private_service_connect_config` (`list[obj]`): Optional. Configuration for private service connect. \u0026#39;network\u0026#39; and \u0026#39;privateServiceConnectConfig\u0026#39; are mutually exclusive. When `null`, the `private_service_connect_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.vertex_ai_index_endpoint.private_service_connect_config.new](#fn-private_service_connect_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.vertex_ai_index_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, description=null, labels=null, network=null, + private_service_connect_config=null, project=null, public_endpoint_enabled=null, region=null, @@ -22,6 +23,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); display_name=display_name, labels=labels, network=network, + private_service_connect_config=private_service_connect_config, project=project, public_endpoint_enabled=public_endpoint_enabled, region=region, @@ -29,12 +31,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google.vertex_ai_index_endpoint.newAttrs` constructs a new object with attributes and blocks configured for the `vertex_ai_index_endpoint`\nTerraform resource.\n\nUnlike [google.vertex_ai_index_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 Index. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the Index. 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 Indexes.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\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 index endpoint should be peered.\nPrivate services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network.\n[Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): 'projects/{project}/global/networks/{network}'.\nWhere '{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 - `public_endpoint_enabled` (`bool`): If true, the deployed index will be accessible through public endpoint. When `null`, the `public_endpoint_enabled` field will be omitted from the resulting object.\n - `region` (`string`): The region of the index endpoint. eg us-central1 When `null`, the `region` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.vertex_ai_index_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 `vertex_ai_index_endpoint` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google.vertex_ai_index_endpoint.newAttrs` constructs a new object with attributes and blocks configured for the `vertex_ai_index_endpoint`\nTerraform resource.\n\nUnlike [google.vertex_ai_index_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 Index. When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the Index. 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 Indexes.\n\n**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.\nPlease refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object.\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 index endpoint should be peered.\nPrivate services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network.\n[Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): 'projects/{project}/global/networks/{network}'.\nWhere '{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 - `public_endpoint_enabled` (`bool`): If true, the deployed index will be accessible through public endpoint. When `null`, the `public_endpoint_enabled` field will be omitted from the resulting object.\n - `region` (`string`): The region of the index endpoint. eg us-central1 When `null`, the `region` field will be omitted from the resulting object.\n - `private_service_connect_config` (`list[obj]`): Optional. Configuration for private service connect. 'network' and 'privateServiceConnectConfig' are mutually exclusive. When `null`, the `private_service_connect_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.vertex_ai_index_endpoint.private_service_connect_config.new](#fn-private_service_connect_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.vertex_ai_index_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 `vertex_ai_index_endpoint` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, description=null, labels=null, network=null, + private_service_connect_config=null, project=null, public_endpoint_enabled=null, region=null, @@ -44,11 +47,22 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); display_name: display_name, labels: labels, network: network, + private_service_connect_config: private_service_connect_config, project: project, public_endpoint_enabled: public_endpoint_enabled, region: region, timeouts: timeouts, }), + private_service_connect_config:: { + '#new':: d.fn(help='\n`google.vertex_ai_index_endpoint.private_service_connect_config.new` constructs a new object with attributes and blocks configured for the `private_service_connect_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `enable_private_service_connect` (`bool`): If set to true, the IndexEndpoint is created without private service access.\n - `project_allowlist` (`list`): A list of Projects from which the forwarding rule will target the service attachment. When `null`, the `project_allowlist` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `private_service_connect_config` sub block.\n', args=[]), + new( + enable_private_service_connect, + project_allowlist=null + ):: std.prune(a={ + enable_private_service_connect: enable_private_service_connect, + project_allowlist: project_allowlist, + }), + }, timeouts:: { '#new':: d.fn(help='\n`google.vertex_ai_index_endpoint.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( @@ -101,6 +115,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withPrivateServiceConnectConfig':: d.fn(help='`google.list[obj].withPrivateServiceConnectConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the private_service_connect_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google.list[obj].withPrivateServiceConnectConfigMixin](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 `private_service_connect_config` field.\n', args=[]), + withPrivateServiceConnectConfig(resourceLabel, value): { + resource+: { + google_vertex_ai_index_endpoint+: { + [resourceLabel]+: { + private_service_connect_config: value, + }, + }, + }, + }, + '#withPrivateServiceConnectConfigMixin':: d.fn(help='`google.list[obj].withPrivateServiceConnectConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the private_service_connect_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google.list[obj].withPrivateServiceConnectConfig](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 `private_service_connect_config` field.\n', args=[]), + withPrivateServiceConnectConfigMixin(resourceLabel, value): { + resource+: { + google_vertex_ai_index_endpoint+: { + [resourceLabel]+: { + private_service_connect_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), withProject(resourceLabel, value): { resource+: { diff --git a/docs/4.x/README.md b/docs/4.x/README.md index bc5a5af1..3ffab47d 100644 --- a/docs/4.x/README.md +++ b/docs/4.x/README.md @@ -530,6 +530,7 @@ project. * [identity_platform_tenant_default_supported_idp_config](identity_platform_tenant_default_supported_idp_config.md) * [identity_platform_tenant_inbound_saml_config](identity_platform_tenant_inbound_saml_config.md) * [identity_platform_tenant_oauth_idp_config](identity_platform_tenant_oauth_idp_config.md) +* [integration_connectors_connection](integration_connectors_connection.md) * [kms_crypto_key](kms_crypto_key.md) * [kms_crypto_key_iam_binding](kms_crypto_key_iam_binding.md) * [kms_crypto_key_iam_member](kms_crypto_key_iam_member.md) diff --git a/docs/4.x/assured_workloads_workload.md b/docs/4.x/assured_workloads_workload.md index 37522b6c..e04d38c5 100644 --- a/docs/4.x/assured_workloads_workload.md +++ b/docs/4.x/assured_workloads_workload.md @@ -18,18 +18,25 @@ This package contains functions and utilities for setting up the resource using * [`fn withBillingAccount()`](#fn-withbillingaccount) * [`fn withComplianceRegime()`](#fn-withcomplianceregime) * [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withEnableSovereignControls()`](#fn-withenablesovereigncontrols) * [`fn withKmsSettings()`](#fn-withkmssettings) * [`fn withKmsSettingsMixin()`](#fn-withkmssettingsmixin) * [`fn withLabels()`](#fn-withlabels) * [`fn withLocation()`](#fn-withlocation) * [`fn withOrganization()`](#fn-withorganization) +* [`fn withPartner()`](#fn-withpartner) +* [`fn withPartnerPermissions()`](#fn-withpartnerpermissions) +* [`fn withPartnerPermissionsMixin()`](#fn-withpartnerpermissionsmixin) * [`fn withProvisionedResourcesParent()`](#fn-withprovisionedresourcesparent) * [`fn withResourceSettings()`](#fn-withresourcesettings) * [`fn withResourceSettingsMixin()`](#fn-withresourcesettingsmixin) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withViolationNotificationsEnabled()`](#fn-withviolationnotificationsenabled) * [`obj kms_settings`](#obj-kms_settings) * [`fn new()`](#fn-kms_settingsnew) +* [`obj partner_permissions`](#obj-partner_permissions) + * [`fn new()`](#fn-partner_permissionsnew) * [`obj resource_settings`](#obj-resource_settings) * [`fn new()`](#fn-resource_settingsnew) * [`obj timeouts`](#obj-timeouts) @@ -64,17 +71,21 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `billing_account` (`string`): Required. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, 'billingAccounts/012345-567890-ABCDEF`. - - `compliance_regime` (`string`): Required. Immutable. Compliance Regime associated with this workload. Possible values: COMPLIANCE_REGIME_UNSPECIFIED, IL4, CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, US_REGIONAL_ACCESS, HIPAA, EU_REGIONS_AND_SUPPORT, CA_REGIONS_AND_SUPPORT, ITAR, AU_REGIONS_AND_US_SUPPORT, ASSURED_WORKLOADS_FOR_PARTNERS + - `billing_account` (`string`): Optional. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. When `null`, the `billing_account` field will be omitted from the resulting object. + - `compliance_regime` (`string`): Required. Immutable. Compliance Regime associated with this workload. Possible values: COMPLIANCE_REGIME_UNSPECIFIED, IL4, CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, US_REGIONAL_ACCESS, HIPAA, HITRUST, EU_REGIONS_AND_SUPPORT, CA_REGIONS_AND_SUPPORT, ITAR, AU_REGIONS_AND_US_SUPPORT, ASSURED_WORKLOADS_FOR_PARTNERS, ISR_REGIONS, ISR_REGIONS_AND_SUPPORT, CA_PROTECTED_B, IL5, IL2, JP_REGIONS_AND_SUPPORT - `display_name` (`string`): Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload + - `enable_sovereign_controls` (`bool`): Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. When `null`, the `enable_sovereign_controls` field will be omitted from the resulting object. - `labels` (`obj`): Optional. Labels applied to the workload. **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field `effective_labels` for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object. - `location` (`string`): The location for the resource - `organization` (`string`): The organization for the resource - - `provisioned_resources_parent` (`string`): Input only. The parent resource for the resources managed by this Assured Workload. May be either an organization or a folder. Must be the same or a child of the Workload parent. If not specified all resources are created under the Workload parent. Formats: folders/{folder_id}, organizations/{organization_id} When `null`, the `provisioned_resources_parent` field will be omitted from the resulting object. - - `kms_settings` (`list[obj]`): Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. When `null`, the `kms_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.assured_workloads_workload.kms_settings.new](#fn-kms_settingsnew) constructor. + - `partner` (`string`): Optional. Partner regime associated with this workload. Possible values: PARTNER_UNSPECIFIED, LOCAL_CONTROLS_BY_S3NS, SOVEREIGN_CONTROLS_BY_T_SYSTEMS, SOVEREIGN_CONTROLS_BY_SIA_MINSAIT, SOVEREIGN_CONTROLS_BY_PSN When `null`, the `partner` field will be omitted from the resulting object. + - `provisioned_resources_parent` (`string`): Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} When `null`, the `provisioned_resources_parent` field will be omitted from the resulting object. + - `violation_notifications_enabled` (`bool`): Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload. When `null`, the `violation_notifications_enabled` field will be omitted from the resulting object. + - `kms_settings` (`list[obj]`): **DEPRECATED** Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field. When `null`, the `kms_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.assured_workloads_workload.kms_settings.new](#fn-kms_settingsnew) constructor. + - `partner_permissions` (`list[obj]`): Optional. Permissions granted to the AW Partner SA account for the customer workload When `null`, the `partner_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.assured_workloads_workload.partner_permissions.new](#fn-partner_permissionsnew) constructor. - `resource_settings` (`list[obj]`): Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. When `null`, the `resource_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.assured_workloads_workload.resource_settings.new](#fn-resource_settingsnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.assured_workloads_workload.timeouts.new](#fn-timeoutsnew) constructor. @@ -100,17 +111,21 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `billing_account` (`string`): Required. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, 'billingAccounts/012345-567890-ABCDEF`. - - `compliance_regime` (`string`): Required. Immutable. Compliance Regime associated with this workload. Possible values: COMPLIANCE_REGIME_UNSPECIFIED, IL4, CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, US_REGIONAL_ACCESS, HIPAA, EU_REGIONS_AND_SUPPORT, CA_REGIONS_AND_SUPPORT, ITAR, AU_REGIONS_AND_US_SUPPORT, ASSURED_WORKLOADS_FOR_PARTNERS + - `billing_account` (`string`): Optional. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. When `null`, the `billing_account` field will be omitted from the resulting object. + - `compliance_regime` (`string`): Required. Immutable. Compliance Regime associated with this workload. Possible values: COMPLIANCE_REGIME_UNSPECIFIED, IL4, CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, US_REGIONAL_ACCESS, HIPAA, HITRUST, EU_REGIONS_AND_SUPPORT, CA_REGIONS_AND_SUPPORT, ITAR, AU_REGIONS_AND_US_SUPPORT, ASSURED_WORKLOADS_FOR_PARTNERS, ISR_REGIONS, ISR_REGIONS_AND_SUPPORT, CA_PROTECTED_B, IL5, IL2, JP_REGIONS_AND_SUPPORT - `display_name` (`string`): Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload + - `enable_sovereign_controls` (`bool`): Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. When `null`, the `enable_sovereign_controls` field will be omitted from the resulting object. - `labels` (`obj`): Optional. Labels applied to the workload. **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field `effective_labels` for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object. - `location` (`string`): The location for the resource - `organization` (`string`): The organization for the resource - - `provisioned_resources_parent` (`string`): Input only. The parent resource for the resources managed by this Assured Workload. May be either an organization or a folder. Must be the same or a child of the Workload parent. If not specified all resources are created under the Workload parent. Formats: folders/{folder_id}, organizations/{organization_id} When `null`, the `provisioned_resources_parent` field will be omitted from the resulting object. - - `kms_settings` (`list[obj]`): Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. When `null`, the `kms_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.assured_workloads_workload.kms_settings.new](#fn-kms_settingsnew) constructor. + - `partner` (`string`): Optional. Partner regime associated with this workload. Possible values: PARTNER_UNSPECIFIED, LOCAL_CONTROLS_BY_S3NS, SOVEREIGN_CONTROLS_BY_T_SYSTEMS, SOVEREIGN_CONTROLS_BY_SIA_MINSAIT, SOVEREIGN_CONTROLS_BY_PSN When `null`, the `partner` field will be omitted from the resulting object. + - `provisioned_resources_parent` (`string`): Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} When `null`, the `provisioned_resources_parent` field will be omitted from the resulting object. + - `violation_notifications_enabled` (`bool`): Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload. When `null`, the `violation_notifications_enabled` field will be omitted from the resulting object. + - `kms_settings` (`list[obj]`): **DEPRECATED** Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field. When `null`, the `kms_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.assured_workloads_workload.kms_settings.new](#fn-kms_settingsnew) constructor. + - `partner_permissions` (`list[obj]`): Optional. Permissions granted to the AW Partner SA account for the customer workload When `null`, the `partner_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.assured_workloads_workload.partner_permissions.new](#fn-partner_permissionsnew) constructor. - `resource_settings` (`list[obj]`): Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. When `null`, the `resource_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.assured_workloads_workload.resource_settings.new](#fn-resource_settingsnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.assured_workloads_workload.timeouts.new](#fn-timeoutsnew) constructor. @@ -166,6 +181,22 @@ Terraform resource block to set or update the display_name field. - `value` (`string`): The value to set for the `display_name` field. +### fn withEnableSovereignControls + +```ts +withEnableSovereignControls() +``` + +`google.bool.withEnableSovereignControls` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the enable_sovereign_controls field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `enable_sovereign_controls` field. + + ### fn withKmsSettings ```ts @@ -251,6 +282,59 @@ Terraform resource block to set or update the organization field. - `value` (`string`): The value to set for the `organization` field. +### fn withPartner + +```ts +withPartner() +``` + +`google.string.withPartner` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the partner field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `partner` field. + + +### fn withPartnerPermissions + +```ts +withPartnerPermissions() +``` + +`google.list[obj].withPartnerPermissions` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the partner_permissions field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withPartnerPermissionsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `partner_permissions` field. + + +### fn withPartnerPermissionsMixin + +```ts +withPartnerPermissionsMixin() +``` + +`google.list[obj].withPartnerPermissionsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the partner_permissions field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withPartnerPermissions](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `partner_permissions` field. + + ### fn withProvisionedResourcesParent ```ts @@ -340,6 +424,22 @@ function. - `value` (`obj`): The value to set for the `timeouts` field. +### fn withViolationNotificationsEnabled + +```ts +withViolationNotificationsEnabled() +``` + +`google.bool.withViolationNotificationsEnabled` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the violation_notifications_enabled field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `violation_notifications_enabled` field. + + ## obj kms_settings @@ -364,6 +464,31 @@ Terraform sub block. - An attribute object that represents the `kms_settings` sub block. +## obj partner_permissions + + + +### fn partner_permissions.new + +```ts +new() +``` + + +`google.assured_workloads_workload.partner_permissions.new` constructs a new object with attributes and blocks configured for the `partner_permissions` +Terraform sub block. + + + +**Args**: + - `assured_workloads_monitoring` (`bool`): Optional. Allow partner to view violation alerts. When `null`, the `assured_workloads_monitoring` field will be omitted from the resulting object. + - `data_logs_viewer` (`bool`): Allow the partner to view inspectability logs and monitoring violations. When `null`, the `data_logs_viewer` field will be omitted from the resulting object. + - `service_access_approver` (`bool`): Optional. Allow partner to view access approval logs. When `null`, the `service_access_approver` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `partner_permissions` sub block. + + ## obj resource_settings @@ -381,7 +506,8 @@ Terraform sub block. **Args**: - - `resource_id` (`string`): Resource identifier. For a project this represents project_number. If the project is already taken, the workload creation will fail. When `null`, the `resource_id` field will be omitted from the resulting object. + - `display_name` (`string`): User-assigned resource display name. If not empty it will be used to create a resource with the specified name. When `null`, the `display_name` field will be omitted from the resulting object. + - `resource_id` (`string`): Resource identifier. For a project this represents projectId. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google. When `null`, the `resource_id` field will be omitted from the resulting object. - `resource_type` (`string`): Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT) Possible values: RESOURCE_TYPE_UNSPECIFIED, CONSUMER_PROJECT, ENCRYPTION_KEYS_PROJECT, KEYRING, CONSUMER_FOLDER When `null`, the `resource_type` field will be omitted from the resulting object. **Returns**: diff --git a/docs/4.x/composer_environment.md b/docs/4.x/composer_environment.md index 7bc92075..143bbada 100644 --- a/docs/4.x/composer_environment.md +++ b/docs/4.x/composer_environment.md @@ -21,6 +21,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withName()`](#fn-withname) * [`fn withProject()`](#fn-withproject) * [`fn withRegion()`](#fn-withregion) +* [`fn withStorageConfig()`](#fn-withstorageconfig) +* [`fn withStorageConfigMixin()`](#fn-withstorageconfigmixin) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj config`](#obj-config) @@ -61,6 +63,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-configworkloads_configweb_servernew) * [`obj config.workloads_config.worker`](#obj-configworkloads_configworker) * [`fn new()`](#fn-configworkloads_configworkernew) +* [`obj storage_config`](#obj-storage_config) + * [`fn new()`](#fn-storage_confignew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) @@ -94,13 +98,14 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - `labels` (`obj`): User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. - + **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object. - `name` (`string`): Name of the environment. - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object. - `region` (`string`): The location or Compute Engine region for the environment. When `null`, the `region` field will be omitted from the resulting object. - `config` (`list[obj]`): Configuration parameters for this environment. 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.composer_environment.config.new](#fn-confignew) constructor. + - `storage_config` (`list[obj]`): Configuration options for storage used by Composer environment. 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.composer_environment.storage_config.new](#fn-storage_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.composer_environment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -126,13 +131,14 @@ injecting into a complete block. **Args**: - `labels` (`obj`): User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. - + **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object. - `name` (`string`): Name of the environment. - `project` (`string`): The ID of the project in which the resource belongs. If it is not provided, the provider project is used. When `null`, the `project` field will be omitted from the resulting object. - `region` (`string`): The location or Compute Engine region for the environment. When `null`, the `region` field will be omitted from the resulting object. - `config` (`list[obj]`): Configuration parameters for this environment. 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.composer_environment.config.new](#fn-confignew) constructor. + - `storage_config` (`list[obj]`): Configuration options for storage used by Composer environment. 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.composer_environment.storage_config.new](#fn-storage_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.composer_environment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -240,6 +246,43 @@ Terraform resource block to set or update the region field. - `value` (`string`): The value to set for the `region` field. +### fn withStorageConfig + +```ts +withStorageConfig() +``` + +`google.list[obj].withStorageConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the storage_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withStorageConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `storage_config` field. + + +### fn withStorageConfigMixin + +```ts +withStorageConfigMixin() +``` + +`google.list[obj].withStorageConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the storage_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withStorageConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `storage_config` field. + + ### fn withTimeouts ```ts @@ -769,6 +812,29 @@ Terraform sub block. - An attribute object that represents the `worker` sub block. +## obj storage_config + + + +### fn storage_config.new + +```ts +new() +``` + + +`google.composer_environment.storage_config.new` constructs a new object with attributes and blocks configured for the `storage_config` +Terraform sub block. + + + +**Args**: + - `bucket` (`string`): Optional. Name of an existing Cloud Storage bucket to be used by the environment. + +**Returns**: + - An attribute object that represents the `storage_config` sub block. + + ## obj timeouts diff --git a/docs/4.x/compute_backend_service.md b/docs/4.x/compute_backend_service.md index f57393ab..bd0d1681 100644 --- a/docs/4.x/compute_backend_service.md +++ b/docs/4.x/compute_backend_service.md @@ -250,8 +250,8 @@ validateForProxyless field set to true. When `null`, the `locality_lb_policies` - `log_config` (`list[obj]`): This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.log_config.new](#fn-log_confignew) constructor. - `outlier_detection` (`list[obj]`): Settings controlling eviction of unhealthy hosts from the load balancing pool. -This field is applicable only when the load_balancing_scheme is set -to INTERNAL_SELF_MANAGED. When `null`, the `outlier_detection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.outlier_detection.new](#fn-outlier_detectionnew) constructor. +Applicable backend service types can be a global backend service with the +loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. When `null`, the `outlier_detection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.outlier_detection.new](#fn-outlier_detectionnew) constructor. - `security_settings` (`list[obj]`): The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the @@ -409,8 +409,8 @@ validateForProxyless field set to true. When `null`, the `locality_lb_policies` - `log_config` (`list[obj]`): This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.log_config.new](#fn-log_confignew) constructor. - `outlier_detection` (`list[obj]`): Settings controlling eviction of unhealthy hosts from the load balancing pool. -This field is applicable only when the load_balancing_scheme is set -to INTERNAL_SELF_MANAGED. When `null`, the `outlier_detection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.outlier_detection.new](#fn-outlier_detectionnew) constructor. +Applicable backend service types can be a global backend service with the +loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. When `null`, the `outlier_detection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.compute_backend_service.outlier_detection.new](#fn-outlier_detectionnew) constructor. - `security_settings` (`list[obj]`): The security settings that apply to this backend service. This field is applicable to either a regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED; or a global backend service with the diff --git a/docs/4.x/container_aws_cluster.md b/docs/4.x/container_aws_cluster.md index d61cd202..683a648c 100644 --- a/docs/4.x/container_aws_cluster.md +++ b/docs/4.x/container_aws_cluster.md @@ -35,6 +35,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj authorization`](#obj-authorization) * [`fn new()`](#fn-authorizationnew) + * [`obj authorization.admin_groups`](#obj-authorizationadmin_groups) + * [`fn new()`](#fn-authorizationadmin_groupsnew) * [`obj authorization.admin_users`](#obj-authorizationadmin_users) * [`fn new()`](#fn-authorizationadmin_usersnew) * [`obj binary_authorization`](#obj-binary_authorization) @@ -483,12 +485,36 @@ Terraform sub block. **Args**: + - `admin_groups` (`list[obj]`): Groups of users that can perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the `cluster-admin` ClusterRole to the groups. Up to ten admin groups can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles When `null`, the `admin_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.container_aws_cluster.authorization.admin_groups.new](#fn-authorizationadmin_groupsnew) constructor. - `admin_users` (`list[obj]`): Users to perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the `cluster-admin` ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles 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.container_aws_cluster.authorization.admin_users.new](#fn-authorizationadmin_usersnew) constructor. **Returns**: - An attribute object that represents the `authorization` sub block. +## obj authorization.admin_groups + + + +### fn authorization.admin_groups.new + +```ts +new() +``` + + +`google.container_aws_cluster.authorization.admin_groups.new` constructs a new object with attributes and blocks configured for the `admin_groups` +Terraform sub block. + + + +**Args**: + - `group` (`string`): The name of the group, e.g. `my-group@domain.com`. + +**Returns**: + - An attribute object that represents the `admin_groups` sub block. + + ## obj authorization.admin_users @@ -660,7 +686,7 @@ Terraform sub block. - `iops` (`number`): Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume. When `null`, the `iops` field will be omitted from the resulting object. - `kms_key_arn` (`string`): Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used. When `null`, the `kms_key_arn` field will be omitted from the resulting object. - `size_gib` (`number`): Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource. When `null`, the `size_gib` field will be omitted from the resulting object. - - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. When `null`, the `throughput` field will be omitted from the resulting object. + - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. If volume type is gp3 and throughput is not specified, the throughput will defaults to 125. When `null`, the `throughput` field will be omitted from the resulting object. - `volume_type` (`string`): Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3 When `null`, the `volume_type` field will be omitted from the resulting object. **Returns**: @@ -711,7 +737,7 @@ Terraform sub block. - `iops` (`number`): Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume. When `null`, the `iops` field will be omitted from the resulting object. - `kms_key_arn` (`string`): Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used. When `null`, the `kms_key_arn` field will be omitted from the resulting object. - `size_gib` (`number`): Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource. When `null`, the `size_gib` field will be omitted from the resulting object. - - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. When `null`, the `throughput` field will be omitted from the resulting object. + - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. If volume type is gp3 and throughput is not specified, the throughput will defaults to 125. When `null`, the `throughput` field will be omitted from the resulting object. - `volume_type` (`string`): Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3 When `null`, the `volume_type` field will be omitted from the resulting object. **Returns**: diff --git a/docs/4.x/container_aws_node_pool.md b/docs/4.x/container_aws_node_pool.md index f09bc822..8bcf2632 100644 --- a/docs/4.x/container_aws_node_pool.md +++ b/docs/4.x/container_aws_node_pool.md @@ -586,7 +586,7 @@ Terraform sub block. - `iops` (`number`): Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume. When `null`, the `iops` field will be omitted from the resulting object. - `kms_key_arn` (`string`): Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used. When `null`, the `kms_key_arn` field will be omitted from the resulting object. - `size_gib` (`number`): Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource. When `null`, the `size_gib` field will be omitted from the resulting object. - - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. When `null`, the `throughput` field will be omitted from the resulting object. + - `throughput` (`number`): Optional. The throughput to provision for the volume, in MiB/s. Only valid if the volume type is GP3. If volume type is gp3 and throughput is not specified, the throughput will defaults to 125. When `null`, the `throughput` field will be omitted from the resulting object. - `volume_type` (`string`): Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3 When `null`, the `volume_type` field will be omitted from the resulting object. **Returns**: diff --git a/docs/4.x/container_azure_cluster.md b/docs/4.x/container_azure_cluster.md index c1a0e935..6cd3817a 100644 --- a/docs/4.x/container_azure_cluster.md +++ b/docs/4.x/container_azure_cluster.md @@ -37,6 +37,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj authorization`](#obj-authorization) * [`fn new()`](#fn-authorizationnew) + * [`obj authorization.admin_groups`](#obj-authorizationadmin_groups) + * [`fn new()`](#fn-authorizationadmin_groupsnew) * [`obj authorization.admin_users`](#obj-authorizationadmin_users) * [`fn new()`](#fn-authorizationadmin_usersnew) * [`obj azure_services_authentication`](#obj-azure_services_authentication) @@ -519,12 +521,36 @@ Terraform sub block. **Args**: + - `admin_groups` (`list[obj]`): Groups of users that can perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the `cluster-admin` ClusterRole to the groups. Up to ten admin groups can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles When `null`, the `admin_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.container_azure_cluster.authorization.admin_groups.new](#fn-authorizationadmin_groupsnew) constructor. - `admin_users` (`list[obj]`): Users that can perform operations as a cluster admin. A new ClusterRoleBinding will be created to grant the cluster-admin ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles 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.container_azure_cluster.authorization.admin_users.new](#fn-authorizationadmin_usersnew) constructor. **Returns**: - An attribute object that represents the `authorization` sub block. +## obj authorization.admin_groups + + + +### fn authorization.admin_groups.new + +```ts +new() +``` + + +`google.container_azure_cluster.authorization.admin_groups.new` constructs a new object with attributes and blocks configured for the `admin_groups` +Terraform sub block. + + + +**Args**: + - `group` (`string`): The name of the group, e.g. `my-group@domain.com`. + +**Returns**: + - An attribute object that represents the `admin_groups` sub block. + + ## obj authorization.admin_users diff --git a/docs/4.x/container_cluster.md b/docs/4.x/container_cluster.md index 5a613e3b..922c57e6 100644 --- a/docs/4.x/container_cluster.md +++ b/docs/4.x/container_cluster.md @@ -48,6 +48,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withEnableLegacyAbac()`](#fn-withenablelegacyabac) * [`fn withEnableShieldedNodes()`](#fn-withenableshieldednodes) * [`fn withEnableTpu()`](#fn-withenabletpu) +* [`fn withFleet()`](#fn-withfleet) +* [`fn withFleetMixin()`](#fn-withfleetmixin) * [`fn withGatewayApiConfig()`](#fn-withgatewayapiconfig) * [`fn withGatewayApiConfigMixin()`](#fn-withgatewayapiconfigmixin) * [`fn withIdentityServiceConfig()`](#fn-withidentityserviceconfig) @@ -163,6 +165,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-dns_confignew) * [`obj enable_k8s_beta_apis`](#obj-enable_k8s_beta_apis) * [`fn new()`](#fn-enable_k8s_beta_apisnew) +* [`obj fleet`](#obj-fleet) + * [`fn new()`](#fn-fleetnew) * [`obj gateway_api_config`](#obj-gateway_api_config) * [`fn new()`](#fn-gateway_api_confignew) * [`obj identity_service_config`](#obj-identity_service_config) @@ -391,6 +395,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `default_snat_status` (`list[obj]`): Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled. When `null`, the `default_snat_status` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.default_snat_status.new](#fn-default_snat_statusnew) constructor. - `dns_config` (`list[obj]`): Configuration for Cloud DNS for Kubernetes Engine. When `null`, the `dns_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.dns_config.new](#fn-dns_confignew) constructor. - `enable_k8s_beta_apis` (`list[obj]`): Configuration for Kubernetes Beta APIs. When `null`, the `enable_k8s_beta_apis` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.enable_k8s_beta_apis.new](#fn-enable_k8s_beta_apisnew) constructor. + - `fleet` (`list[obj]`): Fleet configuration of the cluster. When `null`, the `fleet` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.fleet.new](#fn-fleetnew) constructor. - `gateway_api_config` (`list[obj]`): Configuration for GKE Gateway API controller. When `null`, the `gateway_api_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.gateway_api_config.new](#fn-gateway_api_confignew) constructor. - `identity_service_config` (`list[obj]`): Configuration for Identity Service which allows customers to use external identity providers with the K8S API. When `null`, the `identity_service_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.identity_service_config.new](#fn-identity_service_confignew) constructor. - `ip_allocation_policy` (`list[obj]`): Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. When `null`, the `ip_allocation_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.ip_allocation_policy.new](#fn-ip_allocation_policynew) constructor. @@ -475,6 +480,7 @@ injecting into a complete block. - `default_snat_status` (`list[obj]`): Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled. When `null`, the `default_snat_status` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.default_snat_status.new](#fn-default_snat_statusnew) constructor. - `dns_config` (`list[obj]`): Configuration for Cloud DNS for Kubernetes Engine. When `null`, the `dns_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.dns_config.new](#fn-dns_confignew) constructor. - `enable_k8s_beta_apis` (`list[obj]`): Configuration for Kubernetes Beta APIs. When `null`, the `enable_k8s_beta_apis` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.enable_k8s_beta_apis.new](#fn-enable_k8s_beta_apisnew) constructor. + - `fleet` (`list[obj]`): Fleet configuration of the cluster. When `null`, the `fleet` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.fleet.new](#fn-fleetnew) constructor. - `gateway_api_config` (`list[obj]`): Configuration for GKE Gateway API controller. When `null`, the `gateway_api_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.gateway_api_config.new](#fn-gateway_api_confignew) constructor. - `identity_service_config` (`list[obj]`): Configuration for Identity Service which allows customers to use external identity providers with the K8S API. When `null`, the `identity_service_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.identity_service_config.new](#fn-identity_service_confignew) constructor. - `ip_allocation_policy` (`list[obj]`): Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. When `null`, the `ip_allocation_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.container_cluster.ip_allocation_policy.new](#fn-ip_allocation_policynew) constructor. @@ -1081,6 +1087,43 @@ Terraform resource block to set or update the enable_tpu field. - `value` (`bool`): The value to set for the `enable_tpu` field. +### fn withFleet + +```ts +withFleet() +``` + +`google.list[obj].withFleet` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the fleet field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withFleetMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `fleet` field. + + +### fn withFleetMixin + +```ts +withFleetMixin() +``` + +`google.list[obj].withFleetMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the fleet field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withFleet](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `fleet` field. + + ### fn withGatewayApiConfig ```ts @@ -2831,6 +2874,29 @@ Terraform sub block. - An attribute object that represents the `enable_k8s_beta_apis` sub block. +## obj fleet + + + +### fn fleet.new + +```ts +new() +``` + + +`google.container_cluster.fleet.new` constructs a new object with attributes and blocks configured for the `fleet` +Terraform sub block. + + + +**Args**: + - `project` (`string`): The Fleet host project of the cluster. When `null`, the `project` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `fleet` sub block. + + ## obj gateway_api_config diff --git a/docs/4.x/dialogflow_cx_flow.md b/docs/4.x/dialogflow_cx_flow.md index b940a700..e319a29f 100644 --- a/docs/4.x/dialogflow_cx_flow.md +++ b/docs/4.x/dialogflow_cx_flow.md @@ -21,6 +21,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withDisplayName()`](#fn-withdisplayname) * [`fn withEventHandlers()`](#fn-witheventhandlers) * [`fn withEventHandlersMixin()`](#fn-witheventhandlersmixin) +* [`fn withIsDefaultStartFlow()`](#fn-withisdefaultstartflow) * [`fn withLanguageCode()`](#fn-withlanguagecode) * [`fn withNluSettings()`](#fn-withnlusettings) * [`fn withNluSettingsMixin()`](#fn-withnlusettingsmixin) @@ -116,6 +117,10 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `description` (`string`): The description of the flow. 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 human-readable name of the flow. + - `is_default_start_flow` (`bool`): Marks this as the [Default Start Flow](https://cloud.google.com/dialogflow/cx/docs/concept/flow#start) for an agent. When you create an agent, the Default Start Flow is created automatically. +The Default Start Flow cannot be deleted; deleting the 'google_dialogflow_cx_flow' resource does nothing to the underlying GCP resources. + +~> Avoid having multiple 'google_dialogflow_cx_flow' resources linked to the same agent with 'is_default_start_flow = true' because they will compete to control a single Default Start Flow resource in GCP. When `null`, the `is_default_start_flow` field will be omitted from the resulting object. - `language_code` (`string`): The language of the following fields in flow: Flow.event_handlers.trigger_fulfillment.messages Flow.event_handlers.trigger_fulfillment.conditional_cases @@ -169,6 +174,10 @@ injecting into a complete block. **Args**: - `description` (`string`): The description of the flow. 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 human-readable name of the flow. + - `is_default_start_flow` (`bool`): Marks this as the [Default Start Flow](https://cloud.google.com/dialogflow/cx/docs/concept/flow#start) for an agent. When you create an agent, the Default Start Flow is created automatically. +The Default Start Flow cannot be deleted; deleting the 'google_dialogflow_cx_flow' resource does nothing to the underlying GCP resources. + +~> Avoid having multiple 'google_dialogflow_cx_flow' resources linked to the same agent with 'is_default_start_flow = true' because they will compete to control a single Default Start Flow resource in GCP. When `null`, the `is_default_start_flow` field will be omitted from the resulting object. - `language_code` (`string`): The language of the following fields in flow: Flow.event_handlers.trigger_fulfillment.messages Flow.event_handlers.trigger_fulfillment.conditional_cases @@ -308,6 +317,22 @@ function. - `value` (`list[obj]`): The value to set for the `event_handlers` field. +### fn withIsDefaultStartFlow + +```ts +withIsDefaultStartFlow() +``` + +`google.bool.withIsDefaultStartFlow` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the is_default_start_flow field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `is_default_start_flow` field. + + ### fn withLanguageCode ```ts diff --git a/docs/4.x/dialogflow_cx_intent.md b/docs/4.x/dialogflow_cx_intent.md index 050a59a7..449065bf 100644 --- a/docs/4.x/dialogflow_cx_intent.md +++ b/docs/4.x/dialogflow_cx_intent.md @@ -17,6 +17,8 @@ This package contains functions and utilities for setting up the resource using * [`fn newAttrs()`](#fn-newattrs) * [`fn withDescription()`](#fn-withdescription) * [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withIsDefaultNegativeIntent()`](#fn-withisdefaultnegativeintent) +* [`fn withIsDefaultWelcomeIntent()`](#fn-withisdefaultwelcomeintent) * [`fn withIsFallback()`](#fn-withisfallback) * [`fn withLabels()`](#fn-withlabels) * [`fn withLanguageCode()`](#fn-withlanguagecode) @@ -68,8 +70,17 @@ 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 for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. When `null`, the `description` field will be omitted from the resulting object. - `display_name` (`string`): The human-readable name of the intent, unique within the agent. + - `is_default_negative_intent` (`bool`): Marks this as the [Default Negative Intent](https://cloud.google.com/dialogflow/cx/docs/concept/intent#negative) for an agent. When you create an agent, a Default Negative Intent is created automatically. +The Default Negative Intent cannot be deleted; deleting the 'google_dialogflow_cx_intent' resource does nothing to the underlying GCP resources. + +~> Avoid having multiple 'google_dialogflow_cx_intent' resources linked to the same agent with 'is_default_negative_intent = true' because they will compete to control a single Default Negative Intent resource in GCP. When `null`, the `is_default_negative_intent` field will be omitted from the resulting object. + - `is_default_welcome_intent` (`bool`): Marks this as the [Default Welcome Intent](https://cloud.google.com/dialogflow/cx/docs/concept/intent#welcome) for an agent. When you create an agent, a Default Welcome Intent is created automatically. +The Default Welcome Intent cannot be deleted; deleting the 'google_dialogflow_cx_intent' resource does nothing to the underlying GCP resources. + +~> Avoid having multiple 'google_dialogflow_cx_intent' resources linked to the same agent with 'is_default_welcome_intent = true' because they will compete to control a single Default Welcome Intent resource in GCP. When `null`, the `is_default_welcome_intent` field will be omitted from the resulting object. - `is_fallback` (`bool`): Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. -Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. When `null`, the `is_fallback` field will be omitted from the resulting object. +Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. +To manage the fallback intent, set 'is_default_negative_intent = true' When `null`, the `is_fallback` field will be omitted from the resulting object. - `labels` (`obj`): The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. @@ -113,8 +124,17 @@ injecting into a complete block. **Args**: - `description` (`string`): Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. When `null`, the `description` field will be omitted from the resulting object. - `display_name` (`string`): The human-readable name of the intent, unique within the agent. + - `is_default_negative_intent` (`bool`): Marks this as the [Default Negative Intent](https://cloud.google.com/dialogflow/cx/docs/concept/intent#negative) for an agent. When you create an agent, a Default Negative Intent is created automatically. +The Default Negative Intent cannot be deleted; deleting the 'google_dialogflow_cx_intent' resource does nothing to the underlying GCP resources. + +~> Avoid having multiple 'google_dialogflow_cx_intent' resources linked to the same agent with 'is_default_negative_intent = true' because they will compete to control a single Default Negative Intent resource in GCP. When `null`, the `is_default_negative_intent` field will be omitted from the resulting object. + - `is_default_welcome_intent` (`bool`): Marks this as the [Default Welcome Intent](https://cloud.google.com/dialogflow/cx/docs/concept/intent#welcome) for an agent. When you create an agent, a Default Welcome Intent is created automatically. +The Default Welcome Intent cannot be deleted; deleting the 'google_dialogflow_cx_intent' resource does nothing to the underlying GCP resources. + +~> Avoid having multiple 'google_dialogflow_cx_intent' resources linked to the same agent with 'is_default_welcome_intent = true' because they will compete to control a single Default Welcome Intent resource in GCP. When `null`, the `is_default_welcome_intent` field will be omitted from the resulting object. - `is_fallback` (`bool`): Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. -Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. When `null`, the `is_fallback` field will be omitted from the resulting object. +Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. +To manage the fallback intent, set 'is_default_negative_intent = true' When `null`, the `is_fallback` field will be omitted from the resulting object. - `labels` (`obj`): The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. @@ -170,6 +190,38 @@ Terraform resource block to set or update the display_name field. - `value` (`string`): The value to set for the `display_name` field. +### fn withIsDefaultNegativeIntent + +```ts +withIsDefaultNegativeIntent() +``` + +`google.bool.withIsDefaultNegativeIntent` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the is_default_negative_intent field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `is_default_negative_intent` field. + + +### fn withIsDefaultWelcomeIntent + +```ts +withIsDefaultWelcomeIntent() +``` + +`google.bool.withIsDefaultWelcomeIntent` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the is_default_welcome_intent field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `is_default_welcome_intent` field. + + ### fn withIsFallback ```ts diff --git a/docs/4.x/gke_hub_feature.md b/docs/4.x/gke_hub_feature.md index b9e798b2..9a78291d 100644 --- a/docs/4.x/gke_hub_feature.md +++ b/docs/4.x/gke_hub_feature.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 withFleetDefaultMemberConfig()`](#fn-withfleetdefaultmemberconfig) +* [`fn withFleetDefaultMemberConfigMixin()`](#fn-withfleetdefaultmemberconfigmixin) * [`fn withLabels()`](#fn-withlabels) * [`fn withLocation()`](#fn-withlocation) * [`fn withName()`](#fn-withname) @@ -23,6 +25,18 @@ This package contains functions and utilities for setting up the resource using * [`fn withSpecMixin()`](#fn-withspecmixin) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj fleet_default_member_config`](#obj-fleet_default_member_config) + * [`fn new()`](#fn-fleet_default_member_confignew) + * [`obj fleet_default_member_config.configmanagement`](#obj-fleet_default_member_configconfigmanagement) + * [`fn new()`](#fn-fleet_default_member_configconfigmanagementnew) + * [`obj fleet_default_member_config.configmanagement.config_sync`](#obj-fleet_default_member_configconfigmanagementconfig_sync) + * [`fn new()`](#fn-fleet_default_member_configconfigmanagementconfig_syncnew) + * [`obj fleet_default_member_config.configmanagement.config_sync.git`](#obj-fleet_default_member_configconfigmanagementconfig_syncgit) + * [`fn new()`](#fn-fleet_default_member_configconfigmanagementconfig_syncgitnew) + * [`obj fleet_default_member_config.configmanagement.config_sync.oci`](#obj-fleet_default_member_configconfigmanagementconfig_syncoci) + * [`fn new()`](#fn-fleet_default_member_configconfigmanagementconfig_syncocinew) + * [`obj fleet_default_member_config.mesh`](#obj-fleet_default_member_configmesh) + * [`fn new()`](#fn-fleet_default_member_configmeshnew) * [`obj spec`](#obj-spec) * [`fn new()`](#fn-specnew) * [`obj spec.fleetobservability`](#obj-specfleetobservability) @@ -74,6 +88,7 @@ Please refer to the field 'effective_labels' for all of the labels prese - `location` (`string`): The location for the resource - `name` (`string`): The full, unique name of this Feature resource When `null`, the `name` 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. + - `fleet_default_member_config` (`list[obj]`): Optional. Fleet Default Membership Configuration. When `null`, the `fleet_default_member_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.new](#fn-fleet_default_member_confignew) constructor. - `spec` (`list[obj]`): Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. When `null`, the `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.gke_hub_feature.spec.new](#fn-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.gke_hub_feature.timeouts.new](#fn-timeoutsnew) constructor. @@ -106,6 +121,7 @@ Please refer to the field 'effective_labels' for all of the labels prese - `location` (`string`): The location for the resource - `name` (`string`): The full, unique name of this Feature resource When `null`, the `name` 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. + - `fleet_default_member_config` (`list[obj]`): Optional. Fleet Default Membership Configuration. When `null`, the `fleet_default_member_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.new](#fn-fleet_default_member_confignew) constructor. - `spec` (`list[obj]`): Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. When `null`, the `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.gke_hub_feature.spec.new](#fn-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.gke_hub_feature.timeouts.new](#fn-timeoutsnew) constructor. @@ -113,6 +129,43 @@ Please refer to the field 'effective_labels' for all of the labels prese - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `gke_hub_feature` resource into the root Terraform configuration. +### fn withFleetDefaultMemberConfig + +```ts +withFleetDefaultMemberConfig() +``` + +`google.list[obj].withFleetDefaultMemberConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the fleet_default_member_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withFleetDefaultMemberConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `fleet_default_member_config` field. + + +### fn withFleetDefaultMemberConfigMixin + +```ts +withFleetDefaultMemberConfigMixin() +``` + +`google.list[obj].withFleetDefaultMemberConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the fleet_default_member_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withFleetDefaultMemberConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `fleet_default_member_config` field. + + ### fn withLabels ```ts @@ -250,6 +303,159 @@ function. - `value` (`obj`): The value to set for the `timeouts` field. +## obj fleet_default_member_config + + + +### fn fleet_default_member_config.new + +```ts +new() +``` + + +`google.gke_hub_feature.fleet_default_member_config.new` constructs a new object with attributes and blocks configured for the `fleet_default_member_config` +Terraform sub block. + + + +**Args**: + - `configmanagement` (`list[obj]`): Config Management spec When `null`, the `configmanagement` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.configmanagement.new](#fn-fleet_default_member_configconfigmanagementnew) constructor. + - `mesh` (`list[obj]`): Service Mesh spec When `null`, the `mesh` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.mesh.new](#fn-fleet_default_member_configmeshnew) constructor. + +**Returns**: + - An attribute object that represents the `fleet_default_member_config` sub block. + + +## obj fleet_default_member_config.configmanagement + + + +### fn fleet_default_member_config.configmanagement.new + +```ts +new() +``` + + +`google.gke_hub_feature.fleet_default_member_config.configmanagement.new` constructs a new object with attributes and blocks configured for the `configmanagement` +Terraform sub block. + + + +**Args**: + - `config_sync` (`list[obj]`): ConfigSync configuration for the cluster When `null`, the `config_sync` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.new](#fn-fleet_default_member_configfleet_default_member_configconfig_syncnew) constructor. + +**Returns**: + - An attribute object that represents the `configmanagement` sub block. + + +## obj fleet_default_member_config.configmanagement.config_sync + + + +### fn fleet_default_member_config.configmanagement.config_sync.new + +```ts +new() +``` + + +`google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.new` constructs a new object with attributes and blocks configured for the `config_sync` +Terraform sub block. + + + +**Args**: + - `source_format` (`string`): Specifies whether the Config Sync Repo is in hierarchical or unstructured mode When `null`, the `source_format` field will be omitted from the resulting object. + - `git` (`list[obj]`): Git repo configuration for the cluster When `null`, the `git` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.git.new](#fn-fleet_default_member_configfleet_default_member_configconfigmanagementgitnew) constructor. + - `oci` (`list[obj]`): OCI repo configuration for the cluster When `null`, the `oci` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.oci.new](#fn-fleet_default_member_configfleet_default_member_configconfigmanagementocinew) constructor. + +**Returns**: + - An attribute object that represents the `config_sync` sub block. + + +## obj fleet_default_member_config.configmanagement.config_sync.git + + + +### fn fleet_default_member_config.configmanagement.config_sync.git.new + +```ts +new() +``` + + +`google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.git.new` constructs a new object with attributes and blocks configured for the `git` +Terraform sub block. + + + +**Args**: + - `gcp_service_account_email` (`string`): The Google Cloud Service Account Email used for auth when secretType is gcpServiceAccount When `null`, the `gcp_service_account_email` field will be omitted from the resulting object. + - `https_proxy` (`string`): URL for the HTTPS Proxy to be used when communicating with the Git repo When `null`, the `https_proxy` field will be omitted from the resulting object. + - `policy_dir` (`string`): The path within the Git repository that represents the top level of the repo to sync When `null`, the `policy_dir` field will be omitted from the resulting object. + - `secret_type` (`string`): Type of secret configured for access to the Git repo + - `sync_branch` (`string`): The branch of the repository to sync from. Default: master When `null`, the `sync_branch` field will be omitted from the resulting object. + - `sync_repo` (`string`): The URL of the Git repository to use as the source of truth When `null`, the `sync_repo` field will be omitted from the resulting object. + - `sync_rev` (`string`): Git revision (tag or hash) to check out. Default HEAD When `null`, the `sync_rev` field will be omitted from the resulting object. + - `sync_wait_secs` (`string`): Period in seconds between consecutive syncs. Default: 15 When `null`, the `sync_wait_secs` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `git` sub block. + + +## obj fleet_default_member_config.configmanagement.config_sync.oci + + + +### fn fleet_default_member_config.configmanagement.config_sync.oci.new + +```ts +new() +``` + + +`google.gke_hub_feature.fleet_default_member_config.configmanagement.config_sync.oci.new` constructs a new object with attributes and blocks configured for the `oci` +Terraform sub block. + + + +**Args**: + - `gcp_service_account_email` (`string`): The Google Cloud Service Account Email used for auth when secretType is gcpServiceAccount When `null`, the `gcp_service_account_email` field will be omitted from the resulting object. + - `policy_dir` (`string`): The absolute path of the directory that contains the local resources. Default: the root directory of the image When `null`, the `policy_dir` field will be omitted from the resulting object. + - `secret_type` (`string`): Type of secret configured for access to the Git repo + - `sync_repo` (`string`): The OCI image repository URL for the package to sync from When `null`, the `sync_repo` field will be omitted from the resulting object. + - `sync_wait_secs` (`string`): Period in seconds between consecutive syncs. Default: 15 When `null`, the `sync_wait_secs` field will be omitted from the resulting object. + - `version` (`string`): Version of ACM installed When `null`, the `version` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `oci` sub block. + + +## obj fleet_default_member_config.mesh + + + +### fn fleet_default_member_config.mesh.new + +```ts +new() +``` + + +`google.gke_hub_feature.fleet_default_member_config.mesh.new` constructs a new object with attributes and blocks configured for the `mesh` +Terraform sub block. + + + +**Args**: + - `management` (`string`): Whether to automatically manage Service Mesh Possible values: ["MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", "MANAGEMENT_MANUAL"] + +**Returns**: + - An attribute object that represents the `mesh` sub block. + + ## obj spec diff --git a/docs/4.x/gke_hub_feature_membership.md b/docs/4.x/gke_hub_feature_membership.md index 3385ddfd..1dc3772c 100644 --- a/docs/4.x/gke_hub_feature_membership.md +++ b/docs/4.x/gke_hub_feature_membership.md @@ -358,6 +358,7 @@ Terraform sub block. **Args**: + - `metrics_gcp_service_account_email` (`string`): The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring. The GSA should have the Monitoring Metric Writer(roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA. When `null`, the `metrics_gcp_service_account_email` field will be omitted from the resulting object. - `prevent_drift` (`bool`): Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. When `null`, the `prevent_drift` field will be omitted from the resulting object. - `source_format` (`string`): Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. When `null`, the `source_format` field will be omitted from the resulting object. - `git` (`list[obj]`): Set the `git` field on the resulting object. When `null`, the `git` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.gke_hub_feature_membership.configmanagement.config_sync.git.new](#fn-configmanagementconfigmanagementgitnew) constructor. diff --git a/docs/4.x/integration_connectors_connection.md b/docs/4.x/integration_connectors_connection.md new file mode 100644 index 00000000..f4e6e125 --- /dev/null +++ b/docs/4.x/integration_connectors_connection.md @@ -0,0 +1,1839 @@ +--- +permalink: /integration_connectors_connection/ +--- + +# integration_connectors_connection + +`integration_connectors_connection` represents the `google_integration_connectors_connection` 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 withAuthConfig()`](#fn-withauthconfig) +* [`fn withAuthConfigMixin()`](#fn-withauthconfigmixin) +* [`fn withConfigVariable()`](#fn-withconfigvariable) +* [`fn withConfigVariableMixin()`](#fn-withconfigvariablemixin) +* [`fn withConnectorVersion()`](#fn-withconnectorversion) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withDestinationConfig()`](#fn-withdestinationconfig) +* [`fn withDestinationConfigMixin()`](#fn-withdestinationconfigmixin) +* [`fn withEventingConfig()`](#fn-witheventingconfig) +* [`fn withEventingConfigMixin()`](#fn-witheventingconfigmixin) +* [`fn withEventingEnablementType()`](#fn-witheventingenablementtype) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withLockConfig()`](#fn-withlockconfig) +* [`fn withLockConfigMixin()`](#fn-withlockconfigmixin) +* [`fn withLogConfig()`](#fn-withlogconfig) +* [`fn withLogConfigMixin()`](#fn-withlogconfigmixin) +* [`fn withName()`](#fn-withname) +* [`fn withNodeConfig()`](#fn-withnodeconfig) +* [`fn withNodeConfigMixin()`](#fn-withnodeconfigmixin) +* [`fn withProject()`](#fn-withproject) +* [`fn withServiceAccount()`](#fn-withserviceaccount) +* [`fn withSslConfig()`](#fn-withsslconfig) +* [`fn withSslConfigMixin()`](#fn-withsslconfigmixin) +* [`fn withSuspended()`](#fn-withsuspended) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj auth_config`](#obj-auth_config) + * [`fn new()`](#fn-auth_confignew) + * [`obj auth_config.additional_variable`](#obj-auth_configadditional_variable) + * [`fn new()`](#fn-auth_configadditional_variablenew) + * [`obj auth_config.additional_variable.encryption_key_value`](#obj-auth_configadditional_variableencryption_key_value) + * [`fn new()`](#fn-auth_configadditional_variableencryption_key_valuenew) + * [`obj auth_config.additional_variable.secret_value`](#obj-auth_configadditional_variablesecret_value) + * [`fn new()`](#fn-auth_configadditional_variablesecret_valuenew) + * [`obj auth_config.oauth2_auth_code_flow`](#obj-auth_configoauth2_auth_code_flow) + * [`fn new()`](#fn-auth_configoauth2_auth_code_flownew) + * [`obj auth_config.oauth2_auth_code_flow.client_secret`](#obj-auth_configoauth2_auth_code_flowclient_secret) + * [`fn new()`](#fn-auth_configoauth2_auth_code_flowclient_secretnew) + * [`obj auth_config.oauth2_client_credentials`](#obj-auth_configoauth2_client_credentials) + * [`fn new()`](#fn-auth_configoauth2_client_credentialsnew) + * [`obj auth_config.oauth2_client_credentials.client_secret`](#obj-auth_configoauth2_client_credentialsclient_secret) + * [`fn new()`](#fn-auth_configoauth2_client_credentialsclient_secretnew) + * [`obj auth_config.oauth2_jwt_bearer`](#obj-auth_configoauth2_jwt_bearer) + * [`fn new()`](#fn-auth_configoauth2_jwt_bearernew) + * [`obj auth_config.oauth2_jwt_bearer.client_key`](#obj-auth_configoauth2_jwt_bearerclient_key) + * [`fn new()`](#fn-auth_configoauth2_jwt_bearerclient_keynew) + * [`obj auth_config.oauth2_jwt_bearer.jwt_claims`](#obj-auth_configoauth2_jwt_bearerjwt_claims) + * [`fn new()`](#fn-auth_configoauth2_jwt_bearerjwt_claimsnew) + * [`obj auth_config.ssh_public_key`](#obj-auth_configssh_public_key) + * [`fn new()`](#fn-auth_configssh_public_keynew) + * [`obj auth_config.ssh_public_key.ssh_client_cert`](#obj-auth_configssh_public_keyssh_client_cert) + * [`fn new()`](#fn-auth_configssh_public_keyssh_client_certnew) + * [`obj auth_config.ssh_public_key.ssh_client_cert_pass`](#obj-auth_configssh_public_keyssh_client_cert_pass) + * [`fn new()`](#fn-auth_configssh_public_keyssh_client_cert_passnew) + * [`obj auth_config.user_password`](#obj-auth_configuser_password) + * [`fn new()`](#fn-auth_configuser_passwordnew) + * [`obj auth_config.user_password.password`](#obj-auth_configuser_passwordpassword) + * [`fn new()`](#fn-auth_configuser_passwordpasswordnew) +* [`obj config_variable`](#obj-config_variable) + * [`fn new()`](#fn-config_variablenew) + * [`obj config_variable.encryption_key_value`](#obj-config_variableencryption_key_value) + * [`fn new()`](#fn-config_variableencryption_key_valuenew) + * [`obj config_variable.secret_value`](#obj-config_variablesecret_value) + * [`fn new()`](#fn-config_variablesecret_valuenew) +* [`obj destination_config`](#obj-destination_config) + * [`fn new()`](#fn-destination_confignew) + * [`obj destination_config.destination`](#obj-destination_configdestination) + * [`fn new()`](#fn-destination_configdestinationnew) +* [`obj eventing_config`](#obj-eventing_config) + * [`fn new()`](#fn-eventing_confignew) + * [`obj eventing_config.additional_variable`](#obj-eventing_configadditional_variable) + * [`fn new()`](#fn-eventing_configadditional_variablenew) + * [`obj eventing_config.additional_variable.encryption_key_value`](#obj-eventing_configadditional_variableencryption_key_value) + * [`fn new()`](#fn-eventing_configadditional_variableencryption_key_valuenew) + * [`obj eventing_config.additional_variable.secret_value`](#obj-eventing_configadditional_variablesecret_value) + * [`fn new()`](#fn-eventing_configadditional_variablesecret_valuenew) + * [`obj eventing_config.auth_config`](#obj-eventing_configauth_config) + * [`fn new()`](#fn-eventing_configauth_confignew) + * [`obj eventing_config.auth_config.additional_variable`](#obj-eventing_configauth_configadditional_variable) + * [`fn new()`](#fn-eventing_configauth_configadditional_variablenew) + * [`obj eventing_config.auth_config.additional_variable.encryption_key_value`](#obj-eventing_configauth_configadditional_variableencryption_key_value) + * [`fn new()`](#fn-eventing_configauth_configadditional_variableencryption_key_valuenew) + * [`obj eventing_config.auth_config.additional_variable.secret_value`](#obj-eventing_configauth_configadditional_variablesecret_value) + * [`fn new()`](#fn-eventing_configauth_configadditional_variablesecret_valuenew) + * [`obj eventing_config.auth_config.user_password`](#obj-eventing_configauth_configuser_password) + * [`fn new()`](#fn-eventing_configauth_configuser_passwordnew) + * [`obj eventing_config.auth_config.user_password.password`](#obj-eventing_configauth_configuser_passwordpassword) + * [`fn new()`](#fn-eventing_configauth_configuser_passwordpasswordnew) + * [`obj eventing_config.registration_destination_config`](#obj-eventing_configregistration_destination_config) + * [`fn new()`](#fn-eventing_configregistration_destination_confignew) + * [`obj eventing_config.registration_destination_config.destination`](#obj-eventing_configregistration_destination_configdestination) + * [`fn new()`](#fn-eventing_configregistration_destination_configdestinationnew) +* [`obj lock_config`](#obj-lock_config) + * [`fn new()`](#fn-lock_confignew) +* [`obj log_config`](#obj-log_config) + * [`fn new()`](#fn-log_confignew) +* [`obj node_config`](#obj-node_config) + * [`fn new()`](#fn-node_confignew) +* [`obj ssl_config`](#obj-ssl_config) + * [`fn new()`](#fn-ssl_confignew) + * [`obj ssl_config.additional_variable`](#obj-ssl_configadditional_variable) + * [`fn new()`](#fn-ssl_configadditional_variablenew) + * [`obj ssl_config.additional_variable.encryption_key_value`](#obj-ssl_configadditional_variableencryption_key_value) + * [`fn new()`](#fn-ssl_configadditional_variableencryption_key_valuenew) + * [`obj ssl_config.additional_variable.secret_value`](#obj-ssl_configadditional_variablesecret_value) + * [`fn new()`](#fn-ssl_configadditional_variablesecret_valuenew) + * [`obj ssl_config.client_certificate`](#obj-ssl_configclient_certificate) + * [`fn new()`](#fn-ssl_configclient_certificatenew) + * [`obj ssl_config.client_private_key`](#obj-ssl_configclient_private_key) + * [`fn new()`](#fn-ssl_configclient_private_keynew) + * [`obj ssl_config.client_private_key_pass`](#obj-ssl_configclient_private_key_pass) + * [`fn new()`](#fn-ssl_configclient_private_key_passnew) + * [`obj ssl_config.private_server_certificate`](#obj-ssl_configprivate_server_certificate) + * [`fn new()`](#fn-ssl_configprivate_server_certificatenew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.integration_connectors_connection.new` injects a new `google_integration_connectors_connection` 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.integration_connectors_connection.new('some_id') + +You can get the reference to the `id` field of the created `google.integration_connectors_connection` using the reference: + + $._ref.google_integration_connectors_connection.some_id.get('id') + +This is the same as directly entering `"${ google_integration_connectors_connection.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. + - `connector_version` (`string`): connectorVersion of the Connector. + - `description` (`string`): An arbitrary description for the Conection. When `null`, the `description` field will be omitted from the resulting object. + - `eventing_enablement_type` (`string`): Eventing enablement type. Will be nil if eventing is not enabled. Possible values: ["EVENTING_AND_CONNECTION", "ONLY_EVENTING"] When `null`, the `eventing_enablement_type` field will be omitted from the resulting object. + - `labels` (`obj`): Resource labels to represent user provided metadata. + + +**Note**: This field is non-authoritative, and will only manage the labels present in your configuration. +Please refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): Location in which Connection needs to be created. + - `name` (`string`): Name of Connection needs to be created. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `service_account` (`string`): Service account needed for runtime plane to access Google Cloud resources. When `null`, the `service_account` field will be omitted from the resulting object. + - `suspended` (`bool`): Suspended indicates if a user has suspended a connection or not. When `null`, the `suspended` field will be omitted from the resulting object. + - `auth_config` (`list[obj]`): authConfig for the connection. When `null`, the `auth_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.new](#fn-auth_confignew) constructor. + - `config_variable` (`list[obj]`): Config Variables for the connection. When `null`, the `config_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.config_variable.new](#fn-config_variablenew) constructor. + - `destination_config` (`list[obj]`): Define the Connectors target endpoint. When `null`, the `destination_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.destination_config.new](#fn-destination_confignew) constructor. + - `eventing_config` (`list[obj]`): Eventing Configuration of a connection When `null`, the `eventing_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.new](#fn-eventing_confignew) constructor. + - `lock_config` (`list[obj]`): Determines whether or no a connection is locked. If locked, a reason must be specified. When `null`, the `lock_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.lock_config.new](#fn-lock_confignew) constructor. + - `log_config` (`list[obj]`): Log configuration for the connection. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.log_config.new](#fn-log_confignew) constructor. + - `node_config` (`list[obj]`): Node configuration for the connection. When `null`, the `node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.node_config.new](#fn-node_confignew) constructor. + - `ssl_config` (`list[obj]`): SSL Configuration of a connection When `null`, the `ssl_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.new](#fn-ssl_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.integration_connectors_connection.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.integration_connectors_connection.newAttrs` constructs a new object with attributes and blocks configured for the `integration_connectors_connection` +Terraform resource. + +Unlike [google.integration_connectors_connection.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**: + - `connector_version` (`string`): connectorVersion of the Connector. + - `description` (`string`): An arbitrary description for the Conection. When `null`, the `description` field will be omitted from the resulting object. + - `eventing_enablement_type` (`string`): Eventing enablement type. Will be nil if eventing is not enabled. Possible values: ["EVENTING_AND_CONNECTION", "ONLY_EVENTING"] When `null`, the `eventing_enablement_type` field will be omitted from the resulting object. + - `labels` (`obj`): Resource labels to represent user provided metadata. + + +**Note**: This field is non-authoritative, and will only manage the labels present in your configuration. +Please refer to the field 'effective_labels' for all of the labels present on the resource. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): Location in which Connection needs to be created. + - `name` (`string`): Name of Connection needs to be created. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `service_account` (`string`): Service account needed for runtime plane to access Google Cloud resources. When `null`, the `service_account` field will be omitted from the resulting object. + - `suspended` (`bool`): Suspended indicates if a user has suspended a connection or not. When `null`, the `suspended` field will be omitted from the resulting object. + - `auth_config` (`list[obj]`): authConfig for the connection. When `null`, the `auth_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.new](#fn-auth_confignew) constructor. + - `config_variable` (`list[obj]`): Config Variables for the connection. When `null`, the `config_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.config_variable.new](#fn-config_variablenew) constructor. + - `destination_config` (`list[obj]`): Define the Connectors target endpoint. When `null`, the `destination_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.destination_config.new](#fn-destination_confignew) constructor. + - `eventing_config` (`list[obj]`): Eventing Configuration of a connection When `null`, the `eventing_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.new](#fn-eventing_confignew) constructor. + - `lock_config` (`list[obj]`): Determines whether or no a connection is locked. If locked, a reason must be specified. When `null`, the `lock_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.lock_config.new](#fn-lock_confignew) constructor. + - `log_config` (`list[obj]`): Log configuration for the connection. When `null`, the `log_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.log_config.new](#fn-log_confignew) constructor. + - `node_config` (`list[obj]`): Node configuration for the connection. When `null`, the `node_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.node_config.new](#fn-node_confignew) constructor. + - `ssl_config` (`list[obj]`): SSL Configuration of a connection When `null`, the `ssl_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.new](#fn-ssl_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.integration_connectors_connection.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 `integration_connectors_connection` resource into the root Terraform configuration. + + +### fn withAuthConfig + +```ts +withAuthConfig() +``` + +`google.list[obj].withAuthConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the auth_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withAuthConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `auth_config` field. + + +### fn withAuthConfigMixin + +```ts +withAuthConfigMixin() +``` + +`google.list[obj].withAuthConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the auth_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withAuthConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `auth_config` field. + + +### fn withConfigVariable + +```ts +withConfigVariable() +``` + +`google.list[obj].withConfigVariable` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the config_variable field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withConfigVariableMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `config_variable` field. + + +### fn withConfigVariableMixin + +```ts +withConfigVariableMixin() +``` + +`google.list[obj].withConfigVariableMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the config_variable field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withConfigVariable](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `config_variable` field. + + +### fn withConnectorVersion + +```ts +withConnectorVersion() +``` + +`google.string.withConnectorVersion` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the connector_version field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `connector_version` field. + + +### fn withDescription + +```ts +withDescription() +``` + +`google.string.withDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `description` field. + + +### fn withDestinationConfig + +```ts +withDestinationConfig() +``` + +`google.list[obj].withDestinationConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the destination_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withDestinationConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `destination_config` field. + + +### fn withDestinationConfigMixin + +```ts +withDestinationConfigMixin() +``` + +`google.list[obj].withDestinationConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the destination_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withDestinationConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `destination_config` field. + + +### fn withEventingConfig + +```ts +withEventingConfig() +``` + +`google.list[obj].withEventingConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the eventing_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withEventingConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `eventing_config` field. + + +### fn withEventingConfigMixin + +```ts +withEventingConfigMixin() +``` + +`google.list[obj].withEventingConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the eventing_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withEventingConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `eventing_config` field. + + +### fn withEventingEnablementType + +```ts +withEventingEnablementType() +``` + +`google.string.withEventingEnablementType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the eventing_enablement_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `eventing_enablement_type` field. + + +### fn withLabels + +```ts +withLabels() +``` + +`google.obj.withLabels` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the labels field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `labels` field. + + +### fn withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withLockConfig + +```ts +withLockConfig() +``` + +`google.list[obj].withLockConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the lock_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withLockConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `lock_config` field. + + +### fn withLockConfigMixin + +```ts +withLockConfigMixin() +``` + +`google.list[obj].withLockConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the lock_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withLockConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `lock_config` field. + + +### fn withLogConfig + +```ts +withLogConfig() +``` + +`google.list[obj].withLogConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the log_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withLogConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `log_config` field. + + +### fn withLogConfigMixin + +```ts +withLogConfigMixin() +``` + +`google.list[obj].withLogConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the log_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withLogConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `log_config` field. + + +### fn withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withNodeConfig + +```ts +withNodeConfig() +``` + +`google.list[obj].withNodeConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the node_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withNodeConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `node_config` field. + + +### fn withNodeConfigMixin + +```ts +withNodeConfigMixin() +``` + +`google.list[obj].withNodeConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the node_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withNodeConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `node_config` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withServiceAccount + +```ts +withServiceAccount() +``` + +`google.string.withServiceAccount` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the service_account field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `service_account` field. + + +### fn withSslConfig + +```ts +withSslConfig() +``` + +`google.list[obj].withSslConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the ssl_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withSslConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `ssl_config` field. + + +### fn withSslConfigMixin + +```ts +withSslConfigMixin() +``` + +`google.list[obj].withSslConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the ssl_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withSslConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `ssl_config` field. + + +### fn withSuspended + +```ts +withSuspended() +``` + +`google.bool.withSuspended` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the suspended field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `suspended` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj auth_config + + + +### fn auth_config.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.new` constructs a new object with attributes and blocks configured for the `auth_config` +Terraform sub block. + + + +**Args**: + - `auth_key` (`string`): The type of authentication configured. When `null`, the `auth_key` field will be omitted from the resulting object. + - `auth_type` (`string`): authType of the Connection Possible values: ["USER_PASSWORD", "OAUTH2_JWT_BEARER", "OAUTH2_CLIENT_CREDENTIALS", "SSH_PUBLIC_KEY", "OAUTH2_AUTH_CODE_FLOW"] + - `additional_variable` (`list[obj]`): List containing additional auth configs. When `null`, the `additional_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.additional_variable.new](#fn-auth_configadditional_variablenew) constructor. + - `oauth2_auth_code_flow` (`list[obj]`): Parameters to support Oauth 2.0 Auth Code Grant Authentication. When `null`, the `oauth2_auth_code_flow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.oauth2_auth_code_flow.new](#fn-auth_configoauth2_auth_code_flownew) constructor. + - `oauth2_client_credentials` (`list[obj]`): OAuth3 Client Credentials for Authentication. When `null`, the `oauth2_client_credentials` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.oauth2_client_credentials.new](#fn-auth_configoauth2_client_credentialsnew) constructor. + - `oauth2_jwt_bearer` (`list[obj]`): OAuth2 JWT Bearer for Authentication. When `null`, the `oauth2_jwt_bearer` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.oauth2_jwt_bearer.new](#fn-auth_configoauth2_jwt_bearernew) constructor. + - `ssh_public_key` (`list[obj]`): SSH Public Key for Authentication. When `null`, the `ssh_public_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.integration_connectors_connection.auth_config.ssh_public_key.new](#fn-auth_configssh_public_keynew) constructor. + - `user_password` (`list[obj]`): User password for Authentication. When `null`, the `user_password` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.user_password.new](#fn-auth_configuser_passwordnew) constructor. + +**Returns**: + - An attribute object that represents the `auth_config` sub block. + + +## obj auth_config.additional_variable + + + +### fn auth_config.additional_variable.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.additional_variable.new` constructs a new object with attributes and blocks configured for the `additional_variable` +Terraform sub block. + + + +**Args**: + - `boolean_value` (`bool`): Boolean Value of configVariable. When `null`, the `boolean_value` field will be omitted from the resulting object. + - `integer_value` (`number`): Integer Value of configVariable. When `null`, the `integer_value` field will be omitted from the resulting object. + - `key` (`string`): Key for the configVariable + - `string_value` (`string`): String Value of configVariabley. When `null`, the `string_value` field will be omitted from the resulting object. + - `encryption_key_value` (`list[obj]`): Encription key value of configVariable. When `null`, the `encryption_key_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.additional_variable.encryption_key_value.new](#fn-auth_configauth_configencryption_key_valuenew) constructor. + - `secret_value` (`list[obj]`): Secret value of configVariable. When `null`, the `secret_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.additional_variable.secret_value.new](#fn-auth_configauth_configsecret_valuenew) constructor. + +**Returns**: + - An attribute object that represents the `additional_variable` sub block. + + +## obj auth_config.additional_variable.encryption_key_value + + + +### fn auth_config.additional_variable.encryption_key_value.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.additional_variable.encryption_key_value.new` constructs a new object with attributes and blocks configured for the `encryption_key_value` +Terraform sub block. + + + +**Args**: + - `kms_key_name` (`string`): The [KMS key name] with which the content of the Operation is encrypted. The expected +format: projects/*/locations/*/keyRings/*/cryptoKeys/*. +Will be empty string if google managed. When `null`, the `kms_key_name` field will be omitted from the resulting object. + - `type` (`string`): Type of Encription Key Possible values: ["GOOGLE_MANAGED", "CUSTOMER_MANAGED"] + +**Returns**: + - An attribute object that represents the `encryption_key_value` sub block. + + +## obj auth_config.additional_variable.secret_value + + + +### fn auth_config.additional_variable.secret_value.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.additional_variable.secret_value.new` constructs a new object with attributes and blocks configured for the `secret_value` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): Secret version of Secret Value for Config variable. + +**Returns**: + - An attribute object that represents the `secret_value` sub block. + + +## obj auth_config.oauth2_auth_code_flow + + + +### fn auth_config.oauth2_auth_code_flow.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.oauth2_auth_code_flow.new` constructs a new object with attributes and blocks configured for the `oauth2_auth_code_flow` +Terraform sub block. + + + +**Args**: + - `auth_uri` (`string`): Auth URL for Authorization Code Flow. When `null`, the `auth_uri` field will be omitted from the resulting object. + - `client_id` (`string`): Client ID for user-provided OAuth app. When `null`, the `client_id` field will be omitted from the resulting object. + - `enable_pkce` (`bool`): Whether to enable PKCE when the user performs the auth code flow. When `null`, the `enable_pkce` field will be omitted from the resulting object. + - `scopes` (`list`): Scopes the connection will request when the user performs the auth code flow. When `null`, the `scopes` field will be omitted from the resulting object. + - `client_secret` (`list[obj]`): Client secret for user-provided OAuth app. When `null`, the `client_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.integration_connectors_connection.auth_config.oauth2_auth_code_flow.client_secret.new](#fn-auth_configauth_configclient_secretnew) constructor. + +**Returns**: + - An attribute object that represents the `oauth2_auth_code_flow` sub block. + + +## obj auth_config.oauth2_auth_code_flow.client_secret + + + +### fn auth_config.oauth2_auth_code_flow.client_secret.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.oauth2_auth_code_flow.client_secret.new` constructs a new object with attributes and blocks configured for the `client_secret` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): The resource name of the secret version in the format, +format as: projects/*/secrets/*/versions/*. + +**Returns**: + - An attribute object that represents the `client_secret` sub block. + + +## obj auth_config.oauth2_client_credentials + + + +### fn auth_config.oauth2_client_credentials.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.oauth2_client_credentials.new` constructs a new object with attributes and blocks configured for the `oauth2_client_credentials` +Terraform sub block. + + + +**Args**: + - `client_id` (`string`): Secret version of Password for Authentication. + - `client_secret` (`list[obj]`): Secret version reference containing the client secret. When `null`, the `client_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.integration_connectors_connection.auth_config.oauth2_client_credentials.client_secret.new](#fn-auth_configauth_configclient_secretnew) constructor. + +**Returns**: + - An attribute object that represents the `oauth2_client_credentials` sub block. + + +## obj auth_config.oauth2_client_credentials.client_secret + + + +### fn auth_config.oauth2_client_credentials.client_secret.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.oauth2_client_credentials.client_secret.new` constructs a new object with attributes and blocks configured for the `client_secret` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): The resource name of the secret version in the format, +format as: projects/*/secrets/*/versions/*. + +**Returns**: + - An attribute object that represents the `client_secret` sub block. + + +## obj auth_config.oauth2_jwt_bearer + + + +### fn auth_config.oauth2_jwt_bearer.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.oauth2_jwt_bearer.new` constructs a new object with attributes and blocks configured for the `oauth2_jwt_bearer` +Terraform sub block. + + + +**Args**: + - `client_key` (`list[obj]`): Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. +This private key will be used to sign JWTs used for the jwt-bearer authorization grant. +Specified in the form as: projects/*/secrets/*/versions/*. When `null`, the `client_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.integration_connectors_connection.auth_config.oauth2_jwt_bearer.client_key.new](#fn-auth_configauth_configclient_keynew) constructor. + - `jwt_claims` (`list[obj]`): JwtClaims providers fields to generate the token. When `null`, the `jwt_claims` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.oauth2_jwt_bearer.jwt_claims.new](#fn-auth_configauth_configjwt_claimsnew) constructor. + +**Returns**: + - An attribute object that represents the `oauth2_jwt_bearer` sub block. + + +## obj auth_config.oauth2_jwt_bearer.client_key + + + +### fn auth_config.oauth2_jwt_bearer.client_key.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.oauth2_jwt_bearer.client_key.new` constructs a new object with attributes and blocks configured for the `client_key` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): The resource name of the secret version in the format, +format as: projects/*/secrets/*/versions/*. + +**Returns**: + - An attribute object that represents the `client_key` sub block. + + +## obj auth_config.oauth2_jwt_bearer.jwt_claims + + + +### fn auth_config.oauth2_jwt_bearer.jwt_claims.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.oauth2_jwt_bearer.jwt_claims.new` constructs a new object with attributes and blocks configured for the `jwt_claims` +Terraform sub block. + + + +**Args**: + - `audience` (`string`): Value for the "aud" claim. When `null`, the `audience` field will be omitted from the resulting object. + - `issuer` (`string`): Value for the "iss" claim. When `null`, the `issuer` field will be omitted from the resulting object. + - `subject` (`string`): Value for the "sub" claim. When `null`, the `subject` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `jwt_claims` sub block. + + +## obj auth_config.ssh_public_key + + + +### fn auth_config.ssh_public_key.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.ssh_public_key.new` constructs a new object with attributes and blocks configured for the `ssh_public_key` +Terraform sub block. + + + +**Args**: + - `cert_type` (`string`): Format of SSH Client cert. When `null`, the `cert_type` field will be omitted from the resulting object. + - `username` (`string`): The user account used to authenticate. + - `ssh_client_cert` (`list[obj]`): SSH Client Cert. It should contain both public and private key. When `null`, the `ssh_client_cert` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.ssh_public_key.ssh_client_cert.new](#fn-auth_configauth_configssh_client_certnew) constructor. + - `ssh_client_cert_pass` (`list[obj]`): Password (passphrase) for ssh client certificate if it has one. When `null`, the `ssh_client_cert_pass` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.ssh_public_key.ssh_client_cert_pass.new](#fn-auth_configauth_configssh_client_cert_passnew) constructor. + +**Returns**: + - An attribute object that represents the `ssh_public_key` sub block. + + +## obj auth_config.ssh_public_key.ssh_client_cert + + + +### fn auth_config.ssh_public_key.ssh_client_cert.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.ssh_public_key.ssh_client_cert.new` constructs a new object with attributes and blocks configured for the `ssh_client_cert` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): The resource name of the secret version in the format, +format as: projects/*/secrets/*/versions/*. + +**Returns**: + - An attribute object that represents the `ssh_client_cert` sub block. + + +## obj auth_config.ssh_public_key.ssh_client_cert_pass + + + +### fn auth_config.ssh_public_key.ssh_client_cert_pass.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.ssh_public_key.ssh_client_cert_pass.new` constructs a new object with attributes and blocks configured for the `ssh_client_cert_pass` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): The resource name of the secret version in the format, +format as: projects/*/secrets/*/versions/*. + +**Returns**: + - An attribute object that represents the `ssh_client_cert_pass` sub block. + + +## obj auth_config.user_password + + + +### fn auth_config.user_password.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.user_password.new` constructs a new object with attributes and blocks configured for the `user_password` +Terraform sub block. + + + +**Args**: + - `username` (`string`): Username for Authentication. + - `password` (`list[obj]`): Password for Authentication. When `null`, the `password` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.auth_config.user_password.password.new](#fn-auth_configauth_configpasswordnew) constructor. + +**Returns**: + - An attribute object that represents the `user_password` sub block. + + +## obj auth_config.user_password.password + + + +### fn auth_config.user_password.password.new + +```ts +new() +``` + + +`google.integration_connectors_connection.auth_config.user_password.password.new` constructs a new object with attributes and blocks configured for the `password` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): The resource name of the secret version in the format, +format as: projects/*/secrets/*/versions/*. + +**Returns**: + - An attribute object that represents the `password` sub block. + + +## obj config_variable + + + +### fn config_variable.new + +```ts +new() +``` + + +`google.integration_connectors_connection.config_variable.new` constructs a new object with attributes and blocks configured for the `config_variable` +Terraform sub block. + + + +**Args**: + - `boolean_value` (`bool`): Boolean Value of configVariable When `null`, the `boolean_value` field will be omitted from the resulting object. + - `integer_value` (`number`): Integer Value of configVariable When `null`, the `integer_value` field will be omitted from the resulting object. + - `key` (`string`): Key for the configVariable + - `string_value` (`string`): String Value of configVariabley When `null`, the `string_value` field will be omitted from the resulting object. + - `encryption_key_value` (`list[obj]`): Encription key value of configVariable. When `null`, the `encryption_key_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.config_variable.encryption_key_value.new](#fn-config_variableencryption_key_valuenew) constructor. + - `secret_value` (`list[obj]`): Secret value of configVariable. When `null`, the `secret_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.config_variable.secret_value.new](#fn-config_variablesecret_valuenew) constructor. + +**Returns**: + - An attribute object that represents the `config_variable` sub block. + + +## obj config_variable.encryption_key_value + + + +### fn config_variable.encryption_key_value.new + +```ts +new() +``` + + +`google.integration_connectors_connection.config_variable.encryption_key_value.new` constructs a new object with attributes and blocks configured for the `encryption_key_value` +Terraform sub block. + + + +**Args**: + - `kms_key_name` (`string`): The [KMS key name] with which the content of the Operation is encrypted. The expected +format: projects/*/locations/*/keyRings/*/cryptoKeys/*. +Will be empty string if google managed. When `null`, the `kms_key_name` field will be omitted from the resulting object. + - `type` (`string`): Type of Encription Key Possible values: ["GOOGLE_MANAGED", "CUSTOMER_MANAGED"] + +**Returns**: + - An attribute object that represents the `encryption_key_value` sub block. + + +## obj config_variable.secret_value + + + +### fn config_variable.secret_value.new + +```ts +new() +``` + + +`google.integration_connectors_connection.config_variable.secret_value.new` constructs a new object with attributes and blocks configured for the `secret_value` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): Secret version of Secret Value for Config variable. + +**Returns**: + - An attribute object that represents the `secret_value` sub block. + + +## obj destination_config + + + +### fn destination_config.new + +```ts +new() +``` + + +`google.integration_connectors_connection.destination_config.new` constructs a new object with attributes and blocks configured for the `destination_config` +Terraform sub block. + + + +**Args**: + - `key` (`string`): The key is the destination identifier that is supported by the Connector. + - `destination` (`list[obj]`): The destinations for the key. When `null`, the `destination` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.destination_config.destination.new](#fn-destination_configdestinationnew) constructor. + +**Returns**: + - An attribute object that represents the `destination_config` sub block. + + +## obj destination_config.destination + + + +### fn destination_config.destination.new + +```ts +new() +``` + + +`google.integration_connectors_connection.destination_config.destination.new` constructs a new object with attributes and blocks configured for the `destination` +Terraform sub block. + + + +**Args**: + - `host` (`string`): For publicly routable host. When `null`, the `host` field will be omitted from the resulting object. + - `port` (`number`): The port is the target port number that is accepted by the destination. When `null`, the `port` field will be omitted from the resulting object. + - `service_attachment` (`string`): PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* When `null`, the `service_attachment` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `destination` sub block. + + +## obj eventing_config + + + +### fn eventing_config.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.new` constructs a new object with attributes and blocks configured for the `eventing_config` +Terraform sub block. + + + +**Args**: + - `enrichment_enabled` (`bool`): Enrichment Enabled. When `null`, the `enrichment_enabled` field will be omitted from the resulting object. + - `additional_variable` (`list[obj]`): List containing additional auth configs. When `null`, the `additional_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.additional_variable.new](#fn-eventing_configadditional_variablenew) constructor. + - `auth_config` (`list[obj]`): authConfig for Eventing Configuration. When `null`, the `auth_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.new](#fn-eventing_configauth_confignew) constructor. + - `registration_destination_config` (`list[obj]`): registrationDestinationConfig When `null`, the `registration_destination_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.registration_destination_config.new](#fn-eventing_configregistration_destination_confignew) constructor. + +**Returns**: + - An attribute object that represents the `eventing_config` sub block. + + +## obj eventing_config.additional_variable + + + +### fn eventing_config.additional_variable.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.additional_variable.new` constructs a new object with attributes and blocks configured for the `additional_variable` +Terraform sub block. + + + +**Args**: + - `boolean_value` (`bool`): Boolean Value of configVariable. When `null`, the `boolean_value` field will be omitted from the resulting object. + - `integer_value` (`number`): Integer Value of configVariable. When `null`, the `integer_value` field will be omitted from the resulting object. + - `key` (`string`): Key for the configVariable + - `string_value` (`string`): String Value of configVariabley. When `null`, the `string_value` field will be omitted from the resulting object. + - `encryption_key_value` (`list[obj]`): Encription key value of configVariable. When `null`, the `encryption_key_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.additional_variable.encryption_key_value.new](#fn-eventing_configeventing_configencryption_key_valuenew) constructor. + - `secret_value` (`list[obj]`): Secret value of configVariable When `null`, the `secret_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.additional_variable.secret_value.new](#fn-eventing_configeventing_configsecret_valuenew) constructor. + +**Returns**: + - An attribute object that represents the `additional_variable` sub block. + + +## obj eventing_config.additional_variable.encryption_key_value + + + +### fn eventing_config.additional_variable.encryption_key_value.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.additional_variable.encryption_key_value.new` constructs a new object with attributes and blocks configured for the `encryption_key_value` +Terraform sub block. + + + +**Args**: + - `kms_key_name` (`string`): The [KMS key name] with which the content of the Operation is encrypted. The expected +format: projects/*/locations/*/keyRings/*/cryptoKeys/*. +Will be empty string if google managed. When `null`, the `kms_key_name` field will be omitted from the resulting object. + - `type` (`string`): Type of Encryption Key Possible values: ["GOOGLE_MANAGED", "CUSTOMER_MANAGED"] When `null`, the `type` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `encryption_key_value` sub block. + + +## obj eventing_config.additional_variable.secret_value + + + +### fn eventing_config.additional_variable.secret_value.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.additional_variable.secret_value.new` constructs a new object with attributes and blocks configured for the `secret_value` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): Secret version of Secret Value for Config variable. + +**Returns**: + - An attribute object that represents the `secret_value` sub block. + + +## obj eventing_config.auth_config + + + +### fn eventing_config.auth_config.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.auth_config.new` constructs a new object with attributes and blocks configured for the `auth_config` +Terraform sub block. + + + +**Args**: + - `auth_key` (`string`): The type of authentication configured. When `null`, the `auth_key` field will be omitted from the resulting object. + - `auth_type` (`string`): authType of the Connection Possible values: ["USER_PASSWORD"] + - `additional_variable` (`list[obj]`): List containing additional auth configs. When `null`, the `additional_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.additional_variable.new](#fn-eventing_configeventing_configadditional_variablenew) constructor. + - `user_password` (`list[obj]`): User password for Authentication. When `null`, the `user_password` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.user_password.new](#fn-eventing_configeventing_configuser_passwordnew) constructor. + +**Returns**: + - An attribute object that represents the `auth_config` sub block. + + +## obj eventing_config.auth_config.additional_variable + + + +### fn eventing_config.auth_config.additional_variable.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.auth_config.additional_variable.new` constructs a new object with attributes and blocks configured for the `additional_variable` +Terraform sub block. + + + +**Args**: + - `boolean_value` (`bool`): Boolean Value of configVariable. When `null`, the `boolean_value` field will be omitted from the resulting object. + - `integer_value` (`number`): Integer Value of configVariable. When `null`, the `integer_value` field will be omitted from the resulting object. + - `key` (`string`): Key for the configVariable + - `string_value` (`string`): String Value of configVariabley. When `null`, the `string_value` field will be omitted from the resulting object. + - `encryption_key_value` (`list[obj]`): Encription key value of configVariable When `null`, the `encryption_key_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.additional_variable.encryption_key_value.new](#fn-eventing_configeventing_configauth_configencryption_key_valuenew) constructor. + - `secret_value` (`list[obj]`): Secret value of configVariable When `null`, the `secret_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.additional_variable.secret_value.new](#fn-eventing_configeventing_configauth_configsecret_valuenew) constructor. + +**Returns**: + - An attribute object that represents the `additional_variable` sub block. + + +## obj eventing_config.auth_config.additional_variable.encryption_key_value + + + +### fn eventing_config.auth_config.additional_variable.encryption_key_value.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.auth_config.additional_variable.encryption_key_value.new` constructs a new object with attributes and blocks configured for the `encryption_key_value` +Terraform sub block. + + + +**Args**: + - `kms_key_name` (`string`): The [KMS key name] with which the content of the Operation is encrypted. The expected +format: projects/*/locations/*/keyRings/*/cryptoKeys/*. +Will be empty string if google managed. When `null`, the `kms_key_name` field will be omitted from the resulting object. + - `type` (`string`): Type of Encription Key Possible values: ["GOOGLE_MANAGED", "CUSTOMER_MANAGED"] When `null`, the `type` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `encryption_key_value` sub block. + + +## obj eventing_config.auth_config.additional_variable.secret_value + + + +### fn eventing_config.auth_config.additional_variable.secret_value.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.auth_config.additional_variable.secret_value.new` constructs a new object with attributes and blocks configured for the `secret_value` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): Secret version of Secret Value for Config variable. + +**Returns**: + - An attribute object that represents the `secret_value` sub block. + + +## obj eventing_config.auth_config.user_password + + + +### fn eventing_config.auth_config.user_password.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.auth_config.user_password.new` constructs a new object with attributes and blocks configured for the `user_password` +Terraform sub block. + + + +**Args**: + - `username` (`string`): Username for Authentication. When `null`, the `username` field will be omitted from the resulting object. + - `password` (`list[obj]`): Password for Authentication. When `null`, the `password` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.auth_config.user_password.password.new](#fn-eventing_configeventing_configauth_configpasswordnew) constructor. + +**Returns**: + - An attribute object that represents the `user_password` sub block. + + +## obj eventing_config.auth_config.user_password.password + + + +### fn eventing_config.auth_config.user_password.password.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.auth_config.user_password.password.new` constructs a new object with attributes and blocks configured for the `password` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): The resource name of the secret version in the format, +format as: projects/*/secrets/*/versions/*. + +**Returns**: + - An attribute object that represents the `password` sub block. + + +## obj eventing_config.registration_destination_config + + + +### fn eventing_config.registration_destination_config.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.registration_destination_config.new` constructs a new object with attributes and blocks configured for the `registration_destination_config` +Terraform sub block. + + + +**Args**: + - `key` (`string`): Key for the connection When `null`, the `key` field will be omitted from the resulting object. + - `destination` (`list[obj]`): destinations for the connection When `null`, the `destination` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.eventing_config.registration_destination_config.destination.new](#fn-eventing_configeventing_configdestinationnew) constructor. + +**Returns**: + - An attribute object that represents the `registration_destination_config` sub block. + + +## obj eventing_config.registration_destination_config.destination + + + +### fn eventing_config.registration_destination_config.destination.new + +```ts +new() +``` + + +`google.integration_connectors_connection.eventing_config.registration_destination_config.destination.new` constructs a new object with attributes and blocks configured for the `destination` +Terraform sub block. + + + +**Args**: + - `host` (`string`): Host When `null`, the `host` field will be omitted from the resulting object. + - `port` (`number`): port number When `null`, the `port` field will be omitted from the resulting object. + - `service_attachment` (`string`): Service Attachment When `null`, the `service_attachment` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `destination` sub block. + + +## obj lock_config + + + +### fn lock_config.new + +```ts +new() +``` + + +`google.integration_connectors_connection.lock_config.new` constructs a new object with attributes and blocks configured for the `lock_config` +Terraform sub block. + + + +**Args**: + - `locked` (`bool`): Indicates whether or not the connection is locked. + - `reason` (`string`): Describes why a connection is locked. When `null`, the `reason` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `lock_config` sub block. + + +## obj log_config + + + +### fn log_config.new + +```ts +new() +``` + + +`google.integration_connectors_connection.log_config.new` constructs a new object with attributes and blocks configured for the `log_config` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Enabled represents whether logging is enabled or not for a connection. + +**Returns**: + - An attribute object that represents the `log_config` sub block. + + +## obj node_config + + + +### fn node_config.new + +```ts +new() +``` + + +`google.integration_connectors_connection.node_config.new` constructs a new object with attributes and blocks configured for the `node_config` +Terraform sub block. + + + +**Args**: + - `max_node_count` (`number`): Minimum number of nodes in the runtime nodes. When `null`, the `max_node_count` field will be omitted from the resulting object. + - `min_node_count` (`number`): Minimum number of nodes in the runtime nodes. When `null`, the `min_node_count` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `node_config` sub block. + + +## obj ssl_config + + + +### fn ssl_config.new + +```ts +new() +``` + + +`google.integration_connectors_connection.ssl_config.new` constructs a new object with attributes and blocks configured for the `ssl_config` +Terraform sub block. + + + +**Args**: + - `client_cert_type` (`string`): Type of Client Cert (PEM/JKS/.. etc.) Possible values: ["PEM"] When `null`, the `client_cert_type` field will be omitted from the resulting object. + - `server_cert_type` (`string`): Type of Server Cert (PEM/JKS/.. etc.) Possible values: ["PEM"] When `null`, the `server_cert_type` field will be omitted from the resulting object. + - `trust_model` (`string`): Enum for Trust Model Possible values: ["PUBLIC", "PRIVATE", "INSECURE"] When `null`, the `trust_model` field will be omitted from the resulting object. + - `type` (`string`): Enum for controlling the SSL Type (TLS/MTLS) Possible values: ["TLS", "MTLS"] + - `use_ssl` (`bool`): Bool for enabling SSL When `null`, the `use_ssl` field will be omitted from the resulting object. + - `additional_variable` (`list[obj]`): Additional SSL related field values. When `null`, the `additional_variable` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.additional_variable.new](#fn-ssl_configadditional_variablenew) constructor. + - `client_certificate` (`list[obj]`): Client Certificate 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.integration_connectors_connection.ssl_config.client_certificate.new](#fn-ssl_configclient_certificatenew) constructor. + - `client_private_key` (`list[obj]`): Client Private Key When `null`, the `client_private_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.integration_connectors_connection.ssl_config.client_private_key.new](#fn-ssl_configclient_private_keynew) constructor. + - `client_private_key_pass` (`list[obj]`): Secret containing the passphrase protecting the Client Private Key When `null`, the `client_private_key_pass` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.client_private_key_pass.new](#fn-ssl_configclient_private_key_passnew) constructor. + - `private_server_certificate` (`list[obj]`): Private Server Certificate. Needs to be specified if trust model is PRIVATE. When `null`, the `private_server_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.integration_connectors_connection.ssl_config.private_server_certificate.new](#fn-ssl_configprivate_server_certificatenew) constructor. + +**Returns**: + - An attribute object that represents the `ssl_config` sub block. + + +## obj ssl_config.additional_variable + + + +### fn ssl_config.additional_variable.new + +```ts +new() +``` + + +`google.integration_connectors_connection.ssl_config.additional_variable.new` constructs a new object with attributes and blocks configured for the `additional_variable` +Terraform sub block. + + + +**Args**: + - `boolean_value` (`bool`): Boolean Value of configVariable. When `null`, the `boolean_value` field will be omitted from the resulting object. + - `integer_value` (`number`): Integer Value of configVariable. When `null`, the `integer_value` field will be omitted from the resulting object. + - `key` (`string`): Key for the configVariable + - `string_value` (`string`): String Value of configVariabley. When `null`, the `string_value` field will be omitted from the resulting object. + - `encryption_key_value` (`list[obj]`): Encription key value of configVariable When `null`, the `encryption_key_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.additional_variable.encryption_key_value.new](#fn-ssl_configssl_configencryption_key_valuenew) constructor. + - `secret_value` (`list[obj]`): Secret value of configVariable When `null`, the `secret_value` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.integration_connectors_connection.ssl_config.additional_variable.secret_value.new](#fn-ssl_configssl_configsecret_valuenew) constructor. + +**Returns**: + - An attribute object that represents the `additional_variable` sub block. + + +## obj ssl_config.additional_variable.encryption_key_value + + + +### fn ssl_config.additional_variable.encryption_key_value.new + +```ts +new() +``` + + +`google.integration_connectors_connection.ssl_config.additional_variable.encryption_key_value.new` constructs a new object with attributes and blocks configured for the `encryption_key_value` +Terraform sub block. + + + +**Args**: + - `kms_key_name` (`string`): The [KMS key name] with which the content of the Operation is encrypted. The expected +format: projects/*/locations/*/keyRings/*/cryptoKeys/*. +Will be empty string if google managed. When `null`, the `kms_key_name` field will be omitted from the resulting object. + - `type` (`string`): Type of Encription Key Possible values: ["GOOGLE_MANAGED", "CUSTOMER_MANAGED"] When `null`, the `type` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `encryption_key_value` sub block. + + +## obj ssl_config.additional_variable.secret_value + + + +### fn ssl_config.additional_variable.secret_value.new + +```ts +new() +``` + + +`google.integration_connectors_connection.ssl_config.additional_variable.secret_value.new` constructs a new object with attributes and blocks configured for the `secret_value` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): Secret version of Secret Value for Config variable. + +**Returns**: + - An attribute object that represents the `secret_value` sub block. + + +## obj ssl_config.client_certificate + + + +### fn ssl_config.client_certificate.new + +```ts +new() +``` + + +`google.integration_connectors_connection.ssl_config.client_certificate.new` constructs a new object with attributes and blocks configured for the `client_certificate` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): Secret version of Secret Value for Config variable. + +**Returns**: + - An attribute object that represents the `client_certificate` sub block. + + +## obj ssl_config.client_private_key + + + +### fn ssl_config.client_private_key.new + +```ts +new() +``` + + +`google.integration_connectors_connection.ssl_config.client_private_key.new` constructs a new object with attributes and blocks configured for the `client_private_key` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): Secret version of Secret Value for Config variable. + +**Returns**: + - An attribute object that represents the `client_private_key` sub block. + + +## obj ssl_config.client_private_key_pass + + + +### fn ssl_config.client_private_key_pass.new + +```ts +new() +``` + + +`google.integration_connectors_connection.ssl_config.client_private_key_pass.new` constructs a new object with attributes and blocks configured for the `client_private_key_pass` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): Secret version of Secret Value for Config variable. + +**Returns**: + - An attribute object that represents the `client_private_key_pass` sub block. + + +## obj ssl_config.private_server_certificate + + + +### fn ssl_config.private_server_certificate.new + +```ts +new() +``` + + +`google.integration_connectors_connection.ssl_config.private_server_certificate.new` constructs a new object with attributes and blocks configured for the `private_server_certificate` +Terraform sub block. + + + +**Args**: + - `secret_version` (`string`): Secret version of Secret Value for Config variable. + +**Returns**: + - An attribute object that represents the `private_server_certificate` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.integration_connectors_connection.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/logging_billing_account_bucket_config.md b/docs/4.x/logging_billing_account_bucket_config.md index a09519b2..d21e8421 100644 --- a/docs/4.x/logging_billing_account_bucket_config.md +++ b/docs/4.x/logging_billing_account_bucket_config.md @@ -20,10 +20,14 @@ This package contains functions and utilities for setting up the resource using * [`fn withCmekSettings()`](#fn-withcmeksettings) * [`fn withCmekSettingsMixin()`](#fn-withcmeksettingsmixin) * [`fn withDescription()`](#fn-withdescription) +* [`fn withIndexConfigs()`](#fn-withindexconfigs) +* [`fn withIndexConfigsMixin()`](#fn-withindexconfigsmixin) * [`fn withLocation()`](#fn-withlocation) * [`fn withRetentionDays()`](#fn-withretentiondays) * [`obj cmek_settings`](#obj-cmek_settings) * [`fn new()`](#fn-cmek_settingsnew) +* [`obj index_configs`](#obj-index_configs) + * [`fn new()`](#fn-index_configsnew) ## Fields @@ -60,6 +64,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `location` (`string`): The location of the bucket. - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object. - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_billing_account_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor. + - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_billing_account_bucket_config.index_configs.new](#fn-index_configsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -89,6 +94,7 @@ injecting into a complete block. - `location` (`string`): The location of the bucket. - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object. - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_billing_account_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor. + - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_billing_account_bucket_config.index_configs.new](#fn-index_configsnew) 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 `logging_billing_account_bucket_config` resource into the root Terraform configuration. @@ -179,6 +185,43 @@ Terraform resource block to set or update the description field. - `value` (`string`): The value to set for the `description` field. +### fn withIndexConfigs + +```ts +withIndexConfigs() +``` + +`google.list[obj].withIndexConfigs` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the index_configs field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withIndexConfigsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `index_configs` field. + + +### fn withIndexConfigsMixin + +```ts +withIndexConfigsMixin() +``` + +`google.list[obj].withIndexConfigsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the index_configs field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withIndexConfigs](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `index_configs` field. + + ### fn withLocation ```ts @@ -237,3 +280,29 @@ See [Enabling CMEK for Logging Buckets](https://cloud.google.com/logging/docs/ro **Returns**: - An attribute object that represents the `cmek_settings` sub block. + + +## obj index_configs + + + +### fn index_configs.new + +```ts +new() +``` + + +`google.logging_billing_account_bucket_config.index_configs.new` constructs a new object with attributes and blocks configured for the `index_configs` +Terraform sub block. + + + +**Args**: + - `field_path` (`string`): The LogEntry field path to index. + - `type` (`string`): The type of data in this index +Note that some paths are automatically indexed, and other paths are not eligible for indexing. See [indexing documentation]( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details. +For example: jsonPayload.request.status + +**Returns**: + - An attribute object that represents the `index_configs` sub block. diff --git a/docs/4.x/logging_folder_bucket_config.md b/docs/4.x/logging_folder_bucket_config.md index 0e9fa3de..7a5b4ee3 100644 --- a/docs/4.x/logging_folder_bucket_config.md +++ b/docs/4.x/logging_folder_bucket_config.md @@ -20,10 +20,14 @@ This package contains functions and utilities for setting up the resource using * [`fn withCmekSettingsMixin()`](#fn-withcmeksettingsmixin) * [`fn withDescription()`](#fn-withdescription) * [`fn withFolder()`](#fn-withfolder) +* [`fn withIndexConfigs()`](#fn-withindexconfigs) +* [`fn withIndexConfigsMixin()`](#fn-withindexconfigsmixin) * [`fn withLocation()`](#fn-withlocation) * [`fn withRetentionDays()`](#fn-withretentiondays) * [`obj cmek_settings`](#obj-cmek_settings) * [`fn new()`](#fn-cmek_settingsnew) +* [`obj index_configs`](#obj-index_configs) + * [`fn new()`](#fn-index_configsnew) ## Fields @@ -60,6 +64,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `location` (`string`): The location of the bucket. - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object. - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_folder_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor. + - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_folder_bucket_config.index_configs.new](#fn-index_configsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -89,6 +94,7 @@ injecting into a complete block. - `location` (`string`): The location of the bucket. - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object. - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_folder_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor. + - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_folder_bucket_config.index_configs.new](#fn-index_configsnew) 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 `logging_folder_bucket_config` resource into the root Terraform configuration. @@ -179,6 +185,43 @@ Terraform resource block to set or update the folder field. - `value` (`string`): The value to set for the `folder` field. +### fn withIndexConfigs + +```ts +withIndexConfigs() +``` + +`google.list[obj].withIndexConfigs` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the index_configs field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withIndexConfigsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `index_configs` field. + + +### fn withIndexConfigsMixin + +```ts +withIndexConfigsMixin() +``` + +`google.list[obj].withIndexConfigsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the index_configs field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withIndexConfigs](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `index_configs` field. + + ### fn withLocation ```ts @@ -237,3 +280,29 @@ See [Enabling CMEK for Logging Buckets](https://cloud.google.com/logging/docs/ro **Returns**: - An attribute object that represents the `cmek_settings` sub block. + + +## obj index_configs + + + +### fn index_configs.new + +```ts +new() +``` + + +`google.logging_folder_bucket_config.index_configs.new` constructs a new object with attributes and blocks configured for the `index_configs` +Terraform sub block. + + + +**Args**: + - `field_path` (`string`): The LogEntry field path to index. + - `type` (`string`): The type of data in this index +Note that some paths are automatically indexed, and other paths are not eligible for indexing. See [indexing documentation]( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details. +For example: jsonPayload.request.status + +**Returns**: + - An attribute object that represents the `index_configs` sub block. diff --git a/docs/4.x/logging_organization_bucket_config.md b/docs/4.x/logging_organization_bucket_config.md index 66f3df4e..a2ced1db 100644 --- a/docs/4.x/logging_organization_bucket_config.md +++ b/docs/4.x/logging_organization_bucket_config.md @@ -19,11 +19,15 @@ This package contains functions and utilities for setting up the resource using * [`fn withCmekSettings()`](#fn-withcmeksettings) * [`fn withCmekSettingsMixin()`](#fn-withcmeksettingsmixin) * [`fn withDescription()`](#fn-withdescription) +* [`fn withIndexConfigs()`](#fn-withindexconfigs) +* [`fn withIndexConfigsMixin()`](#fn-withindexconfigsmixin) * [`fn withLocation()`](#fn-withlocation) * [`fn withOrganization()`](#fn-withorganization) * [`fn withRetentionDays()`](#fn-withretentiondays) * [`obj cmek_settings`](#obj-cmek_settings) * [`fn new()`](#fn-cmek_settingsnew) +* [`obj index_configs`](#obj-index_configs) + * [`fn new()`](#fn-index_configsnew) ## Fields @@ -60,6 +64,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `organization` (`string`): The parent resource that contains the logging bucket. - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object. - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_organization_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor. + - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_organization_bucket_config.index_configs.new](#fn-index_configsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -89,6 +94,7 @@ injecting into a complete block. - `organization` (`string`): The parent resource that contains the logging bucket. - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object. - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_organization_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor. + - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_organization_bucket_config.index_configs.new](#fn-index_configsnew) 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 `logging_organization_bucket_config` resource into the root Terraform configuration. @@ -163,6 +169,43 @@ Terraform resource block to set or update the description field. - `value` (`string`): The value to set for the `description` field. +### fn withIndexConfigs + +```ts +withIndexConfigs() +``` + +`google.list[obj].withIndexConfigs` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the index_configs field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withIndexConfigsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `index_configs` field. + + +### fn withIndexConfigsMixin + +```ts +withIndexConfigsMixin() +``` + +`google.list[obj].withIndexConfigsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the index_configs field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withIndexConfigs](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `index_configs` field. + + ### fn withLocation ```ts @@ -237,3 +280,29 @@ See [Enabling CMEK for Logging Buckets](https://cloud.google.com/logging/docs/ro **Returns**: - An attribute object that represents the `cmek_settings` sub block. + + +## obj index_configs + + + +### fn index_configs.new + +```ts +new() +``` + + +`google.logging_organization_bucket_config.index_configs.new` constructs a new object with attributes and blocks configured for the `index_configs` +Terraform sub block. + + + +**Args**: + - `field_path` (`string`): The LogEntry field path to index. + - `type` (`string`): The type of data in this index +Note that some paths are automatically indexed, and other paths are not eligible for indexing. See [indexing documentation]( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details. +For example: jsonPayload.request.status + +**Returns**: + - An attribute object that represents the `index_configs` sub block. diff --git a/docs/4.x/logging_project_bucket_config.md b/docs/4.x/logging_project_bucket_config.md index 1053b46b..579e5ad3 100644 --- a/docs/4.x/logging_project_bucket_config.md +++ b/docs/4.x/logging_project_bucket_config.md @@ -20,12 +20,16 @@ This package contains functions and utilities for setting up the resource using * [`fn withCmekSettingsMixin()`](#fn-withcmeksettingsmixin) * [`fn withDescription()`](#fn-withdescription) * [`fn withEnableAnalytics()`](#fn-withenableanalytics) +* [`fn withIndexConfigs()`](#fn-withindexconfigs) +* [`fn withIndexConfigsMixin()`](#fn-withindexconfigsmixin) * [`fn withLocation()`](#fn-withlocation) * [`fn withLocked()`](#fn-withlocked) * [`fn withProject()`](#fn-withproject) * [`fn withRetentionDays()`](#fn-withretentiondays) * [`obj cmek_settings`](#obj-cmek_settings) * [`fn new()`](#fn-cmek_settingsnew) +* [`obj index_configs`](#obj-index_configs) + * [`fn new()`](#fn-index_configsnew) ## Fields @@ -64,6 +68,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `project` (`string`): The parent project that contains the logging bucket. - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object. - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_project_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor. + - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_project_bucket_config.index_configs.new](#fn-index_configsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -95,6 +100,7 @@ injecting into a complete block. - `project` (`string`): The parent project that contains the logging bucket. - `retention_days` (`number`): Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. When `null`, the `retention_days` field will be omitted from the resulting object. - `cmek_settings` (`list[obj]`): The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. When `null`, the `cmek_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.logging_project_bucket_config.cmek_settings.new](#fn-cmek_settingsnew) constructor. + - `index_configs` (`list[obj]`): A list of indexed fields and related configuration data. When `null`, the `index_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.logging_project_bucket_config.index_configs.new](#fn-index_configsnew) 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 `logging_project_bucket_config` resource into the root Terraform configuration. @@ -185,6 +191,43 @@ Terraform resource block to set or update the enable_analytics field. - `value` (`bool`): The value to set for the `enable_analytics` field. +### fn withIndexConfigs + +```ts +withIndexConfigs() +``` + +`google.list[obj].withIndexConfigs` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the index_configs field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withIndexConfigsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `index_configs` field. + + +### fn withIndexConfigsMixin + +```ts +withIndexConfigsMixin() +``` + +`google.list[obj].withIndexConfigsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the index_configs field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withIndexConfigs](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `index_configs` field. + + ### fn withLocation ```ts @@ -275,3 +318,29 @@ See [Enabling CMEK for Logging Buckets](https://cloud.google.com/logging/docs/ro **Returns**: - An attribute object that represents the `cmek_settings` sub block. + + +## obj index_configs + + + +### fn index_configs.new + +```ts +new() +``` + + +`google.logging_project_bucket_config.index_configs.new` constructs a new object with attributes and blocks configured for the `index_configs` +Terraform sub block. + + + +**Args**: + - `field_path` (`string`): The LogEntry field path to index. + - `type` (`string`): The type of data in this index +Note that some paths are automatically indexed, and other paths are not eligible for indexing. See [indexing documentation]( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details. +For example: jsonPayload.request.status + +**Returns**: + - An attribute object that represents the `index_configs` sub block. diff --git a/docs/4.x/monitoring_uptime_check_config.md b/docs/4.x/monitoring_uptime_check_config.md index ef93b694..cc80e066 100644 --- a/docs/4.x/monitoring_uptime_check_config.md +++ b/docs/4.x/monitoring_uptime_check_config.md @@ -35,6 +35,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withTimeout()`](#fn-withtimeout) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withUserLabels()`](#fn-withuserlabels) * [`obj content_matchers`](#obj-content_matchers) * [`fn new()`](#fn-content_matchersnew) * [`obj content_matchers.json_path_matcher`](#obj-content_matchersjson_path_matcher) @@ -45,6 +46,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-http_checkaccepted_response_status_codesnew) * [`obj http_check.auth_info`](#obj-http_checkauth_info) * [`fn new()`](#fn-http_checkauth_infonew) + * [`obj http_check.ping_config`](#obj-http_checkping_config) + * [`fn new()`](#fn-http_checkping_confignew) * [`obj monitored_resource`](#obj-monitored_resource) * [`fn new()`](#fn-monitored_resourcenew) * [`obj resource_group`](#obj-resource_group) @@ -55,6 +58,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-synthetic_monitorcloud_function_v2new) * [`obj tcp_check`](#obj-tcp_check) * [`fn new()`](#fn-tcp_checknew) + * [`obj tcp_check.ping_config`](#obj-tcp_checkping_config) + * [`fn new()`](#fn-tcp_checkping_confignew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) @@ -93,6 +98,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `selected_regions` (`list`): The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. When `null`, the `selected_regions` field will be omitted from the resulting object. - `timeout` (`string`): The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration + - `user_labels` (`obj`): User-supplied key/value data to be used for organizing and identifying the 'UptimeCheckConfig' objects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. When `null`, the `user_labels` field will be omitted from the resulting object. - `content_matchers` (`list[obj]`): The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required. When `null`, the `content_matchers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.content_matchers.new](#fn-content_matchersnew) constructor. - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor. - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_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.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor. @@ -129,6 +135,7 @@ injecting into a complete block. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `selected_regions` (`list`): The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions. When `null`, the `selected_regions` field will be omitted from the resulting object. - `timeout` (`string`): The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration + - `user_labels` (`obj`): User-supplied key/value data to be used for organizing and identifying the 'UptimeCheckConfig' objects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. When `null`, the `user_labels` field will be omitted from the resulting object. - `content_matchers` (`list[obj]`): The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required. When `null`, the `content_matchers` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.content_matchers.new](#fn-content_matchersnew) constructor. - `http_check` (`list[obj]`): Contains information needed to make an HTTP or HTTPS check. When `null`, the `http_check` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.new](#fn-http_checknew) constructor. - `monitored_resource` (`list[obj]`): The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer k8s_service servicedirectory_service When `null`, the `monitored_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.monitoring_uptime_check_config.monitored_resource.new](#fn-monitored_resourcenew) constructor. @@ -495,6 +502,22 @@ function. - `value` (`obj`): The value to set for the `timeouts` field. +### fn withUserLabels + +```ts +withUserLabels() +``` + +`google.obj.withUserLabels` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the user_labels field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `user_labels` field. + + ## obj content_matchers @@ -562,7 +585,8 @@ Terraform sub block. **Args**: - `body` (`string`): The request body associated with the HTTP POST request. If contentType is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the requestMethod is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g. "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=". When `null`, the `body` field will be omitted from the resulting object. - - `content_type` (`string`): The content type to use for the check. Possible values: ["TYPE_UNSPECIFIED", "URL_ENCODED"] When `null`, the `content_type` field will be omitted from the resulting object. + - `content_type` (`string`): The content type to use for the check. Possible values: ["TYPE_UNSPECIFIED", "URL_ENCODED", "USER_PROVIDED"] When `null`, the `content_type` field will be omitted from the resulting object. + - `custom_content_type` (`string`): A user provided content type header to use for the check. The invalid configurations outlined in the 'content_type' field apply to custom_content_type', as well as the following 1. 'content_type' is 'URL_ENCODED' and 'custom_content_type' is set. 2. 'content_type' is 'USER_PROVIDED' and 'custom_content_type' is not set. When `null`, the `custom_content_type` field will be omitted from the resulting object. - `headers` (`obj`): The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100. When `null`, the `headers` field will be omitted from the resulting object. - `mask_headers` (`bool`): Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******. When `null`, the `mask_headers` field will be omitted from the resulting object. - `path` (`string`): The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically. Optional (defaults to "/"). When `null`, the `path` field will be omitted from the resulting object. @@ -572,6 +596,7 @@ Terraform sub block. - `validate_ssl` (`bool`): Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitoredResource is set to uptime_url. If useSsl is false, setting validateSsl to true has no effect. When `null`, the `validate_ssl` field will be omitted from the resulting object. - `accepted_response_status_codes` (`list[obj]`): If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. When `null`, the `accepted_response_status_codes` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.accepted_response_status_codes.new](#fn-http_checkaccepted_response_status_codesnew) constructor. - `auth_info` (`list[obj]`): The authentication information. Optional when creating an HTTP check; defaults to empty. When `null`, the `auth_info` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.auth_info.new](#fn-http_checkauth_infonew) constructor. + - `ping_config` (`list[obj]`): Contains information needed to add pings to an HTTP check. When `null`, the `ping_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.http_check.ping_config.new](#fn-http_checkping_confignew) constructor. **Returns**: - An attribute object that represents the `http_check` sub block. @@ -625,6 +650,29 @@ Terraform sub block. - An attribute object that represents the `auth_info` sub block. +## obj http_check.ping_config + + + +### fn http_check.ping_config.new + +```ts +new() +``` + + +`google.monitoring_uptime_check_config.http_check.ping_config.new` constructs a new object with attributes and blocks configured for the `ping_config` +Terraform sub block. + + + +**Args**: + - `pings_count` (`number`): Number of ICMP pings. A maximum of 3 ICMP pings is currently supported. + +**Returns**: + - An attribute object that represents the `ping_config` sub block. + + ## obj monitored_resource @@ -737,11 +785,35 @@ Terraform sub block. **Args**: - `port` (`number`): The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL. + - `ping_config` (`list[obj]`): Contains information needed to add pings to a TCP check. When `null`, the `ping_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.monitoring_uptime_check_config.tcp_check.ping_config.new](#fn-tcp_checkping_confignew) constructor. **Returns**: - An attribute object that represents the `tcp_check` sub block. +## obj tcp_check.ping_config + + + +### fn tcp_check.ping_config.new + +```ts +new() +``` + + +`google.monitoring_uptime_check_config.tcp_check.ping_config.new` constructs a new object with attributes and blocks configured for the `ping_config` +Terraform sub block. + + + +**Args**: + - `pings_count` (`number`): Number of ICMP pings. A maximum of 3 ICMP pings is currently supported. + +**Returns**: + - An attribute object that represents the `ping_config` sub block. + + ## obj timeouts diff --git a/docs/4.x/org_policy_policy.md b/docs/4.x/org_policy_policy.md index d664816b..34b9b365 100644 --- a/docs/4.x/org_policy_policy.md +++ b/docs/4.x/org_policy_policy.md @@ -15,12 +15,22 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withDryRunSpec()`](#fn-withdryrunspec) +* [`fn withDryRunSpecMixin()`](#fn-withdryrunspecmixin) * [`fn withName()`](#fn-withname) * [`fn withParent()`](#fn-withparent) * [`fn withSpec()`](#fn-withspec) * [`fn withSpecMixin()`](#fn-withspecmixin) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj dry_run_spec`](#obj-dry_run_spec) + * [`fn new()`](#fn-dry_run_specnew) + * [`obj dry_run_spec.rules`](#obj-dry_run_specrules) + * [`fn new()`](#fn-dry_run_specrulesnew) + * [`obj dry_run_spec.rules.condition`](#obj-dry_run_specrulescondition) + * [`fn new()`](#fn-dry_run_specrulesconditionnew) + * [`obj dry_run_spec.rules.values`](#obj-dry_run_specrulesvalues) + * [`fn new()`](#fn-dry_run_specrulesvaluesnew) * [`obj spec`](#obj-spec) * [`fn new()`](#fn-specnew) * [`obj spec.rules`](#obj-specrules) @@ -63,6 +73,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `name` (`string`): Immutable. The resource name of the Policy. Must be one of the following forms, where constraint_name is the name of the constraint which this Policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, "projects/123/policies/compute.disableSerialPortAccess". Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. - `parent` (`string`): The parent of the resource. + - `dry_run_spec` (`list[obj]`): Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it's enforced. When `null`, the `dry_run_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.org_policy_policy.dry_run_spec.new](#fn-dry_run_specnew) constructor. - `spec` (`list[obj]`): Basic information about the Organization Policy. When `null`, the `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.org_policy_policy.spec.new](#fn-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.org_policy_policy.timeouts.new](#fn-timeoutsnew) constructor. @@ -90,6 +101,7 @@ injecting into a complete block. **Args**: - `name` (`string`): Immutable. The resource name of the Policy. Must be one of the following forms, where constraint_name is the name of the constraint which this Policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, "projects/123/policies/compute.disableSerialPortAccess". Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. - `parent` (`string`): The parent of the resource. + - `dry_run_spec` (`list[obj]`): Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it's enforced. When `null`, the `dry_run_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.org_policy_policy.dry_run_spec.new](#fn-dry_run_specnew) constructor. - `spec` (`list[obj]`): Basic information about the Organization Policy. When `null`, the `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.org_policy_policy.spec.new](#fn-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.org_policy_policy.timeouts.new](#fn-timeoutsnew) constructor. @@ -97,6 +109,43 @@ injecting into a complete block. - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `org_policy_policy` resource into the root Terraform configuration. +### fn withDryRunSpec + +```ts +withDryRunSpec() +``` + +`google.list[obj].withDryRunSpec` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the dry_run_spec field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withDryRunSpecMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `dry_run_spec` field. + + +### fn withDryRunSpecMixin + +```ts +withDryRunSpecMixin() +``` + +`google.list[obj].withDryRunSpecMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the dry_run_spec field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withDryRunSpec](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `dry_run_spec` field. + + ### fn withName ```ts @@ -202,6 +251,108 @@ function. - `value` (`obj`): The value to set for the `timeouts` field. +## obj dry_run_spec + + + +### fn dry_run_spec.new + +```ts +new() +``` + + +`google.org_policy_policy.dry_run_spec.new` constructs a new object with attributes and blocks configured for the `dry_run_spec` +Terraform sub block. + + + +**Args**: + - `inherit_from_parent` (`bool`): Determines the inheritance behavior for this policy. If `inherit_from_parent` is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints. When `null`, the `inherit_from_parent` field will be omitted from the resulting object. + - `reset` (`bool`): Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, `rules` must be empty and `inherit_from_parent` must be set to false. When `null`, the `reset` field will be omitted from the resulting object. + - `rules` (`list[obj]`): In policies for boolean constraints, the following requirements apply: - There must be one and only one policy rule where condition is unset. - Boolean policy rules with conditions must set `enforced` to the opposite of the policy rule without a condition. - During policy evaluation, policy rules with conditions that are true for a target resource take precedence. 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.org_policy_policy.dry_run_spec.rules.new](#fn-dry_run_specrulesnew) constructor. + +**Returns**: + - An attribute object that represents the `dry_run_spec` sub block. + + +## obj dry_run_spec.rules + + + +### fn dry_run_spec.rules.new + +```ts +new() +``` + + +`google.org_policy_policy.dry_run_spec.rules.new` constructs a new object with attributes and blocks configured for the `rules` +Terraform sub block. + + + +**Args**: + - `allow_all` (`string`): Setting this to true means that all values are allowed. This field can be set only in policies for list constraints. When `null`, the `allow_all` field will be omitted from the resulting object. + - `deny_all` (`string`): Setting this to true means that all values are denied. This field can be set only in policies for list constraints. When `null`, the `deny_all` field will be omitted from the resulting object. + - `enforce` (`string`): If `true`, then the policy is enforced. If `false`, then any configuration is acceptable. This field can be set only in policies for boolean constraints. When `null`, the `enforce` field will be omitted from the resulting object. + - `condition` (`list[obj]`): A condition which determines whether this rule is used in the evaluation of the policy. When set, the `expression` field in the `Expr' must include from 1 to 10 subexpressions, joined by the "||" or "&&" operators. Each subexpression must be of the form "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: "resource.matchTag('123456789/environment, 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". 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.org_policy_policy.dry_run_spec.rules.condition.new](#fn-dry_run_specdry_run_specconditionnew) constructor. + - `values` (`list[obj]`): List of values to be used for this policy rule. This field can be set only in policies for list constraints. When `null`, the `values` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.org_policy_policy.dry_run_spec.rules.values.new](#fn-dry_run_specdry_run_specvaluesnew) constructor. + +**Returns**: + - An attribute object that represents the `rules` sub block. + + +## obj dry_run_spec.rules.condition + + + +### fn dry_run_spec.rules.condition.new + +```ts +new() +``` + + +`google.org_policy_policy.dry_run_spec.rules.condition.new` constructs a new object with attributes and blocks configured for the `condition` +Terraform sub block. + + + +**Args**: + - `description` (`string`): Optional. 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. When `null`, the `expression` field will be omitted from the resulting object. + - `location` (`string`): Optional. 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`): Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. When `null`, the `title` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `condition` sub block. + + +## obj dry_run_spec.rules.values + + + +### fn dry_run_spec.rules.values.new + +```ts +new() +``` + + +`google.org_policy_policy.dry_run_spec.rules.values.new` constructs a new object with attributes and blocks configured for the `values` +Terraform sub block. + + + +**Args**: + - `allowed_values` (`list`): List of values allowed at this resource. When `null`, the `allowed_values` field will be omitted from the resulting object. + - `denied_values` (`list`): List of values denied at this resource. When `null`, the `denied_values` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `values` sub block. + + ## obj spec diff --git a/docs/4.x/provider.md b/docs/4.x/provider.md index 0c22171a..2faa9006 100644 --- a/docs/4.x/provider.md +++ b/docs/4.x/provider.md @@ -122,6 +122,7 @@ the `src` and/or `version` parameters are set. - `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. - `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. - `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. + - `integration_connectors_custom_endpoint` (`string`): Set the `integration_connectors_custom_endpoint` field on the resulting provider block. When `null`, the `integration_connectors_custom_endpoint` field will be omitted from the resulting object. - `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. - `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. - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting provider block. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object. @@ -288,6 +289,7 @@ injecting into a complete block. - `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. - `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. - `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. + - `integration_connectors_custom_endpoint` (`string`): Set the `integration_connectors_custom_endpoint` field on the resulting object. When `null`, the `integration_connectors_custom_endpoint` field will be omitted from the resulting object. - `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. - `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. - `looker_custom_endpoint` (`string`): Set the `looker_custom_endpoint` field on the resulting object. When `null`, the `looker_custom_endpoint` field will be omitted from the resulting object. diff --git a/docs/4.x/pubsub_topic.md b/docs/4.x/pubsub_topic.md index a2fdebe4..ec1fedc2 100644 --- a/docs/4.x/pubsub_topic.md +++ b/docs/4.x/pubsub_topic.md @@ -78,7 +78,8 @@ the last messageRetentionDuration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to messageRetentionDuration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. -Cannot be more than 31 days or less than 10 minutes. When `null`, the `message_retention_duration` field will be omitted from the resulting object. +The rotation period has the format of a decimal number, followed by the +letter 's' (seconds). Cannot be more than 31 days or less than 10 minutes. When `null`, the `message_retention_duration` field will be omitted from the resulting object. - `name` (`string`): Name of the topic. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `message_storage_policy` (`list[obj]`): Policy constraining the set of Google Cloud Platform regions where @@ -125,7 +126,8 @@ the last messageRetentionDuration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to messageRetentionDuration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. -Cannot be more than 31 days or less than 10 minutes. When `null`, the `message_retention_duration` field will be omitted from the resulting object. +The rotation period has the format of a decimal number, followed by the +letter 's' (seconds). Cannot be more than 31 days or less than 10 minutes. When `null`, the `message_retention_duration` field will be omitted from the resulting object. - `name` (`string`): Name of the topic. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `message_storage_policy` (`list[obj]`): Policy constraining the set of Google Cloud Platform regions where diff --git a/docs/4.x/spanner_instance.md b/docs/4.x/spanner_instance.md index a9a9dcc0..705474c6 100644 --- a/docs/4.x/spanner_instance.md +++ b/docs/4.x/spanner_instance.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 withAutoscalingConfig()`](#fn-withautoscalingconfig) +* [`fn withAutoscalingConfigMixin()`](#fn-withautoscalingconfigmixin) * [`fn withConfig()`](#fn-withconfig) * [`fn withDisplayName()`](#fn-withdisplayname) * [`fn withForceDestroy()`](#fn-withforcedestroy) @@ -25,6 +27,12 @@ This package contains functions and utilities for setting up the resource using * [`fn withProject()`](#fn-withproject) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj autoscaling_config`](#obj-autoscaling_config) + * [`fn new()`](#fn-autoscaling_confignew) + * [`obj autoscaling_config.autoscaling_limits`](#obj-autoscaling_configautoscaling_limits) + * [`fn new()`](#fn-autoscaling_configautoscaling_limitsnew) + * [`obj autoscaling_config.autoscaling_targets`](#obj-autoscaling_configautoscaling_targets) + * [`fn new()`](#fn-autoscaling_configautoscaling_targetsnew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) @@ -84,6 +92,10 @@ must be present in terraform. When `null`, the `num_nodes` field will be omitted - `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. + - `autoscaling_config` (`list[obj]`): The autoscaling configuration. Autoscaling is enabled if this field is set. +When autoscaling is enabled, num_nodes and processing_units are treated as, +OUTPUT_ONLY fields and reflect the current compute capacity allocated to +the instance. When `null`, the `autoscaling_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.spanner_instance.autoscaling_config.new](#fn-autoscaling_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.spanner_instance.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -135,12 +147,53 @@ must be present in terraform. When `null`, the `num_nodes` field will be omitted - `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. + - `autoscaling_config` (`list[obj]`): The autoscaling configuration. Autoscaling is enabled if this field is set. +When autoscaling is enabled, num_nodes and processing_units are treated as, +OUTPUT_ONLY fields and reflect the current compute capacity allocated to +the instance. When `null`, the `autoscaling_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.spanner_instance.autoscaling_config.new](#fn-autoscaling_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.spanner_instance.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 `spanner_instance` resource into the root Terraform configuration. +### fn withAutoscalingConfig + +```ts +withAutoscalingConfig() +``` + +`google.list[obj].withAutoscalingConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the autoscaling_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withAutoscalingConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `autoscaling_config` field. + + +### fn withAutoscalingConfigMixin + +```ts +withAutoscalingConfigMixin() +``` + +`google.list[obj].withAutoscalingConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the autoscaling_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withAutoscalingConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `autoscaling_config` field. + + ### fn withConfig ```ts @@ -305,6 +358,87 @@ function. - `value` (`obj`): The value to set for the `timeouts` field. +## obj autoscaling_config + + + +### fn autoscaling_config.new + +```ts +new() +``` + + +`google.spanner_instance.autoscaling_config.new` constructs a new object with attributes and blocks configured for the `autoscaling_config` +Terraform sub block. + + + +**Args**: + - `autoscaling_limits` (`list[obj]`): Defines scale in controls to reduce the risk of response latency +and outages due to abrupt scale-in events When `null`, the `autoscaling_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.spanner_instance.autoscaling_config.autoscaling_limits.new](#fn-autoscaling_configautoscaling_limitsnew) constructor. + - `autoscaling_targets` (`list[obj]`): Defines scale in controls to reduce the risk of response latency +and outages due to abrupt scale-in events When `null`, the `autoscaling_targets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.spanner_instance.autoscaling_config.autoscaling_targets.new](#fn-autoscaling_configautoscaling_targetsnew) constructor. + +**Returns**: + - An attribute object that represents the `autoscaling_config` sub block. + + +## obj autoscaling_config.autoscaling_limits + + + +### fn autoscaling_config.autoscaling_limits.new + +```ts +new() +``` + + +`google.spanner_instance.autoscaling_config.autoscaling_limits.new` constructs a new object with attributes and blocks configured for the `autoscaling_limits` +Terraform sub block. + + + +**Args**: + - `max_processing_units` (`number`): Specifies maximum number of processing units allocated to the instance. +If set, this number should be multiples of 1000 and be greater than or equal to +min_processing_units. When `null`, the `max_processing_units` field will be omitted from the resulting object. + - `min_processing_units` (`number`): Specifies minimum number of processing units allocated to the instance. +If set, this number should be multiples of 1000. When `null`, the `min_processing_units` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `autoscaling_limits` sub block. + + +## obj autoscaling_config.autoscaling_targets + + + +### fn autoscaling_config.autoscaling_targets.new + +```ts +new() +``` + + +`google.spanner_instance.autoscaling_config.autoscaling_targets.new` constructs a new object with attributes and blocks configured for the `autoscaling_targets` +Terraform sub block. + + + +**Args**: + - `high_priority_cpu_utilization_percent` (`number`): Specifies the target high priority cpu utilization percentage that the autoscaler +should be trying to achieve for the instance. +This number is on a scale from 0 (no utilization) to 100 (full utilization).. When `null`, the `high_priority_cpu_utilization_percent` field will be omitted from the resulting object. + - `storage_utilization_percent` (`number`): Specifies the target storage utilization percentage that the autoscaler +should be trying to achieve for the instance. +This number is on a scale from 0 (no utilization) to 100 (full utilization). When `null`, the `storage_utilization_percent` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `autoscaling_targets` sub block. + + ## obj timeouts diff --git a/docs/4.x/sql_database_instance.md b/docs/4.x/sql_database_instance.md index 0ffd813a..97d927b8 100644 --- a/docs/4.x/sql_database_instance.md +++ b/docs/4.x/sql_database_instance.md @@ -864,7 +864,8 @@ Terraform sub block. - `enable_private_path_for_google_cloud_services` (`bool`): Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported. When `null`, the `enable_private_path_for_google_cloud_services` field will be omitted from the resulting object. - `ipv4_enabled` (`bool`): Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured. When `null`, the `ipv4_enabled` field will be omitted from the resulting object. - `private_network` (`string`): The VPC network from which the Cloud SQL instance is accessible for private IP. For example, projects/myProject/global/networks/default. Specifying a network enables private IP. At least ipv4_enabled must be enabled or a private_network must be configured. 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`): Set the `require_ssl` field on the resulting object. When `null`, the `require_ssl` field will be omitted from the resulting object. + - `require_ssl` (`bool`): Whether SSL connections over IP are enforced or not. To change this field, also set the corresponding value in ssl_mode if it has been set too. When `null`, the `require_ssl` field will be omitted from the resulting object. + - `ssl_mode` (`string`): Specify how SSL connection should be enforced in DB connections. This field provides more SSL enforcment options compared to require_ssl. To change this field, also set the correspoding value in require_ssl. When `null`, the `ssl_mode` field will be omitted from the resulting object. - `authorized_networks` (`list[obj]`): Set the `authorized_networks` field on the resulting object. 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.sql_database_instance.settings.ip_configuration.authorized_networks.new](#fn-settingssettingsauthorized_networksnew) constructor. - `psc_config` (`list[obj]`): PSC settings for a Cloud SQL instance. When `null`, the `psc_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.sql_database_instance.settings.ip_configuration.psc_config.new](#fn-settingssettingspsc_confignew) constructor. diff --git a/docs/4.x/vertex_ai_index_endpoint.md b/docs/4.x/vertex_ai_index_endpoint.md index 3fce8ade..68dbd706 100644 --- a/docs/4.x/vertex_ai_index_endpoint.md +++ b/docs/4.x/vertex_ai_index_endpoint.md @@ -19,11 +19,15 @@ This package contains functions and utilities for setting up the resource using * [`fn withDisplayName()`](#fn-withdisplayname) * [`fn withLabels()`](#fn-withlabels) * [`fn withNetwork()`](#fn-withnetwork) +* [`fn withPrivateServiceConnectConfig()`](#fn-withprivateserviceconnectconfig) +* [`fn withPrivateServiceConnectConfigMixin()`](#fn-withprivateserviceconnectconfigmixin) * [`fn withProject()`](#fn-withproject) * [`fn withPublicEndpointEnabled()`](#fn-withpublicendpointenabled) * [`fn withRegion()`](#fn-withregion) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj private_service_connect_config`](#obj-private_service_connect_config) + * [`fn new()`](#fn-private_service_connect_confignew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) @@ -69,6 +73,7 @@ Where '{project}' is a project number, as in '12345', and '{ - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `public_endpoint_enabled` (`bool`): If true, the deployed index will be accessible through public endpoint. When `null`, the `public_endpoint_enabled` field will be omitted from the resulting object. - `region` (`string`): The region of the index endpoint. eg us-central1 When `null`, the `region` field will be omitted from the resulting object. + - `private_service_connect_config` (`list[obj]`): Optional. Configuration for private service connect. 'network' and 'privateServiceConnectConfig' are mutually exclusive. When `null`, the `private_service_connect_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.vertex_ai_index_endpoint.private_service_connect_config.new](#fn-private_service_connect_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.vertex_ai_index_endpoint.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -106,6 +111,7 @@ Where '{project}' is a project number, as in '12345', and '{ - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `public_endpoint_enabled` (`bool`): If true, the deployed index will be accessible through public endpoint. When `null`, the `public_endpoint_enabled` field will be omitted from the resulting object. - `region` (`string`): The region of the index endpoint. eg us-central1 When `null`, the `region` field will be omitted from the resulting object. + - `private_service_connect_config` (`list[obj]`): Optional. Configuration for private service connect. 'network' and 'privateServiceConnectConfig' are mutually exclusive. When `null`, the `private_service_connect_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.vertex_ai_index_endpoint.private_service_connect_config.new](#fn-private_service_connect_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.vertex_ai_index_endpoint.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -176,6 +182,43 @@ Terraform resource block to set or update the network field. - `value` (`string`): The value to set for the `network` field. +### fn withPrivateServiceConnectConfig + +```ts +withPrivateServiceConnectConfig() +``` + +`google.list[obj].withPrivateServiceConnectConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the private_service_connect_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google.list[obj].withPrivateServiceConnectConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `private_service_connect_config` field. + + +### fn withPrivateServiceConnectConfigMixin + +```ts +withPrivateServiceConnectConfigMixin() +``` + +`google.list[obj].withPrivateServiceConnectConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the private_service_connect_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google.list[obj].withPrivateServiceConnectConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `private_service_connect_config` field. + + ### fn withProject ```ts @@ -260,6 +303,30 @@ function. - `value` (`obj`): The value to set for the `timeouts` field. +## obj private_service_connect_config + + + +### fn private_service_connect_config.new + +```ts +new() +``` + + +`google.vertex_ai_index_endpoint.private_service_connect_config.new` constructs a new object with attributes and blocks configured for the `private_service_connect_config` +Terraform sub block. + + + +**Args**: + - `enable_private_service_connect` (`bool`): If set to true, the IndexEndpoint is created without private service access. + - `project_allowlist` (`list`): A list of Projects from which the forwarding rule will target the service attachment. When `null`, the `project_allowlist` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `private_service_connect_config` sub block. + + ## obj timeouts