diff --git a/4.x/_gen/data/main.libsonnet b/4.x/_gen/data/main.libsonnet index bcc79fd..b5c7c3d 100644 --- a/4.x/_gen/data/main.libsonnet +++ b/4.x/_gen/data/main.libsonnet @@ -224,6 +224,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); sql_ca_certs: (import 'sql_ca_certs.libsonnet'), sql_database: (import 'sql_database.libsonnet'), sql_database_instance: (import 'sql_database_instance.libsonnet'), + sql_database_instance_latest_recovery_time: (import 'sql_database_instance_latest_recovery_time.libsonnet'), sql_database_instances: (import 'sql_database_instances.libsonnet'), sql_databases: (import 'sql_databases.libsonnet'), sql_tiers: (import 'sql_tiers.libsonnet'), diff --git a/4.x/_gen/data/sql_database_instance_latest_recovery_time.libsonnet b/4.x/_gen/data/sql_database_instance_latest_recovery_time.libsonnet new file mode 100644 index 0000000..a6388d0 --- /dev/null +++ b/4.x/_gen/data/sql_database_instance_latest_recovery_time.libsonnet @@ -0,0 +1,45 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='google_sql_database_instance_latest_recovery_time', url='', help='`google_sql_database_instance_latest_recovery_time` represents the `google-beta_google_sql_database_instance_latest_recovery_time` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google-beta.data.google_sql_database_instance_latest_recovery_time.new` injects a new `data_google-beta_google_sql_database_instance_latest_recovery_time` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.data.google_sql_database_instance_latest_recovery_time.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.data.google_sql_database_instance_latest_recovery_time` using the reference:\n\n $._ref.data_google-beta_google_sql_database_instance_latest_recovery_time.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_google-beta_google_sql_database_instance_latest_recovery_time.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `instance` (`string`): Set the `instance` field on the resulting data source block.\n - `project` (`string`): Set the `project` field on the resulting data source block. When `null`, the `project` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + instance, + project=null, + _meta={} + ):: tf.withData( + type='google_sql_database_instance_latest_recovery_time', + label=dataSrcLabel, + attrs=self.newAttrs(instance=instance, project=project), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.data.google_sql_database_instance_latest_recovery_time.newAttrs` constructs a new object with attributes and blocks configured for the `google_sql_database_instance_latest_recovery_time`\nTerraform data source.\n\nUnlike [google-beta.data.google_sql_database_instance_latest_recovery_time.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `instance` (`string`): Set the `instance` field on the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `google_sql_database_instance_latest_recovery_time` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + instance, + project=null + ):: std.prune(a={ + instance: instance, + project: project, + }), + '#withInstance':: d.fn(help='`google-beta.string.withInstance` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the instance field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `instance` field.\n', args=[]), + withInstance(dataSrcLabel, value): { + data+: { + google_sql_database_instance_latest_recovery_time+: { + [dataSrcLabel]+: { + instance: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the project field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(dataSrcLabel, value): { + data+: { + google_sql_database_instance_latest_recovery_time+: { + [dataSrcLabel]+: { + project: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/main.libsonnet b/4.x/_gen/main.libsonnet index aee2a6e..7830d1d 100644 --- a/4.x/_gen/main.libsonnet +++ b/4.x/_gen/main.libsonnet @@ -83,6 +83,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); bigquery_analytics_hub_listing_iam_binding: (import 'resources/bigquery_analytics_hub_listing_iam_binding.libsonnet'), bigquery_analytics_hub_listing_iam_member: (import 'resources/bigquery_analytics_hub_listing_iam_member.libsonnet'), bigquery_analytics_hub_listing_iam_policy: (import 'resources/bigquery_analytics_hub_listing_iam_policy.libsonnet'), + bigquery_bi_reservation: (import 'resources/bigquery_bi_reservation.libsonnet'), bigquery_capacity_commitment: (import 'resources/bigquery_capacity_commitment.libsonnet'), bigquery_connection: (import 'resources/bigquery_connection.libsonnet'), bigquery_connection_iam_binding: (import 'resources/bigquery_connection_iam_binding.libsonnet'), @@ -132,6 +133,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); certificate_manager_certificate_map: (import 'resources/certificate_manager_certificate_map.libsonnet'), certificate_manager_certificate_map_entry: (import 'resources/certificate_manager_certificate_map_entry.libsonnet'), certificate_manager_dns_authorization: (import 'resources/certificate_manager_dns_authorization.libsonnet'), + certificate_manager_trust_config: (import 'resources/certificate_manager_trust_config.libsonnet'), cloud_asset_folder_feed: (import 'resources/cloud_asset_folder_feed.libsonnet'), cloud_asset_organization_feed: (import 'resources/cloud_asset_organization_feed.libsonnet'), cloud_asset_project_feed: (import 'resources/cloud_asset_project_feed.libsonnet'), @@ -358,6 +360,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); dataflow_job: (import 'resources/dataflow_job.libsonnet'), dataform_repository: (import 'resources/dataform_repository.libsonnet'), dataform_repository_release_config: (import 'resources/dataform_repository_release_config.libsonnet'), + dataform_repository_workflow_config: (import 'resources/dataform_repository_workflow_config.libsonnet'), dataplex_asset: (import 'resources/dataplex_asset.libsonnet'), dataplex_asset_iam_binding: (import 'resources/dataplex_asset_iam_binding.libsonnet'), dataplex_asset_iam_member: (import 'resources/dataplex_asset_iam_member.libsonnet'), @@ -485,6 +488,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); gke_hub_membership_iam_binding: (import 'resources/gke_hub_membership_iam_binding.libsonnet'), gke_hub_membership_iam_member: (import 'resources/gke_hub_membership_iam_member.libsonnet'), gke_hub_membership_iam_policy: (import 'resources/gke_hub_membership_iam_policy.libsonnet'), + gke_hub_membership_rbac_role_binding: (import 'resources/gke_hub_membership_rbac_role_binding.libsonnet'), gkeonprem_bare_metal_admin_cluster: (import 'resources/gkeonprem_bare_metal_admin_cluster.libsonnet'), gkeonprem_bare_metal_cluster: (import 'resources/gkeonprem_bare_metal_cluster.libsonnet'), gkeonprem_bare_metal_node_pool: (import 'resources/gkeonprem_bare_metal_node_pool.libsonnet'), diff --git a/4.x/_gen/resources/alloydb_cluster.libsonnet b/4.x/_gen/resources/alloydb_cluster.libsonnet index 400926d..9891bc1 100644 --- a/4.x/_gen/resources/alloydb_cluster.libsonnet +++ b/4.x/_gen/resources/alloydb_cluster.libsonnet @@ -110,7 +110,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); user: user, }), }, - '#new':: d.fn(help="\n`google-beta.google_alloydb_cluster.new` injects a new `google-beta_google_alloydb_cluster` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_alloydb_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_alloydb_cluster` using the reference:\n\n $._ref.google-beta_google_alloydb_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_alloydb_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n\u0026#34;projects/{projectNumber}/global/networks/{network_id}\u0026#34;.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `continuous_backup_config` (`list[obj]`): The continuous backup config for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor.\n - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_alloydb_cluster.new` injects a new `google-beta_google_alloydb_cluster` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_alloydb_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_alloydb_cluster` using the reference:\n\n $._ref.google-beta_google_alloydb_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_alloydb_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n\u0026#34;projects/{projectNumber}/global/networks/{network_id}\u0026#34;.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `continuous_backup_config` (`list[obj]`): The continuous backup config for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor.\n - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `restore_backup_source` (`list[obj]`): The source when restoring from a backup. Conflicts with \u0026#39;restore_continuous_backup_source\u0026#39;, both can\u0026#39;t be set together. When `null`, the `restore_backup_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.restore_backup_source.new](#fn-restore_backup_sourcenew) constructor.\n - `restore_continuous_backup_source` (`list[obj]`): The source when restoring via point in time recovery (PITR). Conflicts with \u0026#39;restore_backup_source\u0026#39;, both can\u0026#39;t be set together. When `null`, the `restore_continuous_backup_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.restore_continuous_backup_source.new](#fn-restore_continuous_backup_sourcenew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, cluster_id, @@ -123,6 +123,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); initial_user=null, labels=null, project=null, + restore_backup_source=null, + restore_continuous_backup_source=null, timeouts=null, _meta={} ):: tf.withResource( @@ -139,11 +141,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); location=location, network=network, project=project, + restore_backup_source=restore_backup_source, + restore_continuous_backup_source=restore_continuous_backup_source, timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_alloydb_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_cluster`\nTerraform resource.\n\nUnlike [google-beta.google_alloydb_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n"projects/{projectNumber}/global/networks/{network_id}".\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `continuous_backup_config` (`list[obj]`): The continuous backup config for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor.\n - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_alloydb_cluster` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_alloydb_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_cluster`\nTerraform resource.\n\nUnlike [google-beta.google_alloydb_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `cluster_id` (`string`): The ID of the alloydb cluster.\n - `display_name` (`string`): User-settable and human-readable display name for the Cluster. When `null`, the `display_name` field will be omitted from the resulting object.\n - `labels` (`obj`): User-defined labels for the alloydb cluster. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The location where the alloydb cluster should reside.\n - `network` (`string`): The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:\n\n"projects/{projectNumber}/global/networks/{network_id}".\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `automated_backup_policy` (`list[obj]`): The automated backup policy for this cluster. AutomatedBackupPolicy is disabled by default. When `null`, the `automated_backup_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.automated_backup_policy.new](#fn-automated_backup_policynew) constructor.\n - `continuous_backup_config` (`list[obj]`): The continuous backup config for this cluster.\n\nIf no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor.\n - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor.\n - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor.\n - `restore_backup_source` (`list[obj]`): The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. When `null`, the `restore_backup_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.restore_backup_source.new](#fn-restore_backup_sourcenew) constructor.\n - `restore_continuous_backup_source` (`list[obj]`): The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. When `null`, the `restore_continuous_backup_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.restore_continuous_backup_source.new](#fn-restore_continuous_backup_sourcenew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_alloydb_cluster` resource into the root Terraform configuration.\n', args=[]), newAttrs( cluster_id, location, @@ -155,6 +159,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); initial_user=null, labels=null, project=null, + restore_backup_source=null, + restore_continuous_backup_source=null, timeouts=null ):: std.prune(a={ automated_backup_policy: automated_backup_policy, @@ -167,8 +173,28 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); location: location, network: network, project: project, + restore_backup_source: restore_backup_source, + restore_continuous_backup_source: restore_continuous_backup_source, timeouts: timeouts, }), + restore_backup_source:: { + '#new':: d.fn(help='\n`google-beta.google_alloydb_cluster.restore_backup_source.new` constructs a new object with attributes and blocks configured for the `restore_backup_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `backup_name` (`string`): The name of the backup that this cluster is restored from.\n\n**Returns**:\n - An attribute object that represents the `restore_backup_source` sub block.\n', args=[]), + new( + backup_name + ):: std.prune(a={ + backup_name: backup_name, + }), + }, + restore_continuous_backup_source:: { + '#new':: d.fn(help='\n`google-beta.google_alloydb_cluster.restore_continuous_backup_source.new` constructs a new object with attributes and blocks configured for the `restore_continuous_backup_source`\nTerraform sub block.\n\n\n\n**Args**:\n - `cluster` (`string`): The name of the source cluster that this cluster is restored from.\n - `point_in_time` (`string`): The point in time that this cluster is restored to, in RFC 3339 format.\n\n**Returns**:\n - An attribute object that represents the `restore_continuous_backup_source` sub block.\n', args=[]), + new( + cluster, + point_in_time + ):: std.prune(a={ + cluster: cluster, + point_in_time: point_in_time, + }), + }, timeouts:: { '#new':: d.fn(help='\n`google-beta.google_alloydb_cluster.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( @@ -321,6 +347,46 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withRestoreBackupSource':: d.fn(help='`google-beta.list[obj].withRestoreBackupSource` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the restore_backup_source field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google-beta.list[obj].withRestoreBackupSourceMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `restore_backup_source` field.\n', args=[]), + withRestoreBackupSource(resourceLabel, value): { + resource+: { + google_alloydb_cluster+: { + [resourceLabel]+: { + restore_backup_source: value, + }, + }, + }, + }, + '#withRestoreBackupSourceMixin':: d.fn(help='`google-beta.list[obj].withRestoreBackupSourceMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the restore_backup_source field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google-beta.list[obj].withRestoreBackupSource](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `restore_backup_source` field.\n', args=[]), + withRestoreBackupSourceMixin(resourceLabel, value): { + resource+: { + google_alloydb_cluster+: { + [resourceLabel]+: { + restore_backup_source+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withRestoreContinuousBackupSource':: d.fn(help='`google-beta.list[obj].withRestoreContinuousBackupSource` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the restore_continuous_backup_source field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google-beta.list[obj].withRestoreContinuousBackupSourceMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `restore_continuous_backup_source` field.\n', args=[]), + withRestoreContinuousBackupSource(resourceLabel, value): { + resource+: { + google_alloydb_cluster+: { + [resourceLabel]+: { + restore_continuous_backup_source: value, + }, + }, + }, + }, + '#withRestoreContinuousBackupSourceMixin':: d.fn(help='`google-beta.list[obj].withRestoreContinuousBackupSourceMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the restore_continuous_backup_source field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google-beta.list[obj].withRestoreContinuousBackupSource](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `restore_continuous_backup_source` field.\n', args=[]), + withRestoreContinuousBackupSourceMixin(resourceLabel, value): { + resource+: { + google_alloydb_cluster+: { + [resourceLabel]+: { + restore_continuous_backup_source+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withTimeouts':: d.fn(help='`google-beta.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google-beta.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), withTimeouts(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/alloydb_instance.libsonnet b/4.x/_gen/resources/alloydb_instance.libsonnet index 6c05a6f..c8a84b7 100644 --- a/4.x/_gen/resources/alloydb_instance.libsonnet +++ b/4.x/_gen/resources/alloydb_instance.libsonnet @@ -10,7 +10,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); cpu_count: cpu_count, }), }, - '#new':: d.fn(help="\n`google-beta.google_alloydb_instance.new` injects a new `google-beta_google_alloydb_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_alloydb_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_alloydb_instance` using the reference:\n\n $._ref.google-beta_google_alloydb_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_alloydb_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `annotations` (`obj`): Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `availability_type` (`string`): \u0026#39;Availability type of an Instance. Defaults to REGIONAL for both primary and read instances.\nNote that primary and read instances can have different availability types.\nOnly READ_POOL instance supports ZONAL type. Users can\u0026#39;t specify the zone for READ_POOL instance.\nZone is automatically chosen from the list of zones in the region specified.\nRead pool of size 1 can only have zonal availability. Read pools with node count of 2 or more\ncan have regional availability (nodes are present in 2 or more zones in a region).\u0026#39; Possible values: [\u0026#34;AVAILABILITY_TYPE_UNSPECIFIED\u0026#34;, \u0026#34;ZONAL\u0026#34;, \u0026#34;REGIONAL\u0026#34;] When `null`, the `availability_type` field will be omitted from the resulting object.\n - `cluster` (`string`): Identifies the alloydb cluster. Must be in the format\n\u0026#39;projects/{project}/locations/{location}/clusters/{cluster_id}\u0026#39;\n - `database_flags` (`obj`): Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. When `null`, the `database_flags` field will be omitted from the resulting object.\n - `display_name` (`string`): User-settable and human-readable display name for the Instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `gce_zone` (`string`): The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. When `null`, the `gce_zone` field will be omitted from the resulting object.\n - `instance_id` (`string`): The ID of the alloydb instance.\n - `instance_type` (`string`): The type of the instance. If the instance type is READ_POOL, provide the associated PRIMARY instance in the \u0026#39;depends_on\u0026#39; meta-data attribute. Possible values: [\u0026#34;PRIMARY\u0026#34;, \u0026#34;READ_POOL\u0026#34;]\n - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object.\n - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.machine_config.new](#fn-machine_confignew) constructor.\n - `read_pool_config` (`list[obj]`): Read pool specific config. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_alloydb_instance.new` injects a new `google-beta_google_alloydb_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_alloydb_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_alloydb_instance` using the reference:\n\n $._ref.google-beta_google_alloydb_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_alloydb_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `annotations` (`obj`): Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `availability_type` (`string`): \u0026#39;Availability type of an Instance. Defaults to REGIONAL for both primary and read instances.\nNote that primary and read instances can have different availability types.\nOnly READ_POOL instance supports ZONAL type. Users can\u0026#39;t specify the zone for READ_POOL instance.\nZone is automatically chosen from the list of zones in the region specified.\nRead pool of size 1 can only have zonal availability. Read pools with node count of 2 or more\ncan have regional availability (nodes are present in 2 or more zones in a region).\u0026#39; Possible values: [\u0026#34;AVAILABILITY_TYPE_UNSPECIFIED\u0026#34;, \u0026#34;ZONAL\u0026#34;, \u0026#34;REGIONAL\u0026#34;] When `null`, the `availability_type` field will be omitted from the resulting object.\n - `cluster` (`string`): Identifies the alloydb cluster. Must be in the format\n\u0026#39;projects/{project}/locations/{location}/clusters/{cluster_id}\u0026#39;\n - `database_flags` (`obj`): Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. When `null`, the `database_flags` field will be omitted from the resulting object.\n - `display_name` (`string`): User-settable and human-readable display name for the Instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `gce_zone` (`string`): The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. When `null`, the `gce_zone` field will be omitted from the resulting object.\n - `instance_id` (`string`): The ID of the alloydb instance.\n - `instance_type` (`string`): The type of the instance. If the instance type is READ_POOL, provide the associated PRIMARY instance in the \u0026#39;depends_on\u0026#39; meta-data attribute. Possible values: [\u0026#34;PRIMARY\u0026#34;, \u0026#34;READ_POOL\u0026#34;]\n - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object.\n - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.machine_config.new](#fn-machine_confignew) constructor.\n - `read_pool_config` (`list[obj]`): Read pool specific config. If the instance type is READ_POOL, this configuration must be provided. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, cluster, @@ -45,7 +45,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_alloydb_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_instance`\nTerraform resource.\n\nUnlike [google-beta.google_alloydb_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `annotations` (`obj`): Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `availability_type` (`string`): 'Availability type of an Instance. Defaults to REGIONAL for both primary and read instances.\nNote that primary and read instances can have different availability types.\nOnly READ_POOL instance supports ZONAL type. Users can't specify the zone for READ_POOL instance.\nZone is automatically chosen from the list of zones in the region specified.\nRead pool of size 1 can only have zonal availability. Read pools with node count of 2 or more\ncan have regional availability (nodes are present in 2 or more zones in a region).' Possible values: ["AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL"] When `null`, the `availability_type` field will be omitted from the resulting object.\n - `cluster` (`string`): Identifies the alloydb cluster. Must be in the format\n'projects/{project}/locations/{location}/clusters/{cluster_id}'\n - `database_flags` (`obj`): Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. When `null`, the `database_flags` field will be omitted from the resulting object.\n - `display_name` (`string`): User-settable and human-readable display name for the Instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `gce_zone` (`string`): The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. When `null`, the `gce_zone` field will be omitted from the resulting object.\n - `instance_id` (`string`): The ID of the alloydb instance.\n - `instance_type` (`string`): The type of the instance. If the instance type is READ_POOL, provide the associated PRIMARY instance in the 'depends_on' meta-data attribute. Possible values: ["PRIMARY", "READ_POOL"]\n - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object.\n - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.machine_config.new](#fn-machine_confignew) constructor.\n - `read_pool_config` (`list[obj]`): Read pool specific config. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_alloydb_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_alloydb_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_alloydb_instance`\nTerraform resource.\n\nUnlike [google-beta.google_alloydb_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `annotations` (`obj`): Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. When `null`, the `annotations` field will be omitted from the resulting object.\n - `availability_type` (`string`): 'Availability type of an Instance. Defaults to REGIONAL for both primary and read instances.\nNote that primary and read instances can have different availability types.\nOnly READ_POOL instance supports ZONAL type. Users can't specify the zone for READ_POOL instance.\nZone is automatically chosen from the list of zones in the region specified.\nRead pool of size 1 can only have zonal availability. Read pools with node count of 2 or more\ncan have regional availability (nodes are present in 2 or more zones in a region).' Possible values: ["AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL"] When `null`, the `availability_type` field will be omitted from the resulting object.\n - `cluster` (`string`): Identifies the alloydb cluster. Must be in the format\n'projects/{project}/locations/{location}/clusters/{cluster_id}'\n - `database_flags` (`obj`): Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. When `null`, the `database_flags` field will be omitted from the resulting object.\n - `display_name` (`string`): User-settable and human-readable display name for the Instance. When `null`, the `display_name` field will be omitted from the resulting object.\n - `gce_zone` (`string`): The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. When `null`, the `gce_zone` field will be omitted from the resulting object.\n - `instance_id` (`string`): The ID of the alloydb instance.\n - `instance_type` (`string`): The type of the instance. If the instance type is READ_POOL, provide the associated PRIMARY instance in the 'depends_on' meta-data attribute. Possible values: ["PRIMARY", "READ_POOL"]\n - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object.\n - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.machine_config.new](#fn-machine_confignew) constructor.\n - `read_pool_config` (`list[obj]`): Read pool specific config. If the instance type is READ_POOL, this configuration must be provided. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_alloydb_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( cluster, instance_id, diff --git a/4.x/_gen/resources/apigee_instance_attachment.libsonnet b/4.x/_gen/resources/apigee_instance_attachment.libsonnet index 62f3268..030f8a0 100644 --- a/4.x/_gen/resources/apigee_instance_attachment.libsonnet +++ b/4.x/_gen/resources/apigee_instance_attachment.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_apigee_instance_attachment', url='', help='`google_apigee_instance_attachment` represents the `google-beta_google_apigee_instance_attachment` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google-beta.google_apigee_instance_attachment.new` injects a new `google-beta_google_apigee_instance_attachment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_apigee_instance_attachment.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_apigee_instance_attachment` using the reference:\n\n $._ref.google-beta_google_apigee_instance_attachment.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_apigee_instance_attachment.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 - `environment` (`string`): The resource ID of the environment.\n - `instance_id` (`string`): The Apigee instance associated with the Apigee environment,\nin the format \u0026#39;organisations/{{org_name}}/instances/{{instance_name}}\u0026#39;.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_apigee_instance_attachment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_apigee_instance_attachment.new` injects a new `google-beta_google_apigee_instance_attachment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_apigee_instance_attachment.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_apigee_instance_attachment` using the reference:\n\n $._ref.google-beta_google_apigee_instance_attachment.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_apigee_instance_attachment.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 - `environment` (`string`): The resource ID of the environment.\n - `instance_id` (`string`): The Apigee instance associated with the Apigee environment,\nin the format \u0026#39;organizations/{{org_name}}/instances/{{instance_name}}\u0026#39;.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_apigee_instance_attachment.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, environment, @@ -15,7 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(environment=environment, instance_id=instance_id, timeouts=timeouts), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_apigee_instance_attachment.newAttrs` constructs a new object with attributes and blocks configured for the `google_apigee_instance_attachment`\nTerraform resource.\n\nUnlike [google-beta.google_apigee_instance_attachment.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 - `environment` (`string`): The resource ID of the environment.\n - `instance_id` (`string`): The Apigee instance associated with the Apigee environment,\nin the format 'organisations/{{org_name}}/instances/{{instance_name}}'.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_apigee_instance_attachment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_apigee_instance_attachment` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_apigee_instance_attachment.newAttrs` constructs a new object with attributes and blocks configured for the `google_apigee_instance_attachment`\nTerraform resource.\n\nUnlike [google-beta.google_apigee_instance_attachment.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 - `environment` (`string`): The resource ID of the environment.\n - `instance_id` (`string`): The Apigee instance associated with the Apigee environment,\nin the format 'organizations/{{org_name}}/instances/{{instance_name}}'.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_apigee_instance_attachment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_apigee_instance_attachment` resource into the root Terraform configuration.\n', args=[]), newAttrs( environment, instance_id, diff --git a/4.x/_gen/resources/artifact_registry_repository.libsonnet b/4.x/_gen/resources/artifact_registry_repository.libsonnet index 619b992..b18e9f3 100644 --- a/4.x/_gen/resources/artifact_registry_repository.libsonnet +++ b/4.x/_gen/resources/artifact_registry_repository.libsonnet @@ -2,6 +2,46 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_artifact_registry_repository', url='', help='`google_artifact_registry_repository` represents the `google-beta_google_artifact_registry_repository` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + cleanup_policies:: { + condition:: { + '#new':: d.fn(help='\n`google-beta.google_artifact_registry_repository.cleanup_policies.condition.new` constructs a new object with attributes and blocks configured for the `condition`\nTerraform sub block.\n\n\n\n**Args**:\n - `newer_than` (`string`): Match versions newer than a duration. When `null`, the `newer_than` field will be omitted from the resulting object.\n - `older_than` (`string`): Match versions older than a duration. When `null`, the `older_than` field will be omitted from the resulting object.\n - `package_name_prefixes` (`list`): Match versions by package prefix. Applied on any prefix match. When `null`, the `package_name_prefixes` field will be omitted from the resulting object.\n - `tag_prefixes` (`list`): Match versions by tag prefix. Applied on any prefix match. When `null`, the `tag_prefixes` field will be omitted from the resulting object.\n - `tag_state` (`string`): Match versions by tag status. Default value: "ANY" Possible values: ["TAGGED", "UNTAGGED", "ANY"] When `null`, the `tag_state` field will be omitted from the resulting object.\n - `version_name_prefixes` (`list`): Match versions by version name prefix. Applied on any prefix match. When `null`, the `version_name_prefixes` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `condition` sub block.\n', args=[]), + new( + newer_than=null, + older_than=null, + package_name_prefixes=null, + tag_prefixes=null, + tag_state=null, + version_name_prefixes=null + ):: std.prune(a={ + newer_than: newer_than, + older_than: older_than, + package_name_prefixes: package_name_prefixes, + tag_prefixes: tag_prefixes, + tag_state: tag_state, + version_name_prefixes: version_name_prefixes, + }), + }, + most_recent_versions:: { + '#new':: d.fn(help='\n`google-beta.google_artifact_registry_repository.cleanup_policies.most_recent_versions.new` constructs a new object with attributes and blocks configured for the `most_recent_versions`\nTerraform sub block.\n\n\n\n**Args**:\n - `keep_count` (`number`): Minimum number of versions to keep. When `null`, the `keep_count` field will be omitted from the resulting object.\n - `package_name_prefixes` (`list`): Match versions by package prefix. Applied on any prefix match. When `null`, the `package_name_prefixes` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `most_recent_versions` sub block.\n', args=[]), + new( + keep_count=null, + package_name_prefixes=null + ):: std.prune(a={ + keep_count: keep_count, + package_name_prefixes: package_name_prefixes, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_artifact_registry_repository.cleanup_policies.new` constructs a new object with attributes and blocks configured for the `cleanup_policies`\nTerraform sub block.\n\n\n\n**Args**:\n - `action` (`string`): Policy action. Possible values: ["DELETE", "KEEP"] When `null`, the `action` field will be omitted from the resulting object.\n - `condition` (`list[obj]`): Policy condition for matching versions. When `null`, the `condition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.cleanup_policies.condition.new](#fn-cleanup_policiesconditionnew) constructor.\n - `most_recent_versions` (`list[obj]`): Policy condition for retaining a minimum number of versions. May only be\nspecified with a Keep action. When `null`, the `most_recent_versions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.cleanup_policies.most_recent_versions.new](#fn-cleanup_policiesmost_recent_versionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `cleanup_policies` sub block.\n', args=[]), + new( + action=null, + condition=null, + most_recent_versions=null + ):: std.prune(a={ + action: action, + condition: condition, + most_recent_versions: most_recent_versions, + }), + }, docker_config:: { '#new':: d.fn(help='\n`google-beta.google_artifact_registry_repository.docker_config.new` constructs a new object with attributes and blocks configured for the `docker_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `immutable_tags` (`bool`): The repository which enabled this flag prevents all tags from being modified, moved or deleted. This does not prevent tags from being created. When `null`, the `immutable_tags` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `docker_config` sub block.\n', args=[]), new( @@ -20,11 +60,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); version_policy: version_policy, }), }, - '#new':: d.fn(help="\n`google-beta.google_artifact_registry_repository.new` injects a new `google-beta_google_artifact_registry_repository` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_artifact_registry_repository.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_artifact_registry_repository` using the reference:\n\n $._ref.google-beta_google_artifact_registry_repository.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_artifact_registry_repository.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): The user-provided description of the repository. When `null`, the `description` field will be omitted from the resulting object.\n - `format` (`string`): The format of packages that are stored in the repository. Supported formats\ncan be found [here](https://cloud.google.com/artifact-registry/docs/supported-formats).\nYou can only create alpha formats if you are a member of the\n[alpha user group](https://cloud.google.com/artifact-registry/docs/supported-formats#alpha-access).\n - `kms_key_name` (`string`): The Cloud KMS resource name of the customer managed encryption key that’s\nused to encrypt the contents of the Repository. Has the form:\n\u0026#39;projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key\u0026#39;.\nThis value may not be changed after the Repository has been created. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels with user-defined metadata.\nThis field may contain up to 64 entries. Label keys and values may be no\nlonger than 63 characters. Label keys must begin with a lowercase letter\nand may only contain lowercase letters, numeric characters, underscores,\nand dashes. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The name of the location this repository is located in. When `null`, the `location` field will be omitted from the resulting object.\n - `mode` (`string`): The mode configures the repository to serve artifacts from different sources. Default value: \u0026#34;STANDARD_REPOSITORY\u0026#34; Possible values: [\u0026#34;STANDARD_REPOSITORY\u0026#34;, \u0026#34;VIRTUAL_REPOSITORY\u0026#34;, \u0026#34;REMOTE_REPOSITORY\u0026#34;] When `null`, the `mode` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `repository_id` (`string`): The last part of the repository name, for example:\n\u0026#34;repo1\u0026#34;\n - `docker_config` (`list[obj]`): Docker repository config contains repository level configuration for the repositories of docker type. When `null`, the `docker_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.docker_config.new](#fn-docker_confignew) constructor.\n - `maven_config` (`list[obj]`): MavenRepositoryConfig is maven related repository details.\nProvides additional configuration details for repositories of the maven\nformat type. When `null`, the `maven_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.maven_config.new](#fn-maven_confignew) constructor.\n - `remote_repository_config` (`list[obj]`): Configuration specific for a Remote Repository. When `null`, the `remote_repository_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.remote_repository_config.new](#fn-remote_repository_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.timeouts.new](#fn-timeoutsnew) constructor.\n - `virtual_repository_config` (`list[obj]`): Configuration specific for a Virtual Repository. When `null`, the `virtual_repository_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.virtual_repository_config.new](#fn-virtual_repository_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_artifact_registry_repository.new` injects a new `google-beta_google_artifact_registry_repository` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_artifact_registry_repository.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_artifact_registry_repository` using the reference:\n\n $._ref.google-beta_google_artifact_registry_repository.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_artifact_registry_repository.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `cleanup_policy_dry_run` (`bool`): If true, the cleanup pipeline is prevented from deleting versions in this\nrepository. When `null`, the `cleanup_policy_dry_run` field will be omitted from the resulting object.\n - `description` (`string`): The user-provided description of the repository. When `null`, the `description` field will be omitted from the resulting object.\n - `format` (`string`): The format of packages that are stored in the repository. Supported formats\ncan be found [here](https://cloud.google.com/artifact-registry/docs/supported-formats).\nYou can only create alpha formats if you are a member of the\n[alpha user group](https://cloud.google.com/artifact-registry/docs/supported-formats#alpha-access).\n - `kms_key_name` (`string`): The Cloud KMS resource name of the customer managed encryption key that’s\nused to encrypt the contents of the Repository. Has the form:\n\u0026#39;projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key\u0026#39;.\nThis value may not be changed after the Repository has been created. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels with user-defined metadata.\nThis field may contain up to 64 entries. Label keys and values may be no\nlonger than 63 characters. Label keys must begin with a lowercase letter\nand may only contain lowercase letters, numeric characters, underscores,\nand dashes. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The name of the location this repository is located in. When `null`, the `location` field will be omitted from the resulting object.\n - `mode` (`string`): The mode configures the repository to serve artifacts from different sources. Default value: \u0026#34;STANDARD_REPOSITORY\u0026#34; Possible values: [\u0026#34;STANDARD_REPOSITORY\u0026#34;, \u0026#34;VIRTUAL_REPOSITORY\u0026#34;, \u0026#34;REMOTE_REPOSITORY\u0026#34;] When `null`, the `mode` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `repository_id` (`string`): The last part of the repository name, for example:\n\u0026#34;repo1\u0026#34;\n - `cleanup_policies` (`list[obj]`): Cleanup policies for this repository. Cleanup policies indicate when\ncertain package versions can be automatically deleted.\nMap keys are policy IDs supplied by users during policy creation. They must\nunique within a repository and be under 128 characters in length. When `null`, the `cleanup_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.cleanup_policies.new](#fn-cleanup_policiesnew) constructor.\n - `docker_config` (`list[obj]`): Docker repository config contains repository level configuration for the repositories of docker type. When `null`, the `docker_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.docker_config.new](#fn-docker_confignew) constructor.\n - `maven_config` (`list[obj]`): MavenRepositoryConfig is maven related repository details.\nProvides additional configuration details for repositories of the maven\nformat type. When `null`, the `maven_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.maven_config.new](#fn-maven_confignew) constructor.\n - `remote_repository_config` (`list[obj]`): Configuration specific for a Remote Repository. When `null`, the `remote_repository_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.remote_repository_config.new](#fn-remote_repository_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.timeouts.new](#fn-timeoutsnew) constructor.\n - `virtual_repository_config` (`list[obj]`): Configuration specific for a Virtual Repository. When `null`, the `virtual_repository_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.virtual_repository_config.new](#fn-virtual_repository_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, format, repository_id, + cleanup_policies=null, + cleanup_policy_dry_run=null, description=null, docker_config=null, kms_key_name=null, @@ -41,6 +83,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='google_artifact_registry_repository', label=resourceLabel, attrs=self.newAttrs( + cleanup_policies=cleanup_policies, + cleanup_policy_dry_run=cleanup_policy_dry_run, description=description, docker_config=docker_config, format=format, @@ -57,10 +101,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_artifact_registry_repository.newAttrs` constructs a new object with attributes and blocks configured for the `google_artifact_registry_repository`\nTerraform resource.\n\nUnlike [google-beta.google_artifact_registry_repository.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): The user-provided description of the repository. When `null`, the `description` field will be omitted from the resulting object.\n - `format` (`string`): The format of packages that are stored in the repository. Supported formats\ncan be found [here](https://cloud.google.com/artifact-registry/docs/supported-formats).\nYou can only create alpha formats if you are a member of the\n[alpha user group](https://cloud.google.com/artifact-registry/docs/supported-formats#alpha-access).\n - `kms_key_name` (`string`): The Cloud KMS resource name of the customer managed encryption key that’s\nused to encrypt the contents of the Repository. Has the form:\n'projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key'.\nThis value may not be changed after the Repository has been created. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels with user-defined metadata.\nThis field may contain up to 64 entries. Label keys and values may be no\nlonger than 63 characters. Label keys must begin with a lowercase letter\nand may only contain lowercase letters, numeric characters, underscores,\nand dashes. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The name of the location this repository is located in. When `null`, the `location` field will be omitted from the resulting object.\n - `mode` (`string`): The mode configures the repository to serve artifacts from different sources. Default value: "STANDARD_REPOSITORY" Possible values: ["STANDARD_REPOSITORY", "VIRTUAL_REPOSITORY", "REMOTE_REPOSITORY"] When `null`, the `mode` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `repository_id` (`string`): The last part of the repository name, for example:\n"repo1"\n - `docker_config` (`list[obj]`): Docker repository config contains repository level configuration for the repositories of docker type. When `null`, the `docker_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.docker_config.new](#fn-docker_confignew) constructor.\n - `maven_config` (`list[obj]`): MavenRepositoryConfig is maven related repository details.\nProvides additional configuration details for repositories of the maven\nformat type. When `null`, the `maven_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.maven_config.new](#fn-maven_confignew) constructor.\n - `remote_repository_config` (`list[obj]`): Configuration specific for a Remote Repository. When `null`, the `remote_repository_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.remote_repository_config.new](#fn-remote_repository_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.timeouts.new](#fn-timeoutsnew) constructor.\n - `virtual_repository_config` (`list[obj]`): Configuration specific for a Virtual Repository. When `null`, the `virtual_repository_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.virtual_repository_config.new](#fn-virtual_repository_confignew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_artifact_registry_repository` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_artifact_registry_repository.newAttrs` constructs a new object with attributes and blocks configured for the `google_artifact_registry_repository`\nTerraform resource.\n\nUnlike [google-beta.google_artifact_registry_repository.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `cleanup_policy_dry_run` (`bool`): If true, the cleanup pipeline is prevented from deleting versions in this\nrepository. When `null`, the `cleanup_policy_dry_run` field will be omitted from the resulting object.\n - `description` (`string`): The user-provided description of the repository. When `null`, the `description` field will be omitted from the resulting object.\n - `format` (`string`): The format of packages that are stored in the repository. Supported formats\ncan be found [here](https://cloud.google.com/artifact-registry/docs/supported-formats).\nYou can only create alpha formats if you are a member of the\n[alpha user group](https://cloud.google.com/artifact-registry/docs/supported-formats#alpha-access).\n - `kms_key_name` (`string`): The Cloud KMS resource name of the customer managed encryption key that’s\nused to encrypt the contents of the Repository. Has the form:\n'projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key'.\nThis value may not be changed after the Repository has been created. When `null`, the `kms_key_name` field will be omitted from the resulting object.\n - `labels` (`obj`): Labels with user-defined metadata.\nThis field may contain up to 64 entries. Label keys and values may be no\nlonger than 63 characters. Label keys must begin with a lowercase letter\nand may only contain lowercase letters, numeric characters, underscores,\nand dashes. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The name of the location this repository is located in. When `null`, the `location` field will be omitted from the resulting object.\n - `mode` (`string`): The mode configures the repository to serve artifacts from different sources. Default value: "STANDARD_REPOSITORY" Possible values: ["STANDARD_REPOSITORY", "VIRTUAL_REPOSITORY", "REMOTE_REPOSITORY"] When `null`, the `mode` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `repository_id` (`string`): The last part of the repository name, for example:\n"repo1"\n - `cleanup_policies` (`list[obj]`): Cleanup policies for this repository. Cleanup policies indicate when\ncertain package versions can be automatically deleted.\nMap keys are policy IDs supplied by users during policy creation. They must\nunique within a repository and be under 128 characters in length. When `null`, the `cleanup_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.cleanup_policies.new](#fn-cleanup_policiesnew) constructor.\n - `docker_config` (`list[obj]`): Docker repository config contains repository level configuration for the repositories of docker type. When `null`, the `docker_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.docker_config.new](#fn-docker_confignew) constructor.\n - `maven_config` (`list[obj]`): MavenRepositoryConfig is maven related repository details.\nProvides additional configuration details for repositories of the maven\nformat type. When `null`, the `maven_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.maven_config.new](#fn-maven_confignew) constructor.\n - `remote_repository_config` (`list[obj]`): Configuration specific for a Remote Repository. When `null`, the `remote_repository_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.remote_repository_config.new](#fn-remote_repository_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.timeouts.new](#fn-timeoutsnew) constructor.\n - `virtual_repository_config` (`list[obj]`): Configuration specific for a Virtual Repository. When `null`, the `virtual_repository_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.virtual_repository_config.new](#fn-virtual_repository_confignew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_artifact_registry_repository` resource into the root Terraform configuration.\n', args=[]), newAttrs( format, repository_id, + cleanup_policies=null, + cleanup_policy_dry_run=null, description=null, docker_config=null, kms_key_name=null, @@ -73,6 +119,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts=null, virtual_repository_config=null ):: std.prune(a={ + cleanup_policies: cleanup_policies, + cleanup_policy_dry_run: cleanup_policy_dry_run, description: description, docker_config: docker_config, format: format, @@ -165,6 +213,36 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, + '#withCleanupPolicies':: d.fn(help='`google-beta.list[obj].withCleanupPolicies` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the cleanup_policies field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google-beta.list[obj].withCleanupPoliciesMixin](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 `cleanup_policies` field.\n', args=[]), + withCleanupPolicies(resourceLabel, value): { + resource+: { + google_artifact_registry_repository+: { + [resourceLabel]+: { + cleanup_policies: value, + }, + }, + }, + }, + '#withCleanupPoliciesMixin':: d.fn(help='`google-beta.list[obj].withCleanupPoliciesMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the cleanup_policies field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google-beta.list[obj].withCleanupPolicies](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 `cleanup_policies` field.\n', args=[]), + withCleanupPoliciesMixin(resourceLabel, value): { + resource+: { + google_artifact_registry_repository+: { + [resourceLabel]+: { + cleanup_policies+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withCleanupPolicyDryRun':: d.fn(help='`google-beta.bool.withCleanupPolicyDryRun` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the cleanup_policy_dry_run 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 `cleanup_policy_dry_run` field.\n', args=[]), + withCleanupPolicyDryRun(resourceLabel, value): { + resource+: { + google_artifact_registry_repository+: { + [resourceLabel]+: { + cleanup_policy_dry_run: value, + }, + }, + }, + }, '#withDescription':: d.fn(help='`google-beta.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), withDescription(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/bigquery_bi_reservation.libsonnet b/4.x/_gen/resources/bigquery_bi_reservation.libsonnet new file mode 100644 index 0000000..2a13284 --- /dev/null +++ b/4.x/_gen/resources/bigquery_bi_reservation.libsonnet @@ -0,0 +1,134 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='google_bigquery_bi_reservation', url='', help='`google_bigquery_bi_reservation` represents the `google-beta_google_bigquery_bi_reservation` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google-beta.google_bigquery_bi_reservation.new` injects a new `google-beta_google_bigquery_bi_reservation` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_bigquery_bi_reservation.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_bigquery_bi_reservation` using the reference:\n\n $._ref.google-beta_google_bigquery_bi_reservation.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_bigquery_bi_reservation.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `location` (`string`): LOCATION_DESCRIPTION\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 - `size` (`number`): Size of a reservation, in bytes. When `null`, the `size` field will be omitted from the resulting object.\n - `preferred_tables` (`list[obj]`): Preferred tables to use BI capacity for. When `null`, the `preferred_tables` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_bigquery_bi_reservation.preferred_tables.new](#fn-preferred_tablesnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_bigquery_bi_reservation.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, + preferred_tables=null, + project=null, + size=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_bigquery_bi_reservation', + label=resourceLabel, + attrs=self.newAttrs( + location=location, + preferred_tables=preferred_tables, + project=project, + size=size, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_bigquery_bi_reservation.newAttrs` constructs a new object with attributes and blocks configured for the `google_bigquery_bi_reservation`\nTerraform resource.\n\nUnlike [google-beta.google_bigquery_bi_reservation.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `location` (`string`): LOCATION_DESCRIPTION\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `size` (`number`): Size of a reservation, in bytes. When `null`, the `size` field will be omitted from the resulting object.\n - `preferred_tables` (`list[obj]`): Preferred tables to use BI capacity for. When `null`, the `preferred_tables` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_bigquery_bi_reservation.preferred_tables.new](#fn-preferred_tablesnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_bigquery_bi_reservation.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_bigquery_bi_reservation` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + location, + preferred_tables=null, + project=null, + size=null, + timeouts=null + ):: std.prune(a={ + location: location, + preferred_tables: preferred_tables, + project: project, + size: size, + timeouts: timeouts, + }), + preferred_tables:: { + '#new':: d.fn(help='\n`google-beta.google_bigquery_bi_reservation.preferred_tables.new` constructs a new object with attributes and blocks configured for the `preferred_tables`\nTerraform sub block.\n\n\n\n**Args**:\n - `dataset_id` (`string`): The ID of the dataset in the above project. When `null`, the `dataset_id` field will be omitted from the resulting object.\n - `project_id` (`string`): The assigned project ID of the project. When `null`, the `project_id` field will be omitted from the resulting object.\n - `table_id` (`string`): The ID of the table in the above dataset. When `null`, the `table_id` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `preferred_tables` sub block.\n', args=[]), + new( + dataset_id=null, + project_id=null, + table_id=null + ):: std.prune(a={ + dataset_id: dataset_id, + project_id: project_id, + table_id: table_id, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_bigquery_bi_reservation.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, + }), + }, + '#withLocation':: d.fn(help='`google-beta.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_bigquery_bi_reservation+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withPreferredTables':: d.fn(help='`google-beta.list[obj].withPreferredTables` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the preferred_tables field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google-beta.list[obj].withPreferredTablesMixin](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 `preferred_tables` field.\n', args=[]), + withPreferredTables(resourceLabel, value): { + resource+: { + google_bigquery_bi_reservation+: { + [resourceLabel]+: { + preferred_tables: value, + }, + }, + }, + }, + '#withPreferredTablesMixin':: d.fn(help='`google-beta.list[obj].withPreferredTablesMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the preferred_tables field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google-beta.list[obj].withPreferredTables](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 `preferred_tables` field.\n', args=[]), + withPreferredTablesMixin(resourceLabel, value): { + resource+: { + google_bigquery_bi_reservation+: { + [resourceLabel]+: { + preferred_tables+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_bigquery_bi_reservation+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withSize':: d.fn(help='`google-beta.number.withSize` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the size field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`number`): The value to set for the `size` field.\n', args=[]), + withSize(resourceLabel, value): { + resource+: { + google_bigquery_bi_reservation+: { + [resourceLabel]+: { + size: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google-beta.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_bigquery_bi_reservation+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google-beta.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_bigquery_bi_reservation+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/certificate_manager_certificate.libsonnet b/4.x/_gen/resources/certificate_manager_certificate.libsonnet index 007c25b..da45097 100644 --- a/4.x/_gen/resources/certificate_manager_certificate.libsonnet +++ b/4.x/_gen/resources/certificate_manager_certificate.libsonnet @@ -66,7 +66,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), self_managed:: { - '#new':: d.fn(help='\n`google-beta.google_certificate_manager_certificate.self_managed.new` constructs a new object with attributes and blocks configured for the `self_managed`\nTerraform sub block.\n\n\n\n**Args**:\n - `certificate_pem` (`string`): **Deprecated** The certificate chain in PEM-encoded form.\n\nLeaf certificate comes first, followed by intermediate ones if any. When `null`, the `certificate_pem` field will be omitted from the resulting object.\n - `pem_certificate` (`string`): The certificate chain in PEM-encoded form.\n\nLeaf certificate comes first, followed by intermediate ones if any. When `null`, the `pem_certificate` field will be omitted from the resulting object.\n - `pem_private_key` (`string`): The private key of the leaf certificate in PEM-encoded form. When `null`, the `pem_private_key` field will be omitted from the resulting object.\n - `private_key_pem` (`string`): **Deprecated** The private key of the leaf certificate in PEM-encoded form. When `null`, the `private_key_pem` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `self_managed` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_certificate_manager_certificate.self_managed.new` constructs a new object with attributes and blocks configured for the `self_managed`\nTerraform sub block.\n\n\n\n**Args**:\n - `certificate_pem` (`string`): The certificate chain in PEM-encoded form.\n\nLeaf certificate comes first, followed by intermediate ones if any. When `null`, the `certificate_pem` field will be omitted from the resulting object.\n - `pem_certificate` (`string`): The certificate chain in PEM-encoded form.\n\nLeaf certificate comes first, followed by intermediate ones if any. When `null`, the `pem_certificate` field will be omitted from the resulting object.\n - `pem_private_key` (`string`): The private key of the leaf certificate in PEM-encoded form. When `null`, the `pem_private_key` field will be omitted from the resulting object.\n - `private_key_pem` (`string`): The private key of the leaf certificate in PEM-encoded form. When `null`, the `private_key_pem` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `self_managed` sub block.\n', args=[]), new( certificate_pem=null, pem_certificate=null, diff --git a/4.x/_gen/resources/certificate_manager_trust_config.libsonnet b/4.x/_gen/resources/certificate_manager_trust_config.libsonnet new file mode 100644 index 0000000..6020f31 --- /dev/null +++ b/4.x/_gen/resources/certificate_manager_trust_config.libsonnet @@ -0,0 +1,176 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='google_certificate_manager_trust_config', url='', help='`google_certificate_manager_trust_config` represents the `google-beta_google_certificate_manager_trust_config` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google-beta.google_certificate_manager_trust_config.new` injects a new `google-beta_google_certificate_manager_trust_config` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_certificate_manager_trust_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_certificate_manager_trust_config` using the reference:\n\n $._ref.google-beta_google_certificate_manager_trust_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_certificate_manager_trust_config.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): One or more paragraphs of text description of a trust config. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the trust config. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The trust config location.\n - `name` (`string`): A user-defined name of the trust config. Trust config names must be unique globally.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.timeouts.new](#fn-timeoutsnew) constructor.\n - `trust_stores` (`list[obj]`): Set of trust stores to perform validation against.\nThis field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. When `null`, the `trust_stores` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.trust_stores.new](#fn-trust_storesnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + location, + name, + description=null, + labels=null, + project=null, + timeouts=null, + trust_stores=null, + _meta={} + ):: tf.withResource( + type='google_certificate_manager_trust_config', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + labels=labels, + location=location, + name=name, + project=project, + timeouts=timeouts, + trust_stores=trust_stores + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_certificate_manager_trust_config.newAttrs` constructs a new object with attributes and blocks configured for the `google_certificate_manager_trust_config`\nTerraform resource.\n\nUnlike [google-beta.google_certificate_manager_trust_config.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): One or more paragraphs of text description of a trust config. When `null`, the `description` field will be omitted from the resulting object.\n - `labels` (`obj`): Set of label tags associated with the trust config. When `null`, the `labels` field will be omitted from the resulting object.\n - `location` (`string`): The trust config location.\n - `name` (`string`): A user-defined name of the trust config. Trust config names must be unique globally.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.timeouts.new](#fn-timeoutsnew) constructor.\n - `trust_stores` (`list[obj]`): Set of trust stores to perform validation against.\nThis field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. When `null`, the `trust_stores` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.trust_stores.new](#fn-trust_storesnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_certificate_manager_trust_config` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + location, + name, + description=null, + labels=null, + project=null, + timeouts=null, + trust_stores=null + ):: std.prune(a={ + description: description, + labels: labels, + location: location, + name: name, + project: project, + timeouts: timeouts, + trust_stores: trust_stores, + }), + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_certificate_manager_trust_config.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + trust_stores:: { + intermediate_cas:: { + '#new':: d.fn(help='\n`google-beta.google_certificate_manager_trust_config.trust_stores.intermediate_cas.new` constructs a new object with attributes and blocks configured for the `intermediate_cas`\nTerraform sub block.\n\n\n\n**Args**:\n - `pem_certificate` (`string`): PEM intermediate certificate used for building up paths for validation.\nEach certificate provided in PEM format may occupy up to 5kB. When `null`, the `pem_certificate` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `intermediate_cas` sub block.\n', args=[]), + new( + pem_certificate=null + ):: std.prune(a={ + pem_certificate: pem_certificate, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_certificate_manager_trust_config.trust_stores.new` constructs a new object with attributes and blocks configured for the `trust_stores`\nTerraform sub block.\n\n\n\n**Args**:\n - `intermediate_cas` (`list[obj]`): Set of intermediate CA certificates used for the path building phase of chain validation.\nThe field is currently not supported if trust config is used for the workload certificate feature. When `null`, the `intermediate_cas` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.trust_stores.intermediate_cas.new](#fn-trust_storesintermediate_casnew) constructor.\n - `trust_anchors` (`list[obj]`): List of Trust Anchors to be used while performing validation against a given TrustStore. When `null`, the `trust_anchors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.trust_stores.trust_anchors.new](#fn-trust_storestrust_anchorsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `trust_stores` sub block.\n', args=[]), + new( + intermediate_cas=null, + trust_anchors=null + ):: std.prune(a={ + intermediate_cas: intermediate_cas, + trust_anchors: trust_anchors, + }), + trust_anchors:: { + '#new':: d.fn(help='\n`google-beta.google_certificate_manager_trust_config.trust_stores.trust_anchors.new` constructs a new object with attributes and blocks configured for the `trust_anchors`\nTerraform sub block.\n\n\n\n**Args**:\n - `pem_certificate` (`string`): PEM root certificate of the PKI used for validation.\nEach certificate provided in PEM format may occupy up to 5kB. When `null`, the `pem_certificate` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `trust_anchors` sub block.\n', args=[]), + new( + pem_certificate=null + ):: std.prune(a={ + pem_certificate: pem_certificate, + }), + }, + }, + '#withDescription':: d.fn(help='`google-beta.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + google_certificate_manager_trust_config+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withLabels':: d.fn(help='`google-beta.obj.withLabels` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the labels field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `labels` field.\n', args=[]), + withLabels(resourceLabel, value): { + resource+: { + google_certificate_manager_trust_config+: { + [resourceLabel]+: { + labels: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google-beta.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_certificate_manager_trust_config+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google-beta.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_certificate_manager_trust_config+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_certificate_manager_trust_config+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google-beta.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_certificate_manager_trust_config+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google-beta.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_certificate_manager_trust_config+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withTrustStores':: d.fn(help='`google-beta.list[obj].withTrustStores` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the trust_stores field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google-beta.list[obj].withTrustStoresMixin](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 `trust_stores` field.\n', args=[]), + withTrustStores(resourceLabel, value): { + resource+: { + google_certificate_manager_trust_config+: { + [resourceLabel]+: { + trust_stores: value, + }, + }, + }, + }, + '#withTrustStoresMixin':: d.fn(help='`google-beta.list[obj].withTrustStoresMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the trust_stores field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google-beta.list[obj].withTrustStores](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 `trust_stores` field.\n', args=[]), + withTrustStoresMixin(resourceLabel, value): { + resource+: { + google_certificate_manager_trust_config+: { + [resourceLabel]+: { + trust_stores+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/compute_router_peer.libsonnet b/4.x/_gen/resources/compute_router_peer.libsonnet index db94f1c..026bcbb 100644 --- a/4.x/_gen/resources/compute_router_peer.libsonnet +++ b/4.x/_gen/resources/compute_router_peer.libsonnet @@ -26,7 +26,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); session_initialization_mode: session_initialization_mode, }), }, - '#new':: d.fn(help="\n`google-beta.google_compute_router_peer.new` injects a new `google-beta_google_compute_router_peer` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_compute_router_peer.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_router_peer` using the reference:\n\n $._ref.google-beta_google_compute_router_peer.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_router_peer.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `advertise_mode` (`string`): User-specified flag to indicate which mode to use for advertisement.\nValid values of this enum field are: \u0026#39;DEFAULT\u0026#39;, \u0026#39;CUSTOM\u0026#39; Default value: \u0026#34;DEFAULT\u0026#34; Possible values: [\u0026#34;DEFAULT\u0026#34;, \u0026#34;CUSTOM\u0026#34;] When `null`, the `advertise_mode` field will be omitted from the resulting object.\n - `advertised_groups` (`list`): User-specified list of prefix groups to advertise in custom\nmode, which can take one of the following options:\n\n* \u0026#39;ALL_SUBNETS\u0026#39;: Advertises all available subnets, including peer VPC subnets.\n* \u0026#39;ALL_VPC_SUBNETS\u0026#39;: Advertises the router\u0026#39;s own VPC subnets.\n* \u0026#39;ALL_PEER_VPC_SUBNETS\u0026#39;: Advertises peer subnets of the router\u0026#39;s VPC network.\n\n\nNote that this field can only be populated if advertiseMode is \u0026#39;CUSTOM\u0026#39;\nand overrides the list defined for the router (in the \u0026#34;bgp\u0026#34; message).\nThese groups are advertised in addition to any specified prefixes.\nLeave this field blank to advertise no custom groups. When `null`, the `advertised_groups` field will be omitted from the resulting object.\n - `advertised_route_priority` (`number`): The priority of routes advertised to this BGP peer.\nWhere there is more than one matching route of maximum\nlength, the routes with the lowest priority value win. When `null`, the `advertised_route_priority` field will be omitted from the resulting object.\n - `enable` (`bool`): The status of the BGP peer connection. If set to false, any active session\nwith the peer is terminated and all associated routing information is removed.\nIf set to true, the peer connection can be established with routing information.\nThe default is true. When `null`, the `enable` field will be omitted from the resulting object.\n - `enable_ipv6` (`bool`): Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. When `null`, the `enable_ipv6` field will be omitted from the resulting object.\n - `interface` (`string`): Name of the interface the BGP peer is associated with.\n - `ip_address` (`string`): IP address of the interface inside Google Cloud Platform.\nOnly IPv4 is supported. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ipv6_nexthop_address` (`string`): IPv6 address of the interface inside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `ipv6_nexthop_address` field will be omitted from the resulting object.\n - `name` (`string`): Name of this BGP peer. The name must be 1-63 characters long,\nand comply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which\nmeans the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `peer_asn` (`number`): Peer BGP Autonomous System Number (ASN).\nEach BGP interface may use a different value.\n - `peer_ip_address` (`string`): IP address of the BGP interface outside Google Cloud Platform.\nOnly IPv4 is supported. Required if \u0026#39;ip_address\u0026#39; is set. When `null`, the `peer_ip_address` field will be omitted from the resulting object.\n - `peer_ipv6_nexthop_address` (`string`): IPv6 address of the BGP interface outside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `peer_ipv6_nexthop_address` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): Region where the router and BgpPeer reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `router` (`string`): The name of the Cloud Router in which this BgpPeer will be configured.\n - `router_appliance_instance` (`string`): The URI of the VM instance that is used as third-party router appliances\nsuch as Next Gen Firewalls, Virtual Routers, or Router Appliances.\nThe VM instance must be located in zones contained in the same region as\nthis Cloud Router. The VM instance is the peer side of the BGP session. When `null`, the `router_appliance_instance` field will be omitted from the resulting object.\n - `advertised_ip_ranges` (`list[obj]`): User-specified list of individual IP ranges to advertise in\ncustom mode. This field can only be populated if advertiseMode\nis \u0026#39;CUSTOM\u0026#39; and is advertised to all peers of the router. These IP\nranges will be advertised in addition to any specified groups.\nLeave this field blank to advertise no custom IP ranges. When `null`, the `advertised_ip_ranges` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.advertised_ip_ranges.new](#fn-advertised_ip_rangesnew) constructor.\n - `bfd` (`list[obj]`): BFD configuration for the BGP peering. When `null`, the `bfd` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.bfd.new](#fn-bfdnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_compute_router_peer.new` injects a new `google-beta_google_compute_router_peer` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_compute_router_peer.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_router_peer` using the reference:\n\n $._ref.google-beta_google_compute_router_peer.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_router_peer.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `advertise_mode` (`string`): User-specified flag to indicate which mode to use for advertisement.\nValid values of this enum field are: \u0026#39;DEFAULT\u0026#39;, \u0026#39;CUSTOM\u0026#39; Default value: \u0026#34;DEFAULT\u0026#34; Possible values: [\u0026#34;DEFAULT\u0026#34;, \u0026#34;CUSTOM\u0026#34;] When `null`, the `advertise_mode` field will be omitted from the resulting object.\n - `advertised_groups` (`list`): User-specified list of prefix groups to advertise in custom\nmode, which currently supports the following option:\n\n* \u0026#39;ALL_SUBNETS\u0026#39;: Advertises all of the router\u0026#39;s own VPC subnets.\nThis excludes any routes learned for subnets that use VPC Network\nPeering.\n\n\nNote that this field can only be populated if advertiseMode is \u0026#39;CUSTOM\u0026#39;\nand overrides the list defined for the router (in the \u0026#34;bgp\u0026#34; message).\nThese groups are advertised in addition to any specified prefixes.\nLeave this field blank to advertise no custom groups. When `null`, the `advertised_groups` field will be omitted from the resulting object.\n - `advertised_route_priority` (`number`): The priority of routes advertised to this BGP peer.\nWhere there is more than one matching route of maximum\nlength, the routes with the lowest priority value win. When `null`, the `advertised_route_priority` field will be omitted from the resulting object.\n - `enable` (`bool`): The status of the BGP peer connection. If set to false, any active session\nwith the peer is terminated and all associated routing information is removed.\nIf set to true, the peer connection can be established with routing information.\nThe default is true. When `null`, the `enable` field will be omitted from the resulting object.\n - `enable_ipv6` (`bool`): Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. When `null`, the `enable_ipv6` field will be omitted from the resulting object.\n - `interface` (`string`): Name of the interface the BGP peer is associated with.\n - `ip_address` (`string`): IP address of the interface inside Google Cloud Platform.\nOnly IPv4 is supported. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ipv6_nexthop_address` (`string`): IPv6 address of the interface inside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `ipv6_nexthop_address` field will be omitted from the resulting object.\n - `name` (`string`): Name of this BGP peer. The name must be 1-63 characters long,\nand comply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression \u0026#39;[a-z]([-a-z0-9]*[a-z0-9])?\u0026#39; which\nmeans the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `peer_asn` (`number`): Peer BGP Autonomous System Number (ASN).\nEach BGP interface may use a different value.\n - `peer_ip_address` (`string`): IP address of the BGP interface outside Google Cloud Platform.\nOnly IPv4 is supported. Required if \u0026#39;ip_address\u0026#39; is set. When `null`, the `peer_ip_address` field will be omitted from the resulting object.\n - `peer_ipv6_nexthop_address` (`string`): IPv6 address of the BGP interface outside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `peer_ipv6_nexthop_address` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): Region where the router and BgpPeer reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `router` (`string`): The name of the Cloud Router in which this BgpPeer will be configured.\n - `router_appliance_instance` (`string`): The URI of the VM instance that is used as third-party router appliances\nsuch as Next Gen Firewalls, Virtual Routers, or Router Appliances.\nThe VM instance must be located in zones contained in the same region as\nthis Cloud Router. The VM instance is the peer side of the BGP session. When `null`, the `router_appliance_instance` field will be omitted from the resulting object.\n - `advertised_ip_ranges` (`list[obj]`): User-specified list of individual IP ranges to advertise in\ncustom mode. This field can only be populated if advertiseMode\nis \u0026#39;CUSTOM\u0026#39; and is advertised to all peers of the router. These IP\nranges will be advertised in addition to any specified groups.\nLeave this field blank to advertise no custom IP ranges. When `null`, the `advertised_ip_ranges` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.advertised_ip_ranges.new](#fn-advertised_ip_rangesnew) constructor.\n - `bfd` (`list[obj]`): BFD configuration for the BGP peering. When `null`, the `bfd` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.bfd.new](#fn-bfdnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, interface, @@ -75,7 +75,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_router_peer.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_router_peer`\nTerraform resource.\n\nUnlike [google-beta.google_compute_router_peer.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `advertise_mode` (`string`): User-specified flag to indicate which mode to use for advertisement.\nValid values of this enum field are: 'DEFAULT', 'CUSTOM' Default value: "DEFAULT" Possible values: ["DEFAULT", "CUSTOM"] When `null`, the `advertise_mode` field will be omitted from the resulting object.\n - `advertised_groups` (`list`): User-specified list of prefix groups to advertise in custom\nmode, which can take one of the following options:\n\n* 'ALL_SUBNETS': Advertises all available subnets, including peer VPC subnets.\n* 'ALL_VPC_SUBNETS': Advertises the router's own VPC subnets.\n* 'ALL_PEER_VPC_SUBNETS': Advertises peer subnets of the router's VPC network.\n\n\nNote that this field can only be populated if advertiseMode is 'CUSTOM'\nand overrides the list defined for the router (in the "bgp" message).\nThese groups are advertised in addition to any specified prefixes.\nLeave this field blank to advertise no custom groups. When `null`, the `advertised_groups` field will be omitted from the resulting object.\n - `advertised_route_priority` (`number`): The priority of routes advertised to this BGP peer.\nWhere there is more than one matching route of maximum\nlength, the routes with the lowest priority value win. When `null`, the `advertised_route_priority` field will be omitted from the resulting object.\n - `enable` (`bool`): The status of the BGP peer connection. If set to false, any active session\nwith the peer is terminated and all associated routing information is removed.\nIf set to true, the peer connection can be established with routing information.\nThe default is true. When `null`, the `enable` field will be omitted from the resulting object.\n - `enable_ipv6` (`bool`): Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. When `null`, the `enable_ipv6` field will be omitted from the resulting object.\n - `interface` (`string`): Name of the interface the BGP peer is associated with.\n - `ip_address` (`string`): IP address of the interface inside Google Cloud Platform.\nOnly IPv4 is supported. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ipv6_nexthop_address` (`string`): IPv6 address of the interface inside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `ipv6_nexthop_address` field will be omitted from the resulting object.\n - `name` (`string`): Name of this BGP peer. The name must be 1-63 characters long,\nand comply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which\nmeans the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `peer_asn` (`number`): Peer BGP Autonomous System Number (ASN).\nEach BGP interface may use a different value.\n - `peer_ip_address` (`string`): IP address of the BGP interface outside Google Cloud Platform.\nOnly IPv4 is supported. Required if 'ip_address' is set. When `null`, the `peer_ip_address` field will be omitted from the resulting object.\n - `peer_ipv6_nexthop_address` (`string`): IPv6 address of the BGP interface outside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `peer_ipv6_nexthop_address` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): Region where the router and BgpPeer reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `router` (`string`): The name of the Cloud Router in which this BgpPeer will be configured.\n - `router_appliance_instance` (`string`): The URI of the VM instance that is used as third-party router appliances\nsuch as Next Gen Firewalls, Virtual Routers, or Router Appliances.\nThe VM instance must be located in zones contained in the same region as\nthis Cloud Router. The VM instance is the peer side of the BGP session. When `null`, the `router_appliance_instance` field will be omitted from the resulting object.\n - `advertised_ip_ranges` (`list[obj]`): User-specified list of individual IP ranges to advertise in\ncustom mode. This field can only be populated if advertiseMode\nis 'CUSTOM' and is advertised to all peers of the router. These IP\nranges will be advertised in addition to any specified groups.\nLeave this field blank to advertise no custom IP ranges. When `null`, the `advertised_ip_ranges` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.advertised_ip_ranges.new](#fn-advertised_ip_rangesnew) constructor.\n - `bfd` (`list[obj]`): BFD configuration for the BGP peering. When `null`, the `bfd` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.bfd.new](#fn-bfdnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_compute_router_peer` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_router_peer.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_router_peer`\nTerraform resource.\n\nUnlike [google-beta.google_compute_router_peer.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `advertise_mode` (`string`): User-specified flag to indicate which mode to use for advertisement.\nValid values of this enum field are: 'DEFAULT', 'CUSTOM' Default value: "DEFAULT" Possible values: ["DEFAULT", "CUSTOM"] When `null`, the `advertise_mode` field will be omitted from the resulting object.\n - `advertised_groups` (`list`): User-specified list of prefix groups to advertise in custom\nmode, which currently supports the following option:\n\n* 'ALL_SUBNETS': Advertises all of the router's own VPC subnets.\nThis excludes any routes learned for subnets that use VPC Network\nPeering.\n\n\nNote that this field can only be populated if advertiseMode is 'CUSTOM'\nand overrides the list defined for the router (in the "bgp" message).\nThese groups are advertised in addition to any specified prefixes.\nLeave this field blank to advertise no custom groups. When `null`, the `advertised_groups` field will be omitted from the resulting object.\n - `advertised_route_priority` (`number`): The priority of routes advertised to this BGP peer.\nWhere there is more than one matching route of maximum\nlength, the routes with the lowest priority value win. When `null`, the `advertised_route_priority` field will be omitted from the resulting object.\n - `enable` (`bool`): The status of the BGP peer connection. If set to false, any active session\nwith the peer is terminated and all associated routing information is removed.\nIf set to true, the peer connection can be established with routing information.\nThe default is true. When `null`, the `enable` field will be omitted from the resulting object.\n - `enable_ipv6` (`bool`): Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. When `null`, the `enable_ipv6` field will be omitted from the resulting object.\n - `interface` (`string`): Name of the interface the BGP peer is associated with.\n - `ip_address` (`string`): IP address of the interface inside Google Cloud Platform.\nOnly IPv4 is supported. When `null`, the `ip_address` field will be omitted from the resulting object.\n - `ipv6_nexthop_address` (`string`): IPv6 address of the interface inside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `ipv6_nexthop_address` field will be omitted from the resulting object.\n - `name` (`string`): Name of this BGP peer. The name must be 1-63 characters long,\nand comply with RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which\nmeans the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit,\nexcept the last character, which cannot be a dash.\n - `peer_asn` (`number`): Peer BGP Autonomous System Number (ASN).\nEach BGP interface may use a different value.\n - `peer_ip_address` (`string`): IP address of the BGP interface outside Google Cloud Platform.\nOnly IPv4 is supported. Required if 'ip_address' is set. When `null`, the `peer_ip_address` field will be omitted from the resulting object.\n - `peer_ipv6_nexthop_address` (`string`): IPv6 address of the BGP interface outside Google Cloud Platform.\nThe address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64.\nIf you do not specify the next hop addresses, Google Cloud automatically\nassigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. When `null`, the `peer_ipv6_nexthop_address` field will be omitted from the resulting object.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): Region where the router and BgpPeer reside.\nIf it is not provided, the provider region is used. When `null`, the `region` field will be omitted from the resulting object.\n - `router` (`string`): The name of the Cloud Router in which this BgpPeer will be configured.\n - `router_appliance_instance` (`string`): The URI of the VM instance that is used as third-party router appliances\nsuch as Next Gen Firewalls, Virtual Routers, or Router Appliances.\nThe VM instance must be located in zones contained in the same region as\nthis Cloud Router. The VM instance is the peer side of the BGP session. When `null`, the `router_appliance_instance` field will be omitted from the resulting object.\n - `advertised_ip_ranges` (`list[obj]`): User-specified list of individual IP ranges to advertise in\ncustom mode. This field can only be populated if advertiseMode\nis 'CUSTOM' and is advertised to all peers of the router. These IP\nranges will be advertised in addition to any specified groups.\nLeave this field blank to advertise no custom IP ranges. When `null`, the `advertised_ip_ranges` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.advertised_ip_ranges.new](#fn-advertised_ip_rangesnew) constructor.\n - `bfd` (`list[obj]`): BFD configuration for the BGP peering. When `null`, the `bfd` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.bfd.new](#fn-bfdnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_router_peer.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_compute_router_peer` resource into the root Terraform configuration.\n', args=[]), newAttrs( interface, name, diff --git a/4.x/_gen/resources/compute_target_instance.libsonnet b/4.x/_gen/resources/compute_target_instance.libsonnet index 53a63eb..49e45ff 100644 --- a/4.x/_gen/resources/compute_target_instance.libsonnet +++ b/4.x/_gen/resources/compute_target_instance.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_compute_target_instance', url='', help='`google_compute_target_instance` represents the `google-beta_google_compute_target_instance` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google-beta.google_compute_target_instance.new` injects a new `google-beta_google_compute_target_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_compute_target_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_target_instance` using the reference:\n\n $._ref.google-beta_google_compute_target_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_target_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `instance` (`string`): The Compute instance VM handling traffic for this target instance.\nAccepts the instance self-link, relative path\n(e.g. \u0026#39;projects/project/zones/zone/instances/instance\u0026#39;) or name. If\nname is given, the zone will default to the given zone or\nthe provider-default zone and the project will default to the\nprovider-level project.\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 - `nat_policy` (`string`): NAT option controlling how IPs are NAT\u0026#39;ed to the instance.\nCurrently only NO_NAT (default value) is supported. Default value: \u0026#34;NO_NAT\u0026#34; Possible values: [\u0026#34;NO_NAT\u0026#34;] When `null`, the `nat_policy` field will be omitted from the resulting object.\n - `network` (`string`): The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to. 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 - `zone` (`string`): URL of the zone where the target instance resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_compute_target_instance.new` injects a new `google-beta_google_compute_target_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_compute_target_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_target_instance` using the reference:\n\n $._ref.google-beta_google_compute_target_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_target_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `instance` (`string`): The Compute instance VM handling traffic for this target instance.\nAccepts the instance self-link, relative path\n(e.g. \u0026#39;projects/project/zones/zone/instances/instance\u0026#39;) or name. If\nname is given, the zone will default to the given zone or\nthe provider-default zone and the project will default to the\nprovider-level project.\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 - `nat_policy` (`string`): NAT option controlling how IPs are NAT\u0026#39;ed to the instance.\nCurrently only NO_NAT (default value) is supported. Default value: \u0026#34;NO_NAT\u0026#34; Possible values: [\u0026#34;NO_NAT\u0026#34;] When `null`, the `nat_policy` field will be omitted from the resulting object.\n - `network` (`string`): The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to. 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 - `security_policy` (`string`): The resource URL for the security policy associated with this target instance. When `null`, the `security_policy` field will be omitted from the resulting object.\n - `zone` (`string`): URL of the zone where the target instance resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, instance, @@ -11,6 +11,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); nat_policy=null, network=null, project=null, + security_policy=null, timeouts=null, zone=null, _meta={} @@ -24,12 +25,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); nat_policy=nat_policy, network=network, project=project, + security_policy=security_policy, timeouts=timeouts, zone=zone ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_target_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_target_instance`\nTerraform resource.\n\nUnlike [google-beta.google_compute_target_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `instance` (`string`): The Compute instance VM handling traffic for this target instance.\nAccepts the instance self-link, relative path\n(e.g. 'projects/project/zones/zone/instances/instance') or name. If\nname is given, the zone will default to the given zone or\nthe provider-default zone and the project will default to the\nprovider-level project.\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 - `nat_policy` (`string`): NAT option controlling how IPs are NAT'ed to the instance.\nCurrently only NO_NAT (default value) is supported. Default value: "NO_NAT" Possible values: ["NO_NAT"] When `null`, the `nat_policy` field will be omitted from the resulting object.\n - `network` (`string`): The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to. 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 - `zone` (`string`): URL of the zone where the target instance resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_compute_target_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_target_instance.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_target_instance`\nTerraform resource.\n\nUnlike [google-beta.google_compute_target_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): An optional description of this resource. When `null`, the `description` field will be omitted from the resulting object.\n - `instance` (`string`): The Compute instance VM handling traffic for this target instance.\nAccepts the instance self-link, relative path\n(e.g. 'projects/project/zones/zone/instances/instance') or name. If\nname is given, the zone will default to the given zone or\nthe provider-default zone and the project will default to the\nprovider-level project.\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 - `nat_policy` (`string`): NAT option controlling how IPs are NAT'ed to the instance.\nCurrently only NO_NAT (default value) is supported. Default value: "NO_NAT" Possible values: ["NO_NAT"] When `null`, the `nat_policy` field will be omitted from the resulting object.\n - `network` (`string`): The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to. 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 - `security_policy` (`string`): The resource URL for the security policy associated with this target instance. When `null`, the `security_policy` field will be omitted from the resulting object.\n - `zone` (`string`): URL of the zone where the target instance resides. When `null`, the `zone` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_compute_target_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( instance, name, @@ -37,6 +39,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); nat_policy=null, network=null, project=null, + security_policy=null, timeouts=null, zone=null ):: std.prune(a={ @@ -46,17 +49,20 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); nat_policy: nat_policy, network: network, project: project, + security_policy: security_policy, timeouts: timeouts, zone: zone, }), timeouts:: { - '#new':: d.fn(help='\n`google-beta.google_compute_target_instance.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_compute_target_instance.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `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 + delete=null, + update=null ):: std.prune(a={ create: create, delete: delete, + update: update, }), }, '#withDescription':: d.fn(help='`google-beta.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), @@ -119,6 +125,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSecurityPolicy':: d.fn(help='`google-beta.string.withSecurityPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the security_policy field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `security_policy` field.\n', args=[]), + withSecurityPolicy(resourceLabel, value): { + resource+: { + google_compute_target_instance+: { + [resourceLabel]+: { + security_policy: value, + }, + }, + }, + }, '#withTimeouts':: d.fn(help='`google-beta.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google-beta.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), withTimeouts(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/compute_target_pool.libsonnet b/4.x/_gen/resources/compute_target_pool.libsonnet index 25f6ff7..c881ad1 100644 --- a/4.x/_gen/resources/compute_target_pool.libsonnet +++ b/4.x/_gen/resources/compute_target_pool.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_compute_target_pool', url='', help='`google_compute_target_pool` represents the `google-beta_google_compute_target_pool` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google-beta.google_compute_target_pool.new` injects a new `google-beta_google_compute_target_pool` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_compute_target_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_target_pool` using the reference:\n\n $._ref.google-beta_google_compute_target_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_target_pool.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `backup_pool` (`string`): URL to the backup target pool. Must also set failover_ratio. When `null`, the `backup_pool` field will be omitted from the resulting object.\n - `description` (`string`): Textual description field. When `null`, the `description` field will be omitted from the resulting object.\n - `failover_ratio` (`number`): Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set). When `null`, the `failover_ratio` field will be omitted from the resulting object.\n - `health_checks` (`list`): List of zero or one health check name or self_link. Only legacy google_compute_http_health_check is supported. When `null`, the `health_checks` field will be omitted from the resulting object.\n - `instances` (`list`): List of instances in the pool. They can be given as URLs, or in the form of \u0026#34;zone/name\u0026#34;. Note that the instances need not exist at the time of target pool creation, so there is no need to use the Terraform interpolators to create a dependency on the instances from the target pool. When `null`, the `instances` field will be omitted from the resulting object.\n - `name` (`string`): A unique name for the resource, required by GCE. Changing this forces a new resource to be created.\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`): Where the target pool resides. Defaults to project region. When `null`, the `region` field will be omitted from the resulting object.\n - `session_affinity` (`string`): How to distribute load. Options are \u0026#34;NONE\u0026#34; (no affinity). \u0026#34;CLIENT_IP\u0026#34; (hash of the source/dest addresses / ports), and \u0026#34;CLIENT_IP_PROTO\u0026#34; also includes the protocol (default \u0026#34;NONE\u0026#34;). When `null`, the `session_affinity` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_pool.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_compute_target_pool.new` injects a new `google-beta_google_compute_target_pool` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_compute_target_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_compute_target_pool` using the reference:\n\n $._ref.google-beta_google_compute_target_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_compute_target_pool.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `backup_pool` (`string`): URL to the backup target pool. Must also set failover_ratio. When `null`, the `backup_pool` field will be omitted from the resulting object.\n - `description` (`string`): Textual description field. When `null`, the `description` field will be omitted from the resulting object.\n - `failover_ratio` (`number`): Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set). When `null`, the `failover_ratio` field will be omitted from the resulting object.\n - `health_checks` (`list`): List of zero or one health check name or self_link. Only legacy google_compute_http_health_check is supported. When `null`, the `health_checks` field will be omitted from the resulting object.\n - `instances` (`list`): List of instances in the pool. They can be given as URLs, or in the form of \u0026#34;zone/name\u0026#34;. Note that the instances need not exist at the time of target pool creation, so there is no need to use the Terraform interpolators to create a dependency on the instances from the target pool. When `null`, the `instances` field will be omitted from the resulting object.\n - `name` (`string`): A unique name for the resource, required by GCE. Changing this forces a new resource to be created.\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`): Where the target pool resides. Defaults to project region. When `null`, the `region` field will be omitted from the resulting object.\n - `security_policy` (`string`): The resource URL for the security policy associated with this target pool. When `null`, the `security_policy` field will be omitted from the resulting object.\n - `session_affinity` (`string`): How to distribute load. Options are \u0026#34;NONE\u0026#34; (no affinity). \u0026#34;CLIENT_IP\u0026#34; (hash of the source/dest addresses / ports), and \u0026#34;CLIENT_IP_PROTO\u0026#34; also includes the protocol (default \u0026#34;NONE\u0026#34;). When `null`, the `session_affinity` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_pool.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -13,6 +13,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); instances=null, project=null, region=null, + security_policy=null, session_affinity=null, timeouts=null, _meta={} @@ -28,12 +29,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); name=name, project=project, region=region, + security_policy=security_policy, session_affinity=session_affinity, timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_compute_target_pool.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_target_pool`\nTerraform resource.\n\nUnlike [google-beta.google_compute_target_pool.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `backup_pool` (`string`): URL to the backup target pool. Must also set failover_ratio. When `null`, the `backup_pool` field will be omitted from the resulting object.\n - `description` (`string`): Textual description field. When `null`, the `description` field will be omitted from the resulting object.\n - `failover_ratio` (`number`): Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set). When `null`, the `failover_ratio` field will be omitted from the resulting object.\n - `health_checks` (`list`): List of zero or one health check name or self_link. Only legacy google_compute_http_health_check is supported. When `null`, the `health_checks` field will be omitted from the resulting object.\n - `instances` (`list`): List of instances in the pool. They can be given as URLs, or in the form of "zone/name". Note that the instances need not exist at the time of target pool creation, so there is no need to use the Terraform interpolators to create a dependency on the instances from the target pool. When `null`, the `instances` field will be omitted from the resulting object.\n - `name` (`string`): A unique name for the resource, required by GCE. Changing this forces a new resource to be created.\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`): Where the target pool resides. Defaults to project region. When `null`, the `region` field will be omitted from the resulting object.\n - `session_affinity` (`string`): How to distribute load. Options are "NONE" (no affinity). "CLIENT_IP" (hash of the source/dest addresses / ports), and "CLIENT_IP_PROTO" also includes the protocol (default "NONE"). When `null`, the `session_affinity` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_pool.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_compute_target_pool` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_compute_target_pool.newAttrs` constructs a new object with attributes and blocks configured for the `google_compute_target_pool`\nTerraform resource.\n\nUnlike [google-beta.google_compute_target_pool.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `backup_pool` (`string`): URL to the backup target pool. Must also set failover_ratio. When `null`, the `backup_pool` field will be omitted from the resulting object.\n - `description` (`string`): Textual description field. When `null`, the `description` field will be omitted from the resulting object.\n - `failover_ratio` (`number`): Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set). When `null`, the `failover_ratio` field will be omitted from the resulting object.\n - `health_checks` (`list`): List of zero or one health check name or self_link. Only legacy google_compute_http_health_check is supported. When `null`, the `health_checks` field will be omitted from the resulting object.\n - `instances` (`list`): List of instances in the pool. They can be given as URLs, or in the form of "zone/name". Note that the instances need not exist at the time of target pool creation, so there is no need to use the Terraform interpolators to create a dependency on the instances from the target pool. When `null`, the `instances` field will be omitted from the resulting object.\n - `name` (`string`): A unique name for the resource, required by GCE. Changing this forces a new resource to be created.\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`): Where the target pool resides. Defaults to project region. When `null`, the `region` field will be omitted from the resulting object.\n - `security_policy` (`string`): The resource URL for the security policy associated with this target pool. When `null`, the `security_policy` field will be omitted from the resulting object.\n - `session_affinity` (`string`): How to distribute load. Options are "NONE" (no affinity). "CLIENT_IP" (hash of the source/dest addresses / ports), and "CLIENT_IP_PROTO" also includes the protocol (default "NONE"). When `null`, the `session_affinity` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_pool.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_compute_target_pool` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, backup_pool=null, @@ -43,6 +45,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); instances=null, project=null, region=null, + security_policy=null, session_affinity=null, timeouts=null ):: std.prune(a={ @@ -54,6 +57,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); name: name, project: project, region: region, + security_policy: security_policy, session_affinity: session_affinity, timeouts: timeouts, }), @@ -149,6 +153,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSecurityPolicy':: d.fn(help='`google-beta.string.withSecurityPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the security_policy field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `security_policy` field.\n', args=[]), + withSecurityPolicy(resourceLabel, value): { + resource+: { + google_compute_target_pool+: { + [resourceLabel]+: { + security_policy: value, + }, + }, + }, + }, '#withSessionAffinity':: d.fn(help='`google-beta.string.withSessionAffinity` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the session_affinity 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 `session_affinity` field.\n', args=[]), withSessionAffinity(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/container_cluster.libsonnet b/4.x/_gen/resources/container_cluster.libsonnet index 0187924..364ff08 100644 --- a/4.x/_gen/resources/container_cluster.libsonnet +++ b/4.x/_gen/resources/container_cluster.libsonnet @@ -337,8 +337,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, ip_allocation_policy:: { - '#new':: d.fn(help='\n`google-beta.google_container_cluster.ip_allocation_policy.new` constructs a new object with attributes and blocks configured for the `ip_allocation_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `cluster_ipv4_cidr_block` (`string`): The IP address range for the cluster pod IPs. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. When `null`, the `cluster_ipv4_cidr_block` field will be omitted from the resulting object.\n - `cluster_secondary_range_name` (`string`): The name of the existing secondary range in the cluster's subnetwork to use for pod IP addresses. Alternatively, cluster_ipv4_cidr_block can be used to automatically create a GKE-managed one. When `null`, the `cluster_secondary_range_name` field will be omitted from the resulting object.\n - `services_ipv4_cidr_block` (`string`): The IP address range of the services IPs in this cluster. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. When `null`, the `services_ipv4_cidr_block` field will be omitted from the resulting object.\n - `services_secondary_range_name` (`string`): The name of the existing secondary range in the cluster's subnetwork to use for service ClusterIPs. Alternatively, services_ipv4_cidr_block can be used to automatically create a GKE-managed one. When `null`, the `services_secondary_range_name` field will be omitted from the resulting object.\n - `stack_type` (`string`): The IP Stack type of the cluster. Choose between IPV4 and IPV4_IPV6. Default type is IPV4 Only if not set When `null`, the `stack_type` field will be omitted from the resulting object.\n - `pod_cidr_overprovision_config` (`list[obj]`): Configuration for cluster level pod cidr overprovision. Default is disabled=false. When `null`, the `pod_cidr_overprovision_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_cluster.ip_allocation_policy.pod_cidr_overprovision_config.new](#fn-ip_allocation_policypod_cidr_overprovision_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ip_allocation_policy` sub block.\n', args=[]), + additional_pod_ranges_config:: { + '#new':: d.fn(help='\n`google-beta.google_container_cluster.ip_allocation_policy.additional_pod_ranges_config.new` constructs a new object with attributes and blocks configured for the `additional_pod_ranges_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `pod_range_names` (`list`): Name for pod secondary ipv4 range which has the actual range defined ahead.\n\n**Returns**:\n - An attribute object that represents the `additional_pod_ranges_config` sub block.\n', args=[]), + new( + pod_range_names + ):: std.prune(a={ + pod_range_names: pod_range_names, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_container_cluster.ip_allocation_policy.new` constructs a new object with attributes and blocks configured for the `ip_allocation_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `cluster_ipv4_cidr_block` (`string`): The IP address range for the cluster pod IPs. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. When `null`, the `cluster_ipv4_cidr_block` field will be omitted from the resulting object.\n - `cluster_secondary_range_name` (`string`): The name of the existing secondary range in the cluster's subnetwork to use for pod IP addresses. Alternatively, cluster_ipv4_cidr_block can be used to automatically create a GKE-managed one. When `null`, the `cluster_secondary_range_name` field will be omitted from the resulting object.\n - `services_ipv4_cidr_block` (`string`): The IP address range of the services IPs in this cluster. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. When `null`, the `services_ipv4_cidr_block` field will be omitted from the resulting object.\n - `services_secondary_range_name` (`string`): The name of the existing secondary range in the cluster's subnetwork to use for service ClusterIPs. Alternatively, services_ipv4_cidr_block can be used to automatically create a GKE-managed one. When `null`, the `services_secondary_range_name` field will be omitted from the resulting object.\n - `stack_type` (`string`): The IP Stack type of the cluster. Choose between IPV4 and IPV4_IPV6. Default type is IPV4 Only if not set When `null`, the `stack_type` field will be omitted from the resulting object.\n - `additional_pod_ranges_config` (`list[obj]`): AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. When `null`, the `additional_pod_ranges_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_cluster.ip_allocation_policy.additional_pod_ranges_config.new](#fn-ip_allocation_policyadditional_pod_ranges_confignew) constructor.\n - `pod_cidr_overprovision_config` (`list[obj]`): Configuration for cluster level pod cidr overprovision. Default is disabled=false. When `null`, the `pod_cidr_overprovision_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_cluster.ip_allocation_policy.pod_cidr_overprovision_config.new](#fn-ip_allocation_policypod_cidr_overprovision_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ip_allocation_policy` sub block.\n', args=[]), new( + additional_pod_ranges_config=null, cluster_ipv4_cidr_block=null, cluster_secondary_range_name=null, pod_cidr_overprovision_config=null, @@ -346,6 +355,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); services_secondary_range_name=null, stack_type=null ):: std.prune(a={ + additional_pod_ranges_config: additional_pod_ranges_config, cluster_ipv4_cidr_block: cluster_ipv4_cidr_block, cluster_secondary_range_name: cluster_secondary_range_name, pod_cidr_overprovision_config: pod_cidr_overprovision_config, diff --git a/4.x/_gen/resources/dataform_repository_workflow_config.libsonnet b/4.x/_gen/resources/dataform_repository_workflow_config.libsonnet new file mode 100644 index 0000000..695473e --- /dev/null +++ b/4.x/_gen/resources/dataform_repository_workflow_config.libsonnet @@ -0,0 +1,208 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='google_dataform_repository_workflow_config', url='', help='`google_dataform_repository_workflow_config` represents the `google-beta_google_dataform_repository_workflow_config` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + invocation_config:: { + included_targets:: { + '#new':: d.fn(help='\n`google-beta.google_dataform_repository_workflow_config.invocation_config.included_targets.new` constructs a new object with attributes and blocks configured for the `included_targets`\nTerraform sub block.\n\n\n\n**Args**:\n - `database` (`string`): The action's database (Google Cloud project ID). When `null`, the `database` field will be omitted from the resulting object.\n - `name` (`string`): The action's name, within database and schema. When `null`, the `name` field will be omitted from the resulting object.\n - `schema` (`string`): The action's schema (BigQuery dataset ID), within database. When `null`, the `schema` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `included_targets` sub block.\n', args=[]), + new( + database=null, + name=null, + schema=null + ):: std.prune(a={ + database: database, + name: name, + schema: schema, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_dataform_repository_workflow_config.invocation_config.new` constructs a new object with attributes and blocks configured for the `invocation_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `fully_refresh_incremental_tables_enabled` (`bool`): Optional. When set to true, any incremental tables will be fully refreshed. When `null`, the `fully_refresh_incremental_tables_enabled` field will be omitted from the resulting object.\n - `included_tags` (`list`): Optional. The set of tags to include. When `null`, the `included_tags` field will be omitted from the resulting object.\n - `service_account` (`string`): Optional. The service account to run workflow invocations under. When `null`, the `service_account` field will be omitted from the resulting object.\n - `transitive_dependencies_included` (`bool`): Optional. When set to true, transitive dependencies of included actions will be executed. When `null`, the `transitive_dependencies_included` field will be omitted from the resulting object.\n - `transitive_dependents_included` (`bool`): Optional. When set to true, transitive dependents of included actions will be executed. When `null`, the `transitive_dependents_included` field will be omitted from the resulting object.\n - `included_targets` (`list[obj]`): Optional. The set of action identifiers to include. When `null`, the `included_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-beta.google_dataform_repository_workflow_config.invocation_config.included_targets.new](#fn-invocation_configincluded_targetsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `invocation_config` sub block.\n', args=[]), + new( + fully_refresh_incremental_tables_enabled=null, + included_tags=null, + included_targets=null, + service_account=null, + transitive_dependencies_included=null, + transitive_dependents_included=null + ):: std.prune(a={ + fully_refresh_incremental_tables_enabled: fully_refresh_incremental_tables_enabled, + included_tags: included_tags, + included_targets: included_targets, + service_account: service_account, + transitive_dependencies_included: transitive_dependencies_included, + transitive_dependents_included: transitive_dependents_included, + }), + }, + '#new':: d.fn(help="\n`google-beta.google_dataform_repository_workflow_config.new` injects a new `google-beta_google_dataform_repository_workflow_config` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_dataform_repository_workflow_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_dataform_repository_workflow_config` using the reference:\n\n $._ref.google-beta_google_dataform_repository_workflow_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_dataform_repository_workflow_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 - `cron_schedule` (`string`): Optional. Optional schedule (in cron format) for automatic creation of compilation results. When `null`, the `cron_schedule` field will be omitted from the resulting object.\n - `name` (`string`): The workflow\u0026#39;s name.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): A reference to the region When `null`, the `region` field will be omitted from the resulting object.\n - `release_config` (`string`): The name of the release config whose releaseCompilationResult should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.\n - `repository` (`string`): A reference to the Dataform repository When `null`, the `repository` field will be omitted from the resulting object.\n - `time_zone` (`string`): Optional. Specifies the time zone to be used when interpreting cronSchedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. When `null`, the `time_zone` field will be omitted from the resulting object.\n - `invocation_config` (`list[obj]`): Optional. If left unset, a default InvocationConfig will be used. When `null`, the `invocation_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataform_repository_workflow_config.invocation_config.new](#fn-invocation_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataform_repository_workflow_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, + name, + release_config, + cron_schedule=null, + invocation_config=null, + project=null, + region=null, + repository=null, + time_zone=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_dataform_repository_workflow_config', + label=resourceLabel, + attrs=self.newAttrs( + cron_schedule=cron_schedule, + invocation_config=invocation_config, + name=name, + project=project, + region=region, + release_config=release_config, + repository=repository, + time_zone=time_zone, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_dataform_repository_workflow_config.newAttrs` constructs a new object with attributes and blocks configured for the `google_dataform_repository_workflow_config`\nTerraform resource.\n\nUnlike [google-beta.google_dataform_repository_workflow_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 - `cron_schedule` (`string`): Optional. Optional schedule (in cron format) for automatic creation of compilation results. When `null`, the `cron_schedule` field will be omitted from the resulting object.\n - `name` (`string`): The workflow's name.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `region` (`string`): A reference to the region When `null`, the `region` field will be omitted from the resulting object.\n - `release_config` (`string`): The name of the release config whose releaseCompilationResult should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.\n - `repository` (`string`): A reference to the Dataform repository When `null`, the `repository` field will be omitted from the resulting object.\n - `time_zone` (`string`): Optional. Specifies the time zone to be used when interpreting cronSchedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. When `null`, the `time_zone` field will be omitted from the resulting object.\n - `invocation_config` (`list[obj]`): Optional. If left unset, a default InvocationConfig will be used. When `null`, the `invocation_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataform_repository_workflow_config.invocation_config.new](#fn-invocation_confignew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataform_repository_workflow_config.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_dataform_repository_workflow_config` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + name, + release_config, + cron_schedule=null, + invocation_config=null, + project=null, + region=null, + repository=null, + time_zone=null, + timeouts=null + ):: std.prune(a={ + cron_schedule: cron_schedule, + invocation_config: invocation_config, + name: name, + project: project, + region: region, + release_config: release_config, + repository: repository, + time_zone: time_zone, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_dataform_repository_workflow_config.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#withCronSchedule':: d.fn(help='`google-beta.string.withCronSchedule` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the cron_schedule 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 `cron_schedule` field.\n', args=[]), + withCronSchedule(resourceLabel, value): { + resource+: { + google_dataform_repository_workflow_config+: { + [resourceLabel]+: { + cron_schedule: value, + }, + }, + }, + }, + '#withInvocationConfig':: d.fn(help='`google-beta.list[obj].withInvocationConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the invocation_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google-beta.list[obj].withInvocationConfigMixin](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 `invocation_config` field.\n', args=[]), + withInvocationConfig(resourceLabel, value): { + resource+: { + google_dataform_repository_workflow_config+: { + [resourceLabel]+: { + invocation_config: value, + }, + }, + }, + }, + '#withInvocationConfigMixin':: d.fn(help='`google-beta.list[obj].withInvocationConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the invocation_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google-beta.list[obj].withInvocationConfig](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 `invocation_config` field.\n', args=[]), + withInvocationConfigMixin(resourceLabel, value): { + resource+: { + google_dataform_repository_workflow_config+: { + [resourceLabel]+: { + invocation_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withName':: d.fn(help='`google-beta.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_dataform_repository_workflow_config+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_dataform_repository_workflow_config+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRegion':: d.fn(help='`google-beta.string.withRegion` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the region field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `region` field.\n', args=[]), + withRegion(resourceLabel, value): { + resource+: { + google_dataform_repository_workflow_config+: { + [resourceLabel]+: { + region: value, + }, + }, + }, + }, + '#withReleaseConfig':: d.fn(help='`google-beta.string.withReleaseConfig` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the release_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 `release_config` field.\n', args=[]), + withReleaseConfig(resourceLabel, value): { + resource+: { + google_dataform_repository_workflow_config+: { + [resourceLabel]+: { + release_config: value, + }, + }, + }, + }, + '#withRepository':: d.fn(help='`google-beta.string.withRepository` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the repository 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 `repository` field.\n', args=[]), + withRepository(resourceLabel, value): { + resource+: { + google_dataform_repository_workflow_config+: { + [resourceLabel]+: { + repository: value, + }, + }, + }, + }, + '#withTimeZone':: d.fn(help='`google-beta.string.withTimeZone` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the time_zone field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `time_zone` field.\n', args=[]), + withTimeZone(resourceLabel, value): { + resource+: { + google_dataform_repository_workflow_config+: { + [resourceLabel]+: { + time_zone: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google-beta.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_dataform_repository_workflow_config+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google-beta.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_dataform_repository_workflow_config+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/dataplex_datascan.libsonnet b/4.x/_gen/resources/dataplex_datascan.libsonnet index 8c2b5ff..dd457b1 100644 --- a/4.x/_gen/resources/dataplex_datascan.libsonnet +++ b/4.x/_gen/resources/dataplex_datascan.libsonnet @@ -13,32 +13,90 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, data_profile_spec:: { - '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_profile_spec.new` constructs a new object with attributes and blocks configured for the `data_profile_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `row_filter` (`string`): A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 When `null`, the `row_filter` field will be omitted from the resulting object.\n - `sampling_percent` (`number`): The percentage of the records to be selected from the dataset for DataScan. When `null`, the `sampling_percent` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `data_profile_spec` sub block.\n', args=[]), + exclude_fields:: { + '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_profile_spec.exclude_fields.new` constructs a new object with attributes and blocks configured for the `exclude_fields`\nTerraform sub block.\n\n\n\n**Args**:\n - `field_names` (`list`): Expected input is a list of fully qualified names of fields as in the schema.\nOnly top-level field names for nested fields are supported.\nFor instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. When `null`, the `field_names` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `exclude_fields` sub block.\n', args=[]), + new( + field_names=null + ):: std.prune(a={ + field_names: field_names, + }), + }, + include_fields:: { + '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_profile_spec.include_fields.new` constructs a new object with attributes and blocks configured for the `include_fields`\nTerraform sub block.\n\n\n\n**Args**:\n - `field_names` (`list`): Expected input is a list of fully qualified names of fields as in the schema.\nOnly top-level field names for nested fields are supported.\nFor instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. When `null`, the `field_names` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `include_fields` sub block.\n', args=[]), + new( + field_names=null + ):: std.prune(a={ + field_names: field_names, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_profile_spec.new` constructs a new object with attributes and blocks configured for the `data_profile_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `row_filter` (`string`): A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 When `null`, the `row_filter` field will be omitted from the resulting object.\n - `sampling_percent` (`number`): The percentage of the records to be selected from the dataset for DataScan.\nValue can range between 0.0 and 100.0 with up to 3 significant decimal digits.\nSampling is not applied if 'sampling_percent' is not specified, 0 or 100. When `null`, the `sampling_percent` field will be omitted from the resulting object.\n - `exclude_fields` (`list[obj]`): The fields to exclude from data profile.\nIf specified, the fields will be excluded from data profile, regardless of 'include_fields' value. When `null`, the `exclude_fields` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_profile_spec.exclude_fields.new](#fn-data_profile_specexclude_fieldsnew) constructor.\n - `include_fields` (`list[obj]`): The fields to include in data profile.\nIf not specified, all fields at the time of profile scan job execution are included, except for ones listed in 'exclude_fields'. When `null`, the `include_fields` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_profile_spec.include_fields.new](#fn-data_profile_specinclude_fieldsnew) constructor.\n - `post_scan_actions` (`list[obj]`): Actions to take upon job completion. When `null`, the `post_scan_actions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_profile_spec.post_scan_actions.new](#fn-data_profile_specpost_scan_actionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `data_profile_spec` sub block.\n', args=[]), new( + exclude_fields=null, + include_fields=null, + post_scan_actions=null, row_filter=null, sampling_percent=null ):: std.prune(a={ + exclude_fields: exclude_fields, + include_fields: include_fields, + post_scan_actions: post_scan_actions, row_filter: row_filter, sampling_percent: sampling_percent, }), + post_scan_actions:: { + bigquery_export:: { + '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_profile_spec.post_scan_actions.bigquery_export.new` constructs a new object with attributes and blocks configured for the `bigquery_export`\nTerraform sub block.\n\n\n\n**Args**:\n - `results_table` (`string`): The BigQuery table to export DataProfileScan results to.\nFormat://bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID When `null`, the `results_table` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `bigquery_export` sub block.\n', args=[]), + new( + results_table=null + ):: std.prune(a={ + results_table: results_table, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_profile_spec.post_scan_actions.new` constructs a new object with attributes and blocks configured for the `post_scan_actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `bigquery_export` (`list[obj]`): If set, results will be exported to the provided BigQuery table. When `null`, the `bigquery_export` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_profile_spec.post_scan_actions.bigquery_export.new](#fn-data_profile_specdata_profile_specbigquery_exportnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `post_scan_actions` sub block.\n', args=[]), + new( + bigquery_export=null + ):: std.prune(a={ + bigquery_export: bigquery_export, + }), + }, }, data_quality_spec:: { - '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_quality_spec.new` constructs a new object with attributes and blocks configured for the `data_quality_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `row_filter` (`string`): A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 When `null`, the `row_filter` field will be omitted from the resulting object.\n - `sampling_percent` (`number`): The percentage of the records to be selected from the dataset for DataScan. When `null`, the `sampling_percent` field will be omitted from the resulting object.\n - `rules` (`list[obj]`): The list of rules to evaluate against a data source. At least one rule is required. When `null`, the `rules` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.new](#fn-data_quality_specrulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `data_quality_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_quality_spec.new` constructs a new object with attributes and blocks configured for the `data_quality_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `row_filter` (`string`): A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 When `null`, the `row_filter` field will be omitted from the resulting object.\n - `sampling_percent` (`number`): The percentage of the records to be selected from the dataset for DataScan.\nValue can range between 0.0 and 100.0 with up to 3 significant decimal digits.\nSampling is not applied if 'sampling_percent' is not specified, 0 or 100. When `null`, the `sampling_percent` field will be omitted from the resulting object.\n - `post_scan_actions` (`list[obj]`): Actions to take upon job completion. When `null`, the `post_scan_actions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.post_scan_actions.new](#fn-data_quality_specpost_scan_actionsnew) constructor.\n - `rules` (`list[obj]`): The list of rules to evaluate against a data source. At least one rule is required. When `null`, the `rules` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.new](#fn-data_quality_specrulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `data_quality_spec` sub block.\n', args=[]), new( + post_scan_actions=null, row_filter=null, rules=null, sampling_percent=null ):: std.prune(a={ + post_scan_actions: post_scan_actions, row_filter: row_filter, rules: rules, sampling_percent: sampling_percent, }), + post_scan_actions:: { + bigquery_export:: { + '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_quality_spec.post_scan_actions.bigquery_export.new` constructs a new object with attributes and blocks configured for the `bigquery_export`\nTerraform sub block.\n\n\n\n**Args**:\n - `results_table` (`string`): The BigQuery table to export DataQualityScan results to.\nFormat://bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID When `null`, the `results_table` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `bigquery_export` sub block.\n', args=[]), + new( + results_table=null + ):: std.prune(a={ + results_table: results_table, + }), + }, + '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_quality_spec.post_scan_actions.new` constructs a new object with attributes and blocks configured for the `post_scan_actions`\nTerraform sub block.\n\n\n\n**Args**:\n - `bigquery_export` (`list[obj]`): If set, results will be exported to the provided BigQuery table. When `null`, the `bigquery_export` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.post_scan_actions.bigquery_export.new](#fn-data_quality_specdata_quality_specbigquery_exportnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `post_scan_actions` sub block.\n', args=[]), + new( + bigquery_export=null + ):: std.prune(a={ + bigquery_export: bigquery_export, + }), + }, rules:: { - '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_quality_spec.rules.new` constructs a new object with attributes and blocks configured for the `rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `column` (`string`): The unnested column which this rule is evaluated against. When `null`, the `column` field will be omitted from the resulting object.\n - `dimension` (`string`): The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]\n - `ignore_null` (`bool`): Rows with null values will automatically fail a rule, unless ignoreNull is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules. When `null`, the `ignore_null` field will be omitted from the resulting object.\n - `threshold` (`number`): The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of [0.0, 1.0]. 0 indicates default value (i.e. 1.0). When `null`, the `threshold` field will be omitted from the resulting object.\n - `non_null_expectation` (`list[obj]`): ColumnMap rule which evaluates whether each column value is null. When `null`, the `non_null_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.non_null_expectation.new](#fn-data_quality_specdata_quality_specnon_null_expectationnew) constructor.\n - `range_expectation` (`list[obj]`): ColumnMap rule which evaluates whether each column value lies between a specified range. When `null`, the `range_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.range_expectation.new](#fn-data_quality_specdata_quality_specrange_expectationnew) constructor.\n - `regex_expectation` (`list[obj]`): ColumnMap rule which evaluates whether each column value matches a specified regex. When `null`, the `regex_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.regex_expectation.new](#fn-data_quality_specdata_quality_specregex_expectationnew) constructor.\n - `row_condition_expectation` (`list[obj]`): Table rule which evaluates whether each row passes the specified condition. When `null`, the `row_condition_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.row_condition_expectation.new](#fn-data_quality_specdata_quality_specrow_condition_expectationnew) constructor.\n - `set_expectation` (`list[obj]`): ColumnMap rule which evaluates whether each column value is contained by a specified set. When `null`, the `set_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.set_expectation.new](#fn-data_quality_specdata_quality_specset_expectationnew) constructor.\n - `statistic_range_expectation` (`list[obj]`): ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range. When `null`, the `statistic_range_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.statistic_range_expectation.new](#fn-data_quality_specdata_quality_specstatistic_range_expectationnew) constructor.\n - `table_condition_expectation` (`list[obj]`): Table rule which evaluates whether the provided expression is true. When `null`, the `table_condition_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.table_condition_expectation.new](#fn-data_quality_specdata_quality_spectable_condition_expectationnew) constructor.\n - `uniqueness_expectation` (`list[obj]`): ColumnAggregate rule which evaluates whether the column has duplicates. When `null`, the `uniqueness_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.uniqueness_expectation.new](#fn-data_quality_specdata_quality_specuniqueness_expectationnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rules` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_dataplex_datascan.data_quality_spec.rules.new` constructs a new object with attributes and blocks configured for the `rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `column` (`string`): The unnested column which this rule is evaluated against. When `null`, the `column` field will be omitted from the resulting object.\n - `description` (`string`): Description of the rule.\nThe maximum length is 1,024 characters. When `null`, the `description` field will be omitted from the resulting object.\n - `dimension` (`string`): The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]\n - `ignore_null` (`bool`): Rows with null values will automatically fail a rule, unless ignoreNull is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules. When `null`, the `ignore_null` field will be omitted from the resulting object.\n - `name` (`string`): A mutable name for the rule.\nThe name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-).\nThe maximum length is 63 characters.\nMust start with a letter.\nMust end with a number or a letter. When `null`, the `name` field will be omitted from the resulting object.\n - `threshold` (`number`): The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of [0.0, 1.0]. 0 indicates default value (i.e. 1.0). When `null`, the `threshold` field will be omitted from the resulting object.\n - `non_null_expectation` (`list[obj]`): ColumnMap rule which evaluates whether each column value is null. When `null`, the `non_null_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.non_null_expectation.new](#fn-data_quality_specdata_quality_specnon_null_expectationnew) constructor.\n - `range_expectation` (`list[obj]`): ColumnMap rule which evaluates whether each column value lies between a specified range. When `null`, the `range_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.range_expectation.new](#fn-data_quality_specdata_quality_specrange_expectationnew) constructor.\n - `regex_expectation` (`list[obj]`): ColumnMap rule which evaluates whether each column value matches a specified regex. When `null`, the `regex_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.regex_expectation.new](#fn-data_quality_specdata_quality_specregex_expectationnew) constructor.\n - `row_condition_expectation` (`list[obj]`): Table rule which evaluates whether each row passes the specified condition. When `null`, the `row_condition_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.row_condition_expectation.new](#fn-data_quality_specdata_quality_specrow_condition_expectationnew) constructor.\n - `set_expectation` (`list[obj]`): ColumnMap rule which evaluates whether each column value is contained by a specified set. When `null`, the `set_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.set_expectation.new](#fn-data_quality_specdata_quality_specset_expectationnew) constructor.\n - `statistic_range_expectation` (`list[obj]`): ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range. When `null`, the `statistic_range_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.statistic_range_expectation.new](#fn-data_quality_specdata_quality_specstatistic_range_expectationnew) constructor.\n - `table_condition_expectation` (`list[obj]`): Table rule which evaluates whether the provided expression is true. When `null`, the `table_condition_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.table_condition_expectation.new](#fn-data_quality_specdata_quality_spectable_condition_expectationnew) constructor.\n - `uniqueness_expectation` (`list[obj]`): Row-level rule which evaluates whether each column value is unique. When `null`, the `uniqueness_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.uniqueness_expectation.new](#fn-data_quality_specdata_quality_specuniqueness_expectationnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rules` sub block.\n', args=[]), new( dimension, column=null, + description=null, ignore_null=null, + name=null, non_null_expectation=null, range_expectation=null, regex_expectation=null, @@ -50,8 +108,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); uniqueness_expectation=null ):: std.prune(a={ column: column, + description: description, dimension: dimension, ignore_null: ignore_null, + name: name, non_null_expectation: non_null_expectation, range_expectation: range_expectation, regex_expectation: regex_expectation, diff --git a/4.x/_gen/resources/firebase_android_app.libsonnet b/4.x/_gen/resources/firebase_android_app.libsonnet index cf01e3b..6c45785 100644 --- a/4.x/_gen/resources/firebase_android_app.libsonnet +++ b/4.x/_gen/resources/firebase_android_app.libsonnet @@ -2,10 +2,11 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_firebase_android_app', url='', help='`google_firebase_android_app` represents the `google-beta_google_firebase_android_app` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google-beta.google_firebase_android_app.new` injects a new `google-beta_google_firebase_android_app` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_firebase_android_app.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_firebase_android_app` using the reference:\n\n $._ref.google-beta_google_firebase_android_app.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_firebase_android_app.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `deletion_policy` (`string`): (Optional) Set to \u0026#39;ABANDON\u0026#39; to allow the AndroidApp to be untracked from terraform state\nrather than deleted upon \u0026#39;terraform destroy\u0026#39;. This is useful because the AndroidApp may be\nserving traffic. Set to \u0026#39;DELETE\u0026#39; to delete the AndroidApp. Defaults to \u0026#39;DELETE\u0026#39;. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the AndroidApp.\n - `package_name` (`string`): Immutable. The canonical package name of the Android app as would appear in the Google Play\nDeveloper Console. When `null`, the `package_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 - `sha1_hashes` (`list`): The SHA1 certificate hashes for the AndroidApp. When `null`, the `sha1_hashes` field will be omitted from the resulting object.\n - `sha256_hashes` (`list`): The SHA256 certificate hashes for the AndroidApp. When `null`, the `sha256_hashes` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_android_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_firebase_android_app.new` injects a new `google-beta_google_firebase_android_app` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_firebase_android_app.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_firebase_android_app` using the reference:\n\n $._ref.google-beta_google_firebase_android_app.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_firebase_android_app.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the AndroidApp.\nIf apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the AndroidApp.\nThis auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object.\n - `deletion_policy` (`string`): (Optional) Set to \u0026#39;ABANDON\u0026#39; to allow the AndroidApp to be untracked from terraform state\nrather than deleted upon \u0026#39;terraform destroy\u0026#39;. This is useful because the AndroidApp may be\nserving traffic. Set to \u0026#39;DELETE\u0026#39; to delete the AndroidApp. Defaults to \u0026#39;DELETE\u0026#39;. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the AndroidApp.\n - `package_name` (`string`): Immutable. The canonical package name of the Android app as would appear in the Google Play\nDeveloper Console. When `null`, the `package_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 - `sha1_hashes` (`list`): The SHA1 certificate hashes for the AndroidApp. When `null`, the `sha1_hashes` field will be omitted from the resulting object.\n - `sha256_hashes` (`list`): The SHA256 certificate hashes for the AndroidApp. When `null`, the `sha256_hashes` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_android_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name, + api_key_id=null, deletion_policy=null, package_name=null, project=null, @@ -17,6 +18,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='google_firebase_android_app', label=resourceLabel, attrs=self.newAttrs( + api_key_id=api_key_id, deletion_policy=deletion_policy, display_name=display_name, package_name=package_name, @@ -27,9 +29,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_firebase_android_app.newAttrs` constructs a new object with attributes and blocks configured for the `google_firebase_android_app`\nTerraform resource.\n\nUnlike [google-beta.google_firebase_android_app.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the AndroidApp to be untracked from terraform state\nrather than deleted upon 'terraform destroy'. This is useful because the AndroidApp may be\nserving traffic. Set to 'DELETE' to delete the AndroidApp. Defaults to 'DELETE'. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the AndroidApp.\n - `package_name` (`string`): Immutable. The canonical package name of the Android app as would appear in the Google Play\nDeveloper Console. When `null`, the `package_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 - `sha1_hashes` (`list`): The SHA1 certificate hashes for the AndroidApp. When `null`, the `sha1_hashes` field will be omitted from the resulting object.\n - `sha256_hashes` (`list`): The SHA256 certificate hashes for the AndroidApp. When `null`, the `sha256_hashes` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_android_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_firebase_android_app` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_firebase_android_app.newAttrs` constructs a new object with attributes and blocks configured for the `google_firebase_android_app`\nTerraform resource.\n\nUnlike [google-beta.google_firebase_android_app.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the AndroidApp.\nIf apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the AndroidApp.\nThis auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object.\n - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the AndroidApp to be untracked from terraform state\nrather than deleted upon 'terraform destroy'. This is useful because the AndroidApp may be\nserving traffic. Set to 'DELETE' to delete the AndroidApp. Defaults to 'DELETE'. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the AndroidApp.\n - `package_name` (`string`): Immutable. The canonical package name of the Android app as would appear in the Google Play\nDeveloper Console. When `null`, the `package_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 - `sha1_hashes` (`list`): The SHA1 certificate hashes for the AndroidApp. When `null`, the `sha1_hashes` field will be omitted from the resulting object.\n - `sha256_hashes` (`list`): The SHA256 certificate hashes for the AndroidApp. When `null`, the `sha256_hashes` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_android_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_firebase_android_app` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, + api_key_id=null, deletion_policy=null, package_name=null, project=null, @@ -37,6 +40,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); sha256_hashes=null, timeouts=null ):: std.prune(a={ + api_key_id: api_key_id, deletion_policy: deletion_policy, display_name: display_name, package_name: package_name, @@ -57,6 +61,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withApiKeyId':: d.fn(help='`google-beta.string.withApiKeyId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the api_key_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `api_key_id` field.\n', args=[]), + withApiKeyId(resourceLabel, value): { + resource+: { + google_firebase_android_app+: { + [resourceLabel]+: { + api_key_id: value, + }, + }, + }, + }, '#withDeletionPolicy':: d.fn(help='`google-beta.string.withDeletionPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the deletion_policy field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `deletion_policy` field.\n', args=[]), withDeletionPolicy(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/firebase_apple_app.libsonnet b/4.x/_gen/resources/firebase_apple_app.libsonnet index 7641f0c..02dbd5a 100644 --- a/4.x/_gen/resources/firebase_apple_app.libsonnet +++ b/4.x/_gen/resources/firebase_apple_app.libsonnet @@ -2,11 +2,12 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_firebase_apple_app', url='', help='`google_firebase_apple_app` represents the `google-beta_google_firebase_apple_app` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google-beta.google_firebase_apple_app.new` injects a new `google-beta_google_firebase_apple_app` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_firebase_apple_app.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_firebase_apple_app` using the reference:\n\n $._ref.google-beta_google_firebase_apple_app.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_firebase_apple_app.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `app_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object.\n - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore.\n - `deletion_policy` (`string`): (Optional) Set to \u0026#39;ABANDON\u0026#39; to allow the Apple to be untracked from terraform state\nrather than deleted upon \u0026#39;terraform destroy\u0026#39;. This is useful because the Apple may be\nserving traffic. Set to \u0026#39;DELETE\u0026#39; to delete the Apple. Defaults to \u0026#39;DELETE\u0026#39;. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `team_id` (`string`): The Apple Developer Team ID associated with the App in the App Store. When `null`, the `team_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_apple_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_firebase_apple_app.new` injects a new `google-beta_google_firebase_apple_app` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_firebase_apple_app.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_firebase_apple_app` using the reference:\n\n $._ref.google-beta_google_firebase_apple_app.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_firebase_apple_app.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the AppleApp.\nIf apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the AppleApp.\nThis auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object.\n - `app_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object.\n - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore.\n - `deletion_policy` (`string`): (Optional) Set to \u0026#39;ABANDON\u0026#39; to allow the Apple to be untracked from terraform state\nrather than deleted upon \u0026#39;terraform destroy\u0026#39;. This is useful because the Apple may be\nserving traffic. Set to \u0026#39;DELETE\u0026#39; to delete the Apple. Defaults to \u0026#39;DELETE\u0026#39;. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `team_id` (`string`): The Apple Developer Team ID associated with the App in the App Store. When `null`, the `team_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_apple_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, bundle_id, display_name, + api_key_id=null, app_store_id=null, deletion_policy=null, project=null, @@ -17,6 +18,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='google_firebase_apple_app', label=resourceLabel, attrs=self.newAttrs( + api_key_id=api_key_id, app_store_id=app_store_id, bundle_id=bundle_id, deletion_policy=deletion_policy, @@ -27,16 +29,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_firebase_apple_app.newAttrs` constructs a new object with attributes and blocks configured for the `google_firebase_apple_app`\nTerraform resource.\n\nUnlike [google-beta.google_firebase_apple_app.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `app_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object.\n - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore.\n - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the Apple to be untracked from terraform state\nrather than deleted upon 'terraform destroy'. This is useful because the Apple may be\nserving traffic. Set to 'DELETE' to delete the Apple. Defaults to 'DELETE'. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `team_id` (`string`): The Apple Developer Team ID associated with the App in the App Store. When `null`, the `team_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_apple_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_firebase_apple_app` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_firebase_apple_app.newAttrs` constructs a new object with attributes and blocks configured for the `google_firebase_apple_app`\nTerraform resource.\n\nUnlike [google-beta.google_firebase_apple_app.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the AppleApp.\nIf apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the AppleApp.\nThis auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object.\n - `app_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object.\n - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore.\n - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the Apple to be untracked from terraform state\nrather than deleted upon 'terraform destroy'. This is useful because the Apple may be\nserving traffic. Set to 'DELETE' to delete the Apple. Defaults to 'DELETE'. When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `team_id` (`string`): The Apple Developer Team ID associated with the App in the App Store. When `null`, the `team_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_apple_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_firebase_apple_app` resource into the root Terraform configuration.\n', args=[]), newAttrs( bundle_id, display_name, + api_key_id=null, app_store_id=null, deletion_policy=null, project=null, team_id=null, timeouts=null ):: std.prune(a={ + api_key_id: api_key_id, app_store_id: app_store_id, bundle_id: bundle_id, deletion_policy: deletion_policy, @@ -57,6 +61,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withApiKeyId':: d.fn(help='`google-beta.string.withApiKeyId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the api_key_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `api_key_id` field.\n', args=[]), + withApiKeyId(resourceLabel, value): { + resource+: { + google_firebase_apple_app+: { + [resourceLabel]+: { + api_key_id: value, + }, + }, + }, + }, '#withAppStoreId':: d.fn(help='`google-beta.string.withAppStoreId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the app_store_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `app_store_id` field.\n', args=[]), withAppStoreId(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/firebase_web_app.libsonnet b/4.x/_gen/resources/firebase_web_app.libsonnet index 5db48a0..d6735c7 100644 --- a/4.x/_gen/resources/firebase_web_app.libsonnet +++ b/4.x/_gen/resources/firebase_web_app.libsonnet @@ -2,10 +2,11 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='google_firebase_web_app', url='', help='`google_firebase_web_app` represents the `google-beta_google_firebase_web_app` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`google-beta.google_firebase_web_app.new` injects a new `google-beta_google_firebase_web_app` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_firebase_web_app.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_firebase_web_app` using the reference:\n\n $._ref.google-beta_google_firebase_web_app.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_firebase_web_app.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `deletion_policy` (`string`): Set to \u0026#39;ABANDON\u0026#39; to allow the WebApp to be untracked from terraform state\nrather than deleted upon \u0026#39;terraform destroy\u0026#39;. This is useful becaue the WebApp may be\nserving traffic. Set to \u0026#39;DELETE\u0026#39; to delete the WebApp. Default to \u0026#39;ABANDON\u0026#39; When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_web_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_firebase_web_app.new` injects a new `google-beta_google_firebase_web_app` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_firebase_web_app.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_firebase_web_app` using the reference:\n\n $._ref.google-beta_google_firebase_web_app.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_firebase_web_app.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp.\nIf apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the WebApp.\nThis auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object.\n - `deletion_policy` (`string`): Set to \u0026#39;ABANDON\u0026#39; to allow the WebApp to be untracked from terraform state\nrather than deleted upon \u0026#39;terraform destroy\u0026#39;. This is useful becaue the WebApp may be\nserving traffic. Set to \u0026#39;DELETE\u0026#39; to delete the WebApp. Default to \u0026#39;ABANDON\u0026#39; When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_web_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name, + api_key_id=null, deletion_policy=null, project=null, timeouts=null, @@ -14,6 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='google_firebase_web_app', label=resourceLabel, attrs=self.newAttrs( + api_key_id=api_key_id, deletion_policy=deletion_policy, display_name=display_name, project=project, @@ -21,13 +23,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_firebase_web_app.newAttrs` constructs a new object with attributes and blocks configured for the `google_firebase_web_app`\nTerraform resource.\n\nUnlike [google-beta.google_firebase_web_app.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `deletion_policy` (`string`): Set to 'ABANDON' to allow the WebApp to be untracked from terraform state\nrather than deleted upon 'terraform destroy'. This is useful becaue the WebApp may be\nserving traffic. Set to 'DELETE' to delete the WebApp. Default to 'ABANDON' When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_web_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_firebase_web_app` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_firebase_web_app.newAttrs` constructs a new object with attributes and blocks configured for the `google_firebase_web_app`\nTerraform resource.\n\nUnlike [google-beta.google_firebase_web_app.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp.\nIf apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the WebApp.\nThis auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object.\n - `deletion_policy` (`string`): Set to 'ABANDON' to allow the WebApp to be untracked from terraform state\nrather than deleted upon 'terraform destroy'. This is useful becaue the WebApp may be\nserving traffic. Set to 'DELETE' to delete the WebApp. Default to 'ABANDON' When `null`, the `deletion_policy` field will be omitted from the resulting object.\n - `display_name` (`string`): The user-assigned display name of the App.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_firebase_web_app.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_firebase_web_app` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, + api_key_id=null, deletion_policy=null, project=null, timeouts=null ):: std.prune(a={ + api_key_id: api_key_id, deletion_policy: deletion_policy, display_name: display_name, project: project, @@ -45,6 +49,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withApiKeyId':: d.fn(help='`google-beta.string.withApiKeyId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the api_key_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `api_key_id` field.\n', args=[]), + withApiKeyId(resourceLabel, value): { + resource+: { + google_firebase_web_app+: { + [resourceLabel]+: { + api_key_id: value, + }, + }, + }, + }, '#withDeletionPolicy':: d.fn(help='`google-beta.string.withDeletionPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the deletion_policy field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `deletion_policy` field.\n', args=[]), withDeletionPolicy(resourceLabel, value): { resource+: { diff --git a/4.x/_gen/resources/gke_hub_membership_rbac_role_binding.libsonnet b/4.x/_gen/resources/gke_hub_membership_rbac_role_binding.libsonnet new file mode 100644 index 0000000..a1f0ea4 --- /dev/null +++ b/4.x/_gen/resources/gke_hub_membership_rbac_role_binding.libsonnet @@ -0,0 +1,156 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='google_gke_hub_membership_rbac_role_binding', url='', help='`google_gke_hub_membership_rbac_role_binding` represents the `google-beta_google_gke_hub_membership_rbac_role_binding` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google-beta.google_gke_hub_membership_rbac_role_binding.new` injects a new `google-beta_google_gke_hub_membership_rbac_role_binding` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_gke_hub_membership_rbac_role_binding.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_gke_hub_membership_rbac_role_binding` using the reference:\n\n $._ref.google-beta_google_gke_hub_membership_rbac_role_binding.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_gke_hub_membership_rbac_role_binding.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `location` (`string`): Location of the Membership\n - `membership_id` (`string`): Id of the membership\n - `membership_rbac_role_binding_id` (`string`): The client-provided identifier of the RBAC Role Binding.\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 - `user` (`string`): Principal that is be authorized in the cluster (at least of one the oneof\nis required). Updating one will unset the other automatically.\nuser is the name of the user as seen by the kubernetes cluster, example\n\u0026#34;alice\u0026#34; or \u0026#34;alice@domain.tld\u0026#34;\n - `role` (`list[obj]`): Role to bind to the principal. When `null`, the `role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gke_hub_membership_rbac_role_binding.role.new](#fn-rolenew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gke_hub_membership_rbac_role_binding.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + location, + membership_id, + membership_rbac_role_binding_id, + user, + project=null, + role=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_gke_hub_membership_rbac_role_binding', + label=resourceLabel, + attrs=self.newAttrs( + location=location, + membership_id=membership_id, + membership_rbac_role_binding_id=membership_rbac_role_binding_id, + project=project, + role=role, + timeouts=timeouts, + user=user + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google-beta.google_gke_hub_membership_rbac_role_binding.newAttrs` constructs a new object with attributes and blocks configured for the `google_gke_hub_membership_rbac_role_binding`\nTerraform resource.\n\nUnlike [google-beta.google_gke_hub_membership_rbac_role_binding.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `location` (`string`): Location of the Membership\n - `membership_id` (`string`): Id of the membership\n - `membership_rbac_role_binding_id` (`string`): The client-provided identifier of the RBAC Role Binding.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `user` (`string`): Principal that is be authorized in the cluster (at least of one the oneof\nis required). Updating one will unset the other automatically.\nuser is the name of the user as seen by the kubernetes cluster, example\n"alice" or "alice@domain.tld"\n - `role` (`list[obj]`): Role to bind to the principal. When `null`, the `role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gke_hub_membership_rbac_role_binding.role.new](#fn-rolenew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gke_hub_membership_rbac_role_binding.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_gke_hub_membership_rbac_role_binding` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + location, + membership_id, + membership_rbac_role_binding_id, + user, + project=null, + role=null, + timeouts=null + ):: std.prune(a={ + location: location, + membership_id: membership_id, + membership_rbac_role_binding_id: membership_rbac_role_binding_id, + project: project, + role: role, + timeouts: timeouts, + user: user, + }), + role:: { + '#new':: d.fn(help='\n`google-beta.google_gke_hub_membership_rbac_role_binding.role.new` constructs a new object with attributes and blocks configured for the `role`\nTerraform sub block.\n\n\n\n**Args**:\n - `predefined_role` (`string`): PredefinedRole is an ENUM representation of the default Kubernetes Roles Possible values: ["UNKNOWN", "ADMIN", "EDIT", "VIEW", "ANTHOS_SUPPORT"]\n\n**Returns**:\n - An attribute object that represents the `role` sub block.\n', args=[]), + new( + predefined_role + ):: std.prune(a={ + predefined_role: predefined_role, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`google-beta.google_gke_hub_membership_rbac_role_binding.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, + '#withLocation':: d.fn(help='`google-beta.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_gke_hub_membership_rbac_role_binding+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withMembershipId':: d.fn(help='`google-beta.string.withMembershipId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the membership_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `membership_id` field.\n', args=[]), + withMembershipId(resourceLabel, value): { + resource+: { + google_gke_hub_membership_rbac_role_binding+: { + [resourceLabel]+: { + membership_id: value, + }, + }, + }, + }, + '#withMembershipRbacRoleBindingId':: d.fn(help='`google-beta.string.withMembershipRbacRoleBindingId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the membership_rbac_role_binding_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `membership_rbac_role_binding_id` field.\n', args=[]), + withMembershipRbacRoleBindingId(resourceLabel, value): { + resource+: { + google_gke_hub_membership_rbac_role_binding+: { + [resourceLabel]+: { + membership_rbac_role_binding_id: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google-beta.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_gke_hub_membership_rbac_role_binding+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRole':: d.fn(help='`google-beta.list[obj].withRole` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the role field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [google-beta.list[obj].withRoleMixin](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 `role` field.\n', args=[]), + withRole(resourceLabel, value): { + resource+: { + google_gke_hub_membership_rbac_role_binding+: { + [resourceLabel]+: { + role: value, + }, + }, + }, + }, + '#withRoleMixin':: d.fn(help='`google-beta.list[obj].withRoleMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the role field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [google-beta.list[obj].withRole](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 `role` field.\n', args=[]), + withRoleMixin(resourceLabel, value): { + resource+: { + google_gke_hub_membership_rbac_role_binding+: { + [resourceLabel]+: { + role+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google-beta.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google-beta.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_gke_hub_membership_rbac_role_binding+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google-beta.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google-beta.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_gke_hub_membership_rbac_role_binding+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withUser':: d.fn(help='`google-beta.string.withUser` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the user 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 `user` field.\n', args=[]), + withUser(resourceLabel, value): { + resource+: { + google_gke_hub_membership_rbac_role_binding+: { + [resourceLabel]+: { + user: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/project_access_approval_settings.libsonnet b/4.x/_gen/resources/project_access_approval_settings.libsonnet index 19b5bb9..acced89 100644 --- a/4.x/_gen/resources/project_access_approval_settings.libsonnet +++ b/4.x/_gen/resources/project_access_approval_settings.libsonnet @@ -12,7 +12,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enrollment_level: enrollment_level, }), }, - '#new':: d.fn(help="\n`google-beta.google_project_access_approval_settings.new` injects a new `google-beta_google_project_access_approval_settings` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_project_access_approval_settings.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_project_access_approval_settings` using the reference:\n\n $._ref.google-beta_google_project_access_approval_settings.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_project_access_approval_settings.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `active_key_version` (`string`): The asymmetric crypto key version to use for signing approval requests.\nEmpty active_key_version indicates that a Google-managed key should be used for signing.\nThis property will be ignored if set by an ancestor of the resource, and new non-empty values may not be set. When `null`, the `active_key_version` field will be omitted from the resulting object.\n - `notification_emails` (`list`): A list of email addresses to which notifications relating to approval requests should be sent.\nNotifications relating to a resource will be sent to all emails in the settings of ancestor\nresources of that resource. A maximum of 50 email addresses are allowed. When `null`, the `notification_emails` field will be omitted from the resulting object.\n - `project` (`string`): Deprecated in favor of \u0026#39;project_id\u0026#39; When `null`, the `project` field will be omitted from the resulting object.\n - `project_id` (`string`): ID of the project of the access approval settings.\n - `enrolled_services` (`list[obj]`): A list of Google Cloud Services for which the given resource has Access Approval enrolled.\nAccess requests for the resource given by name against any of these services contained here will be required\nto have explicit approval. Enrollment can only be done on an all or nothing basis.\n\nA maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. When `null`, the `enrolled_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_project_access_approval_settings.enrolled_services.new](#fn-enrolled_servicesnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_project_access_approval_settings.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`google-beta.google_project_access_approval_settings.new` injects a new `google-beta_google_project_access_approval_settings` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google-beta.google_project_access_approval_settings.new('some_id')\n\nYou can get the reference to the `id` field of the created `google-beta.google_project_access_approval_settings` using the reference:\n\n $._ref.google-beta_google_project_access_approval_settings.some_id.get('id')\n\nThis is the same as directly entering `\"${ google-beta_google_project_access_approval_settings.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `active_key_version` (`string`): The asymmetric crypto key version to use for signing approval requests.\nEmpty active_key_version indicates that a Google-managed key should be used for signing.\nThis property will be ignored if set by an ancestor of the resource, and new non-empty values may not be set. When `null`, the `active_key_version` field will be omitted from the resulting object.\n - `notification_emails` (`list`): A list of email addresses to which notifications relating to approval requests should be sent.\nNotifications relating to a resource will be sent to all emails in the settings of ancestor\nresources of that resource. A maximum of 50 email addresses are allowed. When `null`, the `notification_emails` field will be omitted from the resulting object.\n - `project` (`string`): Project id. When `null`, the `project` field will be omitted from the resulting object.\n - `project_id` (`string`): ID of the project of the access approval settings.\n - `enrolled_services` (`list[obj]`): A list of Google Cloud Services for which the given resource has Access Approval enrolled.\nAccess requests for the resource given by name against any of these services contained here will be required\nto have explicit approval. Enrollment can only be done on an all or nothing basis.\n\nA maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. When `null`, the `enrolled_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_project_access_approval_settings.enrolled_services.new](#fn-enrolled_servicesnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_project_access_approval_settings.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, project_id, @@ -35,7 +35,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`google-beta.google_project_access_approval_settings.newAttrs` constructs a new object with attributes and blocks configured for the `google_project_access_approval_settings`\nTerraform resource.\n\nUnlike [google-beta.google_project_access_approval_settings.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `active_key_version` (`string`): The asymmetric crypto key version to use for signing approval requests.\nEmpty active_key_version indicates that a Google-managed key should be used for signing.\nThis property will be ignored if set by an ancestor of the resource, and new non-empty values may not be set. When `null`, the `active_key_version` field will be omitted from the resulting object.\n - `notification_emails` (`list`): A list of email addresses to which notifications relating to approval requests should be sent.\nNotifications relating to a resource will be sent to all emails in the settings of ancestor\nresources of that resource. A maximum of 50 email addresses are allowed. When `null`, the `notification_emails` field will be omitted from the resulting object.\n - `project` (`string`): Deprecated in favor of 'project_id' When `null`, the `project` field will be omitted from the resulting object.\n - `project_id` (`string`): ID of the project of the access approval settings.\n - `enrolled_services` (`list[obj]`): A list of Google Cloud Services for which the given resource has Access Approval enrolled.\nAccess requests for the resource given by name against any of these services contained here will be required\nto have explicit approval. Enrollment can only be done on an all or nothing basis.\n\nA maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. When `null`, the `enrolled_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_project_access_approval_settings.enrolled_services.new](#fn-enrolled_servicesnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_project_access_approval_settings.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_project_access_approval_settings` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`google-beta.google_project_access_approval_settings.newAttrs` constructs a new object with attributes and blocks configured for the `google_project_access_approval_settings`\nTerraform resource.\n\nUnlike [google-beta.google_project_access_approval_settings.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `active_key_version` (`string`): The asymmetric crypto key version to use for signing approval requests.\nEmpty active_key_version indicates that a Google-managed key should be used for signing.\nThis property will be ignored if set by an ancestor of the resource, and new non-empty values may not be set. When `null`, the `active_key_version` field will be omitted from the resulting object.\n - `notification_emails` (`list`): A list of email addresses to which notifications relating to approval requests should be sent.\nNotifications relating to a resource will be sent to all emails in the settings of ancestor\nresources of that resource. A maximum of 50 email addresses are allowed. When `null`, the `notification_emails` field will be omitted from the resulting object.\n - `project` (`string`): Project id. When `null`, the `project` field will be omitted from the resulting object.\n - `project_id` (`string`): ID of the project of the access approval settings.\n - `enrolled_services` (`list[obj]`): A list of Google Cloud Services for which the given resource has Access Approval enrolled.\nAccess requests for the resource given by name against any of these services contained here will be required\nto have explicit approval. Enrollment can only be done on an all or nothing basis.\n\nA maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. When `null`, the `enrolled_services` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_project_access_approval_settings.enrolled_services.new](#fn-enrolled_servicesnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_project_access_approval_settings.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_project_access_approval_settings` resource into the root Terraform configuration.\n', args=[]), newAttrs( project_id, active_key_version=null, diff --git a/4.x/_gen/resources/sql_database_instance.libsonnet b/4.x/_gen/resources/sql_database_instance.libsonnet index ed14e99..00e2b66 100644 --- a/4.x/_gen/resources/sql_database_instance.libsonnet +++ b/4.x/_gen/resources/sql_database_instance.libsonnet @@ -237,13 +237,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); value: value, }), }, - '#new':: d.fn(help='\n`google-beta.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-beta.google_sql_database_instance.settings.ip_configuration.authorized_networks.new](#fn-settingssettingsauthorized_networksnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `ip_configuration` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.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-beta.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-beta.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, enable_private_path_for_google_cloud_services=null, ipv4_enabled=null, private_network=null, + psc_config=null, require_ssl=null ):: std.prune(a={ allocated_ip_range: allocated_ip_range, @@ -251,8 +252,19 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_private_path_for_google_cloud_services: enable_private_path_for_google_cloud_services, ipv4_enabled: ipv4_enabled, private_network: private_network, + psc_config: psc_config, require_ssl: require_ssl, }), + psc_config:: { + '#new':: d.fn(help='\n`google-beta.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=[]), + new( + allowed_consumer_projects=null, + psc_enabled=null + ):: std.prune(a={ + allowed_consumer_projects: allowed_consumer_projects, + psc_enabled: psc_enabled, + }), + }, }, location_preference:: { '#new':: d.fn(help='\n`google-beta.google_sql_database_instance.settings.location_preference.new` constructs a new object with attributes and blocks configured for the `location_preference`\nTerraform sub block.\n\n\n\n**Args**:\n - `follow_gae_application` (`string`): A Google App Engine application whose zone to remain in. Must be in the same region as this instance. When `null`, the `follow_gae_application` field will be omitted from the resulting object.\n - `secondary_zone` (`string`): The preferred Compute Engine zone for the secondary/failover When `null`, the `secondary_zone` field will be omitted from the resulting object.\n - `zone` (`string`): The preferred compute engine zone. When `null`, the `zone` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `location_preference` sub block.\n', args=[]), diff --git a/4.x/_gen/resources/workstations_workstation_config.libsonnet b/4.x/_gen/resources/workstations_workstation_config.libsonnet index dcffdbb..ed5b02e 100644 --- a/4.x/_gen/resources/workstations_workstation_config.libsonnet +++ b/4.x/_gen/resources/workstations_workstation_config.libsonnet @@ -50,12 +50,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_confidential_compute: enable_confidential_compute, }), }, - '#new':: d.fn(help='\n`google-beta.google_workstations_workstation_config.host.gce_instance.new` constructs a new object with attributes and blocks configured for the `gce_instance`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_size_gb` (`number`): Size of the boot disk in GB. When `null`, the `boot_disk_size_gb` field will be omitted from the resulting object.\n - `disable_public_ip_addresses` (`bool`): Whether instances have no public IP address. When `null`, the `disable_public_ip_addresses` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `pool_size` (`number`): Number of instances to pool for faster workstation startup. When `null`, the `pool_size` field will be omitted from the resulting object.\n - `service_account` (`string`): Email address of the service account that will be used on VM instances used to support this config. This service account must have permission to pull the specified container image. If not set, VMs will run without a service account, in which case the image must be publicly accessible. When `null`, the `service_account` field will be omitted from the resulting object.\n - `tags` (`list`): Network tags to add to the Compute Engine machines backing the Workstations. When `null`, the `tags` field will be omitted from the resulting object.\n - `accelerators` (`list[obj]`): An accelerator card attached to the instance. When `null`, the `accelerators` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.gce_instance.accelerators.new](#fn-hosthostacceleratorsnew) constructor.\n - `confidential_instance_config` (`list[obj]`): A set of Compute Engine Confidential VM instance options. When `null`, the `confidential_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.gce_instance.confidential_instance_config.new](#fn-hosthostconfidential_instance_confignew) constructor.\n - `shielded_instance_config` (`list[obj]`): A set of Compute Engine Shielded instance options. When `null`, the `shielded_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.gce_instance.shielded_instance_config.new](#fn-hosthostshielded_instance_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `gce_instance` sub block.\n', args=[]), + '#new':: d.fn(help='\n`google-beta.google_workstations_workstation_config.host.gce_instance.new` constructs a new object with attributes and blocks configured for the `gce_instance`\nTerraform sub block.\n\n\n\n**Args**:\n - `boot_disk_size_gb` (`number`): Size of the boot disk in GB. When `null`, the `boot_disk_size_gb` field will be omitted from the resulting object.\n - `disable_public_ip_addresses` (`bool`): Whether instances have no public IP address. When `null`, the `disable_public_ip_addresses` field will be omitted from the resulting object.\n - `enable_nested_virtualization` (`bool`): Whether to enable nested virtualization on the Compute Engine VMs backing the Workstations.\n\nSee https://cloud.google.com/workstations/docs/reference/rest/v1beta/projects.locations.workstationClusters.workstationConfigs#GceInstance.FIELDS.enable_nested_virtualization When `null`, the `enable_nested_virtualization` field will be omitted from the resulting object.\n - `machine_type` (`string`): The name of a Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object.\n - `pool_size` (`number`): Number of instances to pool for faster workstation startup. When `null`, the `pool_size` field will be omitted from the resulting object.\n - `service_account` (`string`): Email address of the service account that will be used on VM instances used to support this config. This service account must have permission to pull the specified container image. If not set, VMs will run without a service account, in which case the image must be publicly accessible. When `null`, the `service_account` field will be omitted from the resulting object.\n - `tags` (`list`): Network tags to add to the Compute Engine machines backing the Workstations. When `null`, the `tags` field will be omitted from the resulting object.\n - `accelerators` (`list[obj]`): An accelerator card attached to the instance. When `null`, the `accelerators` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.gce_instance.accelerators.new](#fn-hosthostacceleratorsnew) constructor.\n - `confidential_instance_config` (`list[obj]`): A set of Compute Engine Confidential VM instance options. When `null`, the `confidential_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.gce_instance.confidential_instance_config.new](#fn-hosthostconfidential_instance_confignew) constructor.\n - `shielded_instance_config` (`list[obj]`): A set of Compute Engine Shielded instance options. When `null`, the `shielded_instance_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_workstations_workstation_config.host.gce_instance.shielded_instance_config.new](#fn-hosthostshielded_instance_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `gce_instance` sub block.\n', args=[]), new( accelerators=null, boot_disk_size_gb=null, confidential_instance_config=null, disable_public_ip_addresses=null, + enable_nested_virtualization=null, machine_type=null, pool_size=null, service_account=null, @@ -66,6 +67,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); boot_disk_size_gb: boot_disk_size_gb, confidential_instance_config: confidential_instance_config, disable_public_ip_addresses: disable_public_ip_addresses, + enable_nested_virtualization: enable_nested_virtualization, machine_type: machine_type, pool_size: pool_size, service_account: service_account, diff --git a/docs/4.x/README.md b/docs/4.x/README.md index ab050a4..0995370 100644 --- a/docs/4.x/README.md +++ b/docs/4.x/README.md @@ -93,6 +93,7 @@ project. * [google_bigquery_analytics_hub_listing_iam_binding](google_bigquery_analytics_hub_listing_iam_binding.md) * [google_bigquery_analytics_hub_listing_iam_member](google_bigquery_analytics_hub_listing_iam_member.md) * [google_bigquery_analytics_hub_listing_iam_policy](google_bigquery_analytics_hub_listing_iam_policy.md) +* [google_bigquery_bi_reservation](google_bigquery_bi_reservation.md) * [google_bigquery_capacity_commitment](google_bigquery_capacity_commitment.md) * [google_bigquery_connection](google_bigquery_connection.md) * [google_bigquery_connection_iam_binding](google_bigquery_connection_iam_binding.md) @@ -142,6 +143,7 @@ project. * [google_certificate_manager_certificate_map](google_certificate_manager_certificate_map.md) * [google_certificate_manager_certificate_map_entry](google_certificate_manager_certificate_map_entry.md) * [google_certificate_manager_dns_authorization](google_certificate_manager_dns_authorization.md) +* [google_certificate_manager_trust_config](google_certificate_manager_trust_config.md) * [google_cloud_asset_folder_feed](google_cloud_asset_folder_feed.md) * [google_cloud_asset_organization_feed](google_cloud_asset_organization_feed.md) * [google_cloud_asset_project_feed](google_cloud_asset_project_feed.md) @@ -368,6 +370,7 @@ project. * [google_dataflow_job](google_dataflow_job.md) * [google_dataform_repository](google_dataform_repository.md) * [google_dataform_repository_release_config](google_dataform_repository_release_config.md) +* [google_dataform_repository_workflow_config](google_dataform_repository_workflow_config.md) * [google_dataplex_asset](google_dataplex_asset.md) * [google_dataplex_asset_iam_binding](google_dataplex_asset_iam_binding.md) * [google_dataplex_asset_iam_member](google_dataplex_asset_iam_member.md) @@ -495,6 +498,7 @@ project. * [google_gke_hub_membership_iam_binding](google_gke_hub_membership_iam_binding.md) * [google_gke_hub_membership_iam_member](google_gke_hub_membership_iam_member.md) * [google_gke_hub_membership_iam_policy](google_gke_hub_membership_iam_policy.md) +* [google_gke_hub_membership_rbac_role_binding](google_gke_hub_membership_rbac_role_binding.md) * [google_gkeonprem_bare_metal_admin_cluster](google_gkeonprem_bare_metal_admin_cluster.md) * [google_gkeonprem_bare_metal_cluster](google_gkeonprem_bare_metal_cluster.md) * [google_gkeonprem_bare_metal_node_pool](google_gkeonprem_bare_metal_node_pool.md) diff --git a/docs/4.x/data/google_sql_database_instance_latest_recovery_time.md b/docs/4.x/data/google_sql_database_instance_latest_recovery_time.md new file mode 100644 index 0000000..14edb61 --- /dev/null +++ b/docs/4.x/data/google_sql_database_instance_latest_recovery_time.md @@ -0,0 +1,111 @@ +--- +permalink: /data/google_sql_database_instance_latest_recovery_time/ +--- + +# data.google_sql_database_instance_latest_recovery_time + +`google_sql_database_instance_latest_recovery_time` represents the `google-beta_google_sql_database_instance_latest_recovery_time` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withInstance()`](#fn-withinstance) +* [`fn withProject()`](#fn-withproject) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.data.google_sql_database_instance_latest_recovery_time.new` injects a new `data_google-beta_google_sql_database_instance_latest_recovery_time` Terraform `data source` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + google-beta.data.google_sql_database_instance_latest_recovery_time.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.data.google_sql_database_instance_latest_recovery_time` using the reference: + + $._ref.data_google-beta_google_sql_database_instance_latest_recovery_time.some_id.get('id') + +This is the same as directly entering `"${ data_google-beta_google_sql_database_instance_latest_recovery_time.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block. + - `instance` (`string`): Set the `instance` field on the resulting data source block. + - `project` (`string`): Set the `project` field on the resulting data source block. When `null`, the `project` field will be omitted from the resulting object. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.data.google_sql_database_instance_latest_recovery_time.newAttrs` constructs a new object with attributes and blocks configured for the `google_sql_database_instance_latest_recovery_time` +Terraform data source. + +Unlike [google-beta.data.google_sql_database_instance_latest_recovery_time.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `instance` (`string`): Set the `instance` field on the resulting object. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `google_sql_database_instance_latest_recovery_time` data source into the root Terraform configuration. + + +### fn withInstance + +```ts +withInstance() +``` + +`google-beta.string.withInstance` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the instance field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `instance` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the project field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. diff --git a/docs/4.x/data/index.md b/docs/4.x/data/index.md index 85b190f..346fcf6 100644 --- a/docs/4.x/data/index.md +++ b/docs/4.x/data/index.md @@ -229,6 +229,7 @@ permalink: /data/ * [google_sql_ca_certs](google_sql_ca_certs.md) * [google_sql_database](google_sql_database.md) * [google_sql_database_instance](google_sql_database_instance.md) +* [google_sql_database_instance_latest_recovery_time](google_sql_database_instance_latest_recovery_time.md) * [google_sql_database_instances](google_sql_database_instances.md) * [google_sql_databases](google_sql_databases.md) * [google_sql_tiers](google_sql_tiers.md) diff --git a/docs/4.x/google_alloydb_cluster.md b/docs/4.x/google_alloydb_cluster.md index 81de9b7..3250864 100644 --- a/docs/4.x/google_alloydb_cluster.md +++ b/docs/4.x/google_alloydb_cluster.md @@ -29,6 +29,10 @@ This package contains functions and utilities for setting up the resource using * [`fn withLocation()`](#fn-withlocation) * [`fn withNetwork()`](#fn-withnetwork) * [`fn withProject()`](#fn-withproject) +* [`fn withRestoreBackupSource()`](#fn-withrestorebackupsource) +* [`fn withRestoreBackupSourceMixin()`](#fn-withrestorebackupsourcemixin) +* [`fn withRestoreContinuousBackupSource()`](#fn-withrestorecontinuousbackupsource) +* [`fn withRestoreContinuousBackupSourceMixin()`](#fn-withrestorecontinuousbackupsourcemixin) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj automated_backup_policy`](#obj-automated_backup_policy) @@ -51,6 +55,10 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-encryption_confignew) * [`obj initial_user`](#obj-initial_user) * [`fn new()`](#fn-initial_usernew) +* [`obj restore_backup_source`](#obj-restore_backup_source) + * [`fn new()`](#fn-restore_backup_sourcenew) +* [`obj restore_continuous_backup_source`](#obj-restore_continuous_backup_source) + * [`fn new()`](#fn-restore_continuous_backup_sourcenew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) @@ -97,6 +105,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using If no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor. - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor. - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor. + - `restore_backup_source` (`list[obj]`): The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. When `null`, the `restore_backup_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.restore_backup_source.new](#fn-restore_backup_sourcenew) constructor. + - `restore_continuous_backup_source` (`list[obj]`): The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. When `null`, the `restore_continuous_backup_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.restore_continuous_backup_source.new](#fn-restore_continuous_backup_sourcenew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -135,6 +145,8 @@ injecting into a complete block. If no policy is provided then the default policy will be used. The default policy takes one backup a day and retains backups for 14 days. When `null`, the `continuous_backup_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.continuous_backup_config.new](#fn-continuous_backup_confignew) constructor. - `encryption_config` (`list[obj]`): EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). When `null`, the `encryption_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.encryption_config.new](#fn-encryption_confignew) constructor. - `initial_user` (`list[obj]`): Initial user to setup during cluster creation. When `null`, the `initial_user` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.initial_user.new](#fn-initial_usernew) constructor. + - `restore_backup_source` (`list[obj]`): The source when restoring from a backup. Conflicts with 'restore_continuous_backup_source', both can't be set together. When `null`, the `restore_backup_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.restore_backup_source.new](#fn-restore_backup_sourcenew) constructor. + - `restore_continuous_backup_source` (`list[obj]`): The source when restoring via point in time recovery (PITR). Conflicts with 'restore_backup_source', both can't be set together. When `null`, the `restore_continuous_backup_source` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.restore_continuous_backup_source.new](#fn-restore_continuous_backup_sourcenew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_cluster.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -385,6 +397,80 @@ Terraform resource block to set or update the project field. - `value` (`string`): The value to set for the `project` field. +### fn withRestoreBackupSource + +```ts +withRestoreBackupSource() +``` + +`google-beta.list[obj].withRestoreBackupSource` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the restore_backup_source field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google-beta.list[obj].withRestoreBackupSourceMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `restore_backup_source` field. + + +### fn withRestoreBackupSourceMixin + +```ts +withRestoreBackupSourceMixin() +``` + +`google-beta.list[obj].withRestoreBackupSourceMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the restore_backup_source field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google-beta.list[obj].withRestoreBackupSource](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `restore_backup_source` field. + + +### fn withRestoreContinuousBackupSource + +```ts +withRestoreContinuousBackupSource() +``` + +`google-beta.list[obj].withRestoreContinuousBackupSource` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the restore_continuous_backup_source field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google-beta.list[obj].withRestoreContinuousBackupSourceMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `restore_continuous_backup_source` field. + + +### fn withRestoreContinuousBackupSourceMixin + +```ts +withRestoreContinuousBackupSourceMixin() +``` + +`google-beta.list[obj].withRestoreContinuousBackupSourceMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the restore_continuous_backup_source field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google-beta.list[obj].withRestoreContinuousBackupSource](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `restore_continuous_backup_source` field. + + ### fn withTimeouts ```ts @@ -672,6 +758,53 @@ Terraform sub block. - An attribute object that represents the `initial_user` sub block. +## obj restore_backup_source + + + +### fn restore_backup_source.new + +```ts +new() +``` + + +`google-beta.google_alloydb_cluster.restore_backup_source.new` constructs a new object with attributes and blocks configured for the `restore_backup_source` +Terraform sub block. + + + +**Args**: + - `backup_name` (`string`): The name of the backup that this cluster is restored from. + +**Returns**: + - An attribute object that represents the `restore_backup_source` sub block. + + +## obj restore_continuous_backup_source + + + +### fn restore_continuous_backup_source.new + +```ts +new() +``` + + +`google-beta.google_alloydb_cluster.restore_continuous_backup_source.new` constructs a new object with attributes and blocks configured for the `restore_continuous_backup_source` +Terraform sub block. + + + +**Args**: + - `cluster` (`string`): The name of the source cluster that this cluster is restored from. + - `point_in_time` (`string`): The point in time that this cluster is restored to, in RFC 3339 format. + +**Returns**: + - An attribute object that represents the `restore_continuous_backup_source` sub block. + + ## obj timeouts diff --git a/docs/4.x/google_alloydb_instance.md b/docs/4.x/google_alloydb_instance.md index 667d390..9eaa3de 100644 --- a/docs/4.x/google_alloydb_instance.md +++ b/docs/4.x/google_alloydb_instance.md @@ -82,7 +82,7 @@ can have regional availability (nodes are present in 2 or more zones in a region - `instance_type` (`string`): The type of the instance. If the instance type is READ_POOL, provide the associated PRIMARY instance in the 'depends_on' meta-data attribute. Possible values: ["PRIMARY", "READ_POOL"] - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object. - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.machine_config.new](#fn-machine_confignew) constructor. - - `read_pool_config` (`list[obj]`): Read pool specific config. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor. + - `read_pool_config` (`list[obj]`): Read pool specific config. If the instance type is READ_POOL, this configuration must be provided. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -123,7 +123,7 @@ can have regional availability (nodes are present in 2 or more zones in a region - `instance_type` (`string`): The type of the instance. If the instance type is READ_POOL, provide the associated PRIMARY instance in the 'depends_on' meta-data attribute. Possible values: ["PRIMARY", "READ_POOL"] - `labels` (`obj`): User-defined labels for the alloydb instance. When `null`, the `labels` field will be omitted from the resulting object. - `machine_config` (`list[obj]`): Configurations for the machines that host the underlying database engine. When `null`, the `machine_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.machine_config.new](#fn-machine_confignew) constructor. - - `read_pool_config` (`list[obj]`): Read pool specific config. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor. + - `read_pool_config` (`list[obj]`): Read pool specific config. If the instance type is READ_POOL, this configuration must be provided. When `null`, the `read_pool_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.read_pool_config.new](#fn-read_pool_confignew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_alloydb_instance.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: diff --git a/docs/4.x/google_apigee_instance_attachment.md b/docs/4.x/google_apigee_instance_attachment.md index 7d80bdf..061bd8c 100644 --- a/docs/4.x/google_apigee_instance_attachment.md +++ b/docs/4.x/google_apigee_instance_attachment.md @@ -53,7 +53,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `environment` (`string`): The resource ID of the environment. - `instance_id` (`string`): The Apigee instance associated with the Apigee environment, -in the format 'organisations/{{org_name}}/instances/{{instance_name}}'. +in the format 'organizations/{{org_name}}/instances/{{instance_name}}'. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_apigee_instance_attachment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -80,7 +80,7 @@ injecting into a complete block. **Args**: - `environment` (`string`): The resource ID of the environment. - `instance_id` (`string`): The Apigee instance associated with the Apigee environment, -in the format 'organisations/{{org_name}}/instances/{{instance_name}}'. +in the format 'organizations/{{org_name}}/instances/{{instance_name}}'. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_apigee_instance_attachment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: diff --git a/docs/4.x/google_artifact_registry_repository.md b/docs/4.x/google_artifact_registry_repository.md index ccab68c..4463e5e 100644 --- a/docs/4.x/google_artifact_registry_repository.md +++ b/docs/4.x/google_artifact_registry_repository.md @@ -15,6 +15,9 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withCleanupPolicies()`](#fn-withcleanuppolicies) +* [`fn withCleanupPoliciesMixin()`](#fn-withcleanuppoliciesmixin) +* [`fn withCleanupPolicyDryRun()`](#fn-withcleanuppolicydryrun) * [`fn withDescription()`](#fn-withdescription) * [`fn withDockerConfig()`](#fn-withdockerconfig) * [`fn withDockerConfigMixin()`](#fn-withdockerconfigmixin) @@ -33,6 +36,12 @@ This package contains functions and utilities for setting up the resource using * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`fn withVirtualRepositoryConfig()`](#fn-withvirtualrepositoryconfig) * [`fn withVirtualRepositoryConfigMixin()`](#fn-withvirtualrepositoryconfigmixin) +* [`obj cleanup_policies`](#obj-cleanup_policies) + * [`fn new()`](#fn-cleanup_policiesnew) + * [`obj cleanup_policies.condition`](#obj-cleanup_policiescondition) + * [`fn new()`](#fn-cleanup_policiesconditionnew) + * [`obj cleanup_policies.most_recent_versions`](#obj-cleanup_policiesmost_recent_versions) + * [`fn new()`](#fn-cleanup_policiesmost_recent_versionsnew) * [`obj docker_config`](#obj-docker_config) * [`fn new()`](#fn-docker_confignew) * [`obj maven_config`](#obj-maven_config) @@ -83,6 +92,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. + - `cleanup_policy_dry_run` (`bool`): If true, the cleanup pipeline is prevented from deleting versions in this +repository. When `null`, the `cleanup_policy_dry_run` field will be omitted from the resulting object. - `description` (`string`): The user-provided description of the repository. When `null`, the `description` field will be omitted from the resulting object. - `format` (`string`): The format of packages that are stored in the repository. Supported formats can be found [here](https://cloud.google.com/artifact-registry/docs/supported-formats). @@ -102,6 +113,10 @@ and dashes. When `null`, the `labels` field will be omitted from the resulting o - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. - `repository_id` (`string`): The last part of the repository name, for example: "repo1" + - `cleanup_policies` (`list[obj]`): Cleanup policies for this repository. Cleanup policies indicate when +certain package versions can be automatically deleted. +Map keys are policy IDs supplied by users during policy creation. They must +unique within a repository and be under 128 characters in length. When `null`, the `cleanup_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.cleanup_policies.new](#fn-cleanup_policiesnew) constructor. - `docker_config` (`list[obj]`): Docker repository config contains repository level configuration for the repositories of docker type. When `null`, the `docker_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.docker_config.new](#fn-docker_confignew) constructor. - `maven_config` (`list[obj]`): MavenRepositoryConfig is maven related repository details. Provides additional configuration details for repositories of the maven @@ -132,6 +147,8 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: + - `cleanup_policy_dry_run` (`bool`): If true, the cleanup pipeline is prevented from deleting versions in this +repository. When `null`, the `cleanup_policy_dry_run` field will be omitted from the resulting object. - `description` (`string`): The user-provided description of the repository. When `null`, the `description` field will be omitted from the resulting object. - `format` (`string`): The format of packages that are stored in the repository. Supported formats can be found [here](https://cloud.google.com/artifact-registry/docs/supported-formats). @@ -151,6 +168,10 @@ and dashes. When `null`, the `labels` field will be omitted from the resulting o - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. - `repository_id` (`string`): The last part of the repository name, for example: "repo1" + - `cleanup_policies` (`list[obj]`): Cleanup policies for this repository. Cleanup policies indicate when +certain package versions can be automatically deleted. +Map keys are policy IDs supplied by users during policy creation. They must +unique within a repository and be under 128 characters in length. When `null`, the `cleanup_policies` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.cleanup_policies.new](#fn-cleanup_policiesnew) constructor. - `docker_config` (`list[obj]`): Docker repository config contains repository level configuration for the repositories of docker type. When `null`, the `docker_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.docker_config.new](#fn-docker_confignew) constructor. - `maven_config` (`list[obj]`): MavenRepositoryConfig is maven related repository details. Provides additional configuration details for repositories of the maven @@ -163,6 +184,59 @@ format type. When `null`, the `maven_config` sub block will be omitted from the - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_artifact_registry_repository` resource into the root Terraform configuration. +### fn withCleanupPolicies + +```ts +withCleanupPolicies() +``` + +`google-beta.list[obj].withCleanupPolicies` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the cleanup_policies field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google-beta.list[obj].withCleanupPoliciesMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `cleanup_policies` field. + + +### fn withCleanupPoliciesMixin + +```ts +withCleanupPoliciesMixin() +``` + +`google-beta.list[obj].withCleanupPoliciesMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the cleanup_policies field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google-beta.list[obj].withCleanupPolicies](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `cleanup_policies` field. + + +### fn withCleanupPolicyDryRun + +```ts +withCleanupPolicyDryRun() +``` + +`google-beta.bool.withCleanupPolicyDryRun` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the cleanup_policy_dry_run field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `cleanup_policy_dry_run` field. + + ### fn withDescription ```ts @@ -475,6 +549,84 @@ function. - `value` (`list[obj]`): The value to set for the `virtual_repository_config` field. +## obj cleanup_policies + + + +### fn cleanup_policies.new + +```ts +new() +``` + + +`google-beta.google_artifact_registry_repository.cleanup_policies.new` constructs a new object with attributes and blocks configured for the `cleanup_policies` +Terraform sub block. + + + +**Args**: + - `action` (`string`): Policy action. Possible values: ["DELETE", "KEEP"] When `null`, the `action` field will be omitted from the resulting object. + - `condition` (`list[obj]`): Policy condition for matching versions. When `null`, the `condition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.cleanup_policies.condition.new](#fn-cleanup_policiesconditionnew) constructor. + - `most_recent_versions` (`list[obj]`): Policy condition for retaining a minimum number of versions. May only be +specified with a Keep action. When `null`, the `most_recent_versions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_artifact_registry_repository.cleanup_policies.most_recent_versions.new](#fn-cleanup_policiesmost_recent_versionsnew) constructor. + +**Returns**: + - An attribute object that represents the `cleanup_policies` sub block. + + +## obj cleanup_policies.condition + + + +### fn cleanup_policies.condition.new + +```ts +new() +``` + + +`google-beta.google_artifact_registry_repository.cleanup_policies.condition.new` constructs a new object with attributes and blocks configured for the `condition` +Terraform sub block. + + + +**Args**: + - `newer_than` (`string`): Match versions newer than a duration. When `null`, the `newer_than` field will be omitted from the resulting object. + - `older_than` (`string`): Match versions older than a duration. When `null`, the `older_than` field will be omitted from the resulting object. + - `package_name_prefixes` (`list`): Match versions by package prefix. Applied on any prefix match. When `null`, the `package_name_prefixes` field will be omitted from the resulting object. + - `tag_prefixes` (`list`): Match versions by tag prefix. Applied on any prefix match. When `null`, the `tag_prefixes` field will be omitted from the resulting object. + - `tag_state` (`string`): Match versions by tag status. Default value: "ANY" Possible values: ["TAGGED", "UNTAGGED", "ANY"] When `null`, the `tag_state` field will be omitted from the resulting object. + - `version_name_prefixes` (`list`): Match versions by version name prefix. Applied on any prefix match. When `null`, the `version_name_prefixes` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `condition` sub block. + + +## obj cleanup_policies.most_recent_versions + + + +### fn cleanup_policies.most_recent_versions.new + +```ts +new() +``` + + +`google-beta.google_artifact_registry_repository.cleanup_policies.most_recent_versions.new` constructs a new object with attributes and blocks configured for the `most_recent_versions` +Terraform sub block. + + + +**Args**: + - `keep_count` (`number`): Minimum number of versions to keep. When `null`, the `keep_count` field will be omitted from the resulting object. + - `package_name_prefixes` (`list`): Match versions by package prefix. Applied on any prefix match. When `null`, the `package_name_prefixes` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `most_recent_versions` sub block. + + ## obj docker_config diff --git a/docs/4.x/google_bigquery_bi_reservation.md b/docs/4.x/google_bigquery_bi_reservation.md new file mode 100644 index 0000000..6be6238 --- /dev/null +++ b/docs/4.x/google_bigquery_bi_reservation.md @@ -0,0 +1,265 @@ +--- +permalink: /google_bigquery_bi_reservation/ +--- + +# google_bigquery_bi_reservation + +`google_bigquery_bi_reservation` represents the `google-beta_google_bigquery_bi_reservation` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withPreferredTables()`](#fn-withpreferredtables) +* [`fn withPreferredTablesMixin()`](#fn-withpreferredtablesmixin) +* [`fn withProject()`](#fn-withproject) +* [`fn withSize()`](#fn-withsize) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj preferred_tables`](#obj-preferred_tables) + * [`fn new()`](#fn-preferred_tablesnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_bigquery_bi_reservation.new` injects a new `google-beta_google_bigquery_bi_reservation` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + google-beta.google_bigquery_bi_reservation.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_bigquery_bi_reservation` using the reference: + + $._ref.google-beta_google_bigquery_bi_reservation.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_bigquery_bi_reservation.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `location` (`string`): LOCATION_DESCRIPTION + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `size` (`number`): Size of a reservation, in bytes. When `null`, the `size` field will be omitted from the resulting object. + - `preferred_tables` (`list[obj]`): Preferred tables to use BI capacity for. When `null`, the `preferred_tables` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_bigquery_bi_reservation.preferred_tables.new](#fn-preferred_tablesnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_bigquery_bi_reservation.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_bigquery_bi_reservation.newAttrs` constructs a new object with attributes and blocks configured for the `google_bigquery_bi_reservation` +Terraform resource. + +Unlike [google-beta.google_bigquery_bi_reservation.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `location` (`string`): LOCATION_DESCRIPTION + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `size` (`number`): Size of a reservation, in bytes. When `null`, the `size` field will be omitted from the resulting object. + - `preferred_tables` (`list[obj]`): Preferred tables to use BI capacity for. When `null`, the `preferred_tables` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_bigquery_bi_reservation.preferred_tables.new](#fn-preferred_tablesnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_bigquery_bi_reservation.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_bigquery_bi_reservation` resource into the root Terraform configuration. + + +### fn withLocation + +```ts +withLocation() +``` + +`google-beta.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withPreferredTables + +```ts +withPreferredTables() +``` + +`google-beta.list[obj].withPreferredTables` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the preferred_tables field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google-beta.list[obj].withPreferredTablesMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `preferred_tables` field. + + +### fn withPreferredTablesMixin + +```ts +withPreferredTablesMixin() +``` + +`google-beta.list[obj].withPreferredTablesMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the preferred_tables field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google-beta.list[obj].withPreferredTables](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `preferred_tables` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withSize + +```ts +withSize() +``` + +`google-beta.number.withSize` constructs a mixin object that can be merged into the `number` +Terraform resource block to set or update the size field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`number`): The value to set for the `size` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google-beta.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google-beta.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google-beta.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj preferred_tables + + + +### fn preferred_tables.new + +```ts +new() +``` + + +`google-beta.google_bigquery_bi_reservation.preferred_tables.new` constructs a new object with attributes and blocks configured for the `preferred_tables` +Terraform sub block. + + + +**Args**: + - `dataset_id` (`string`): The ID of the dataset in the above project. When `null`, the `dataset_id` field will be omitted from the resulting object. + - `project_id` (`string`): The assigned project ID of the project. When `null`, the `project_id` field will be omitted from the resulting object. + - `table_id` (`string`): The ID of the table in the above dataset. When `null`, the `table_id` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `preferred_tables` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_bigquery_bi_reservation.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/google_certificate_manager_certificate.md b/docs/4.x/google_certificate_manager_certificate.md index a50fc3c..1ec211e 100644 --- a/docs/4.x/google_certificate_manager_certificate.md +++ b/docs/4.x/google_certificate_manager_certificate.md @@ -390,14 +390,14 @@ Terraform sub block. **Args**: - - `certificate_pem` (`string`): **Deprecated** The certificate chain in PEM-encoded form. + - `certificate_pem` (`string`): The certificate chain in PEM-encoded form. Leaf certificate comes first, followed by intermediate ones if any. When `null`, the `certificate_pem` field will be omitted from the resulting object. - `pem_certificate` (`string`): The certificate chain in PEM-encoded form. Leaf certificate comes first, followed by intermediate ones if any. When `null`, the `pem_certificate` field will be omitted from the resulting object. - `pem_private_key` (`string`): The private key of the leaf certificate in PEM-encoded form. When `null`, the `pem_private_key` field will be omitted from the resulting object. - - `private_key_pem` (`string`): **Deprecated** The private key of the leaf certificate in PEM-encoded form. When `null`, the `private_key_pem` field will be omitted from the resulting object. + - `private_key_pem` (`string`): The private key of the leaf certificate in PEM-encoded form. When `null`, the `private_key_pem` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `self_managed` sub block. diff --git a/docs/4.x/google_certificate_manager_trust_config.md b/docs/4.x/google_certificate_manager_trust_config.md new file mode 100644 index 0000000..ef86169 --- /dev/null +++ b/docs/4.x/google_certificate_manager_trust_config.md @@ -0,0 +1,357 @@ +--- +permalink: /google_certificate_manager_trust_config/ +--- + +# google_certificate_manager_trust_config + +`google_certificate_manager_trust_config` represents the `google-beta_google_certificate_manager_trust_config` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withLabels()`](#fn-withlabels) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withTrustStores()`](#fn-withtruststores) +* [`fn withTrustStoresMixin()`](#fn-withtruststoresmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) +* [`obj trust_stores`](#obj-trust_stores) + * [`fn new()`](#fn-trust_storesnew) + * [`obj trust_stores.intermediate_cas`](#obj-trust_storesintermediate_cas) + * [`fn new()`](#fn-trust_storesintermediate_casnew) + * [`obj trust_stores.trust_anchors`](#obj-trust_storestrust_anchors) + * [`fn new()`](#fn-trust_storestrust_anchorsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_certificate_manager_trust_config.new` injects a new `google-beta_google_certificate_manager_trust_config` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + google-beta.google_certificate_manager_trust_config.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_certificate_manager_trust_config` using the reference: + + $._ref.google-beta_google_certificate_manager_trust_config.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_certificate_manager_trust_config.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `description` (`string`): One or more paragraphs of text description of a trust config. When `null`, the `description` field will be omitted from the resulting object. + - `labels` (`obj`): Set of label tags associated with the trust config. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The trust config location. + - `name` (`string`): A user-defined name of the trust config. Trust config names must be unique globally. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.timeouts.new](#fn-timeoutsnew) constructor. + - `trust_stores` (`list[obj]`): Set of trust stores to perform validation against. +This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. When `null`, the `trust_stores` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.trust_stores.new](#fn-trust_storesnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_certificate_manager_trust_config.newAttrs` constructs a new object with attributes and blocks configured for the `google_certificate_manager_trust_config` +Terraform resource. + +Unlike [google-beta.google_certificate_manager_trust_config.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `description` (`string`): One or more paragraphs of text description of a trust config. When `null`, the `description` field will be omitted from the resulting object. + - `labels` (`obj`): Set of label tags associated with the trust config. When `null`, the `labels` field will be omitted from the resulting object. + - `location` (`string`): The trust config location. + - `name` (`string`): A user-defined name of the trust config. Trust config names must be unique globally. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.timeouts.new](#fn-timeoutsnew) constructor. + - `trust_stores` (`list[obj]`): Set of trust stores to perform validation against. +This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. When `null`, the `trust_stores` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.trust_stores.new](#fn-trust_storesnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_certificate_manager_trust_config` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`google-beta.string.withDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `description` field. + + +### fn withLabels + +```ts +withLabels() +``` + +`google-beta.obj.withLabels` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the labels field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `labels` field. + + +### fn withLocation + +```ts +withLocation() +``` + +`google-beta.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withName + +```ts +withName() +``` + +`google-beta.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google-beta.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google-beta.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google-beta.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTrustStores + +```ts +withTrustStores() +``` + +`google-beta.list[obj].withTrustStores` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the trust_stores field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google-beta.list[obj].withTrustStoresMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `trust_stores` field. + + +### fn withTrustStoresMixin + +```ts +withTrustStoresMixin() +``` + +`google-beta.list[obj].withTrustStoresMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the trust_stores field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google-beta.list[obj].withTrustStores](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `trust_stores` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_certificate_manager_trust_config.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. + + +## obj trust_stores + + + +### fn trust_stores.new + +```ts +new() +``` + + +`google-beta.google_certificate_manager_trust_config.trust_stores.new` constructs a new object with attributes and blocks configured for the `trust_stores` +Terraform sub block. + + + +**Args**: + - `intermediate_cas` (`list[obj]`): Set of intermediate CA certificates used for the path building phase of chain validation. +The field is currently not supported if trust config is used for the workload certificate feature. When `null`, the `intermediate_cas` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.trust_stores.intermediate_cas.new](#fn-trust_storesintermediate_casnew) constructor. + - `trust_anchors` (`list[obj]`): List of Trust Anchors to be used while performing validation against a given TrustStore. When `null`, the `trust_anchors` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_certificate_manager_trust_config.trust_stores.trust_anchors.new](#fn-trust_storestrust_anchorsnew) constructor. + +**Returns**: + - An attribute object that represents the `trust_stores` sub block. + + +## obj trust_stores.intermediate_cas + + + +### fn trust_stores.intermediate_cas.new + +```ts +new() +``` + + +`google-beta.google_certificate_manager_trust_config.trust_stores.intermediate_cas.new` constructs a new object with attributes and blocks configured for the `intermediate_cas` +Terraform sub block. + + + +**Args**: + - `pem_certificate` (`string`): PEM intermediate certificate used for building up paths for validation. +Each certificate provided in PEM format may occupy up to 5kB. When `null`, the `pem_certificate` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `intermediate_cas` sub block. + + +## obj trust_stores.trust_anchors + + + +### fn trust_stores.trust_anchors.new + +```ts +new() +``` + + +`google-beta.google_certificate_manager_trust_config.trust_stores.trust_anchors.new` constructs a new object with attributes and blocks configured for the `trust_anchors` +Terraform sub block. + + + +**Args**: + - `pem_certificate` (`string`): PEM root certificate of the PKI used for validation. +Each certificate provided in PEM format may occupy up to 5kB. When `null`, the `pem_certificate` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `trust_anchors` sub block. diff --git a/docs/4.x/google_compute_router_peer.md b/docs/4.x/google_compute_router_peer.md index 2ce1dae..b60bf4b 100644 --- a/docs/4.x/google_compute_router_peer.md +++ b/docs/4.x/google_compute_router_peer.md @@ -76,11 +76,11 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `advertise_mode` (`string`): User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: 'DEFAULT', 'CUSTOM' Default value: "DEFAULT" Possible values: ["DEFAULT", "CUSTOM"] When `null`, the `advertise_mode` field will be omitted from the resulting object. - `advertised_groups` (`list`): User-specified list of prefix groups to advertise in custom -mode, which can take one of the following options: +mode, which currently supports the following option: -* 'ALL_SUBNETS': Advertises all available subnets, including peer VPC subnets. -* 'ALL_VPC_SUBNETS': Advertises the router's own VPC subnets. -* 'ALL_PEER_VPC_SUBNETS': Advertises peer subnets of the router's VPC network. +* 'ALL_SUBNETS': Advertises all of the router's own VPC subnets. +This excludes any routes learned for subnets that use VPC Network +Peering. Note that this field can only be populated if advertiseMode is 'CUSTOM' @@ -157,11 +157,11 @@ injecting into a complete block. - `advertise_mode` (`string`): User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: 'DEFAULT', 'CUSTOM' Default value: "DEFAULT" Possible values: ["DEFAULT", "CUSTOM"] When `null`, the `advertise_mode` field will be omitted from the resulting object. - `advertised_groups` (`list`): User-specified list of prefix groups to advertise in custom -mode, which can take one of the following options: +mode, which currently supports the following option: -* 'ALL_SUBNETS': Advertises all available subnets, including peer VPC subnets. -* 'ALL_VPC_SUBNETS': Advertises the router's own VPC subnets. -* 'ALL_PEER_VPC_SUBNETS': Advertises peer subnets of the router's VPC network. +* 'ALL_SUBNETS': Advertises all of the router's own VPC subnets. +This excludes any routes learned for subnets that use VPC Network +Peering. Note that this field can only be populated if advertiseMode is 'CUSTOM' diff --git a/docs/4.x/google_compute_target_instance.md b/docs/4.x/google_compute_target_instance.md index db04e52..1a2d591 100644 --- a/docs/4.x/google_compute_target_instance.md +++ b/docs/4.x/google_compute_target_instance.md @@ -21,6 +21,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withNatPolicy()`](#fn-withnatpolicy) * [`fn withNetwork()`](#fn-withnetwork) * [`fn withProject()`](#fn-withproject) +* [`fn withSecurityPolicy()`](#fn-withsecuritypolicy) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`fn withZone()`](#fn-withzone) @@ -74,6 +75,7 @@ character, which cannot be a dash. Currently only NO_NAT (default value) is supported. Default value: "NO_NAT" Possible values: ["NO_NAT"] When `null`, the `nat_policy` field will be omitted from the resulting object. - `network` (`string`): The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to. When `null`, the `network` field will be omitted from the resulting object. - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `security_policy` (`string`): The resource URL for the security policy associated with this target instance. When `null`, the `security_policy` field will be omitted from the resulting object. - `zone` (`string`): URL of the zone where the target instance resides. When `null`, the `zone` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_instance.timeouts.new](#fn-timeoutsnew) constructor. @@ -117,6 +119,7 @@ character, which cannot be a dash. Currently only NO_NAT (default value) is supported. Default value: "NO_NAT" Possible values: ["NO_NAT"] When `null`, the `nat_policy` field will be omitted from the resulting object. - `network` (`string`): The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to. When `null`, the `network` field will be omitted from the resulting object. - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `security_policy` (`string`): The resource URL for the security policy associated with this target instance. When `null`, the `security_policy` field will be omitted from the resulting object. - `zone` (`string`): URL of the zone where the target instance resides. When `null`, the `zone` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_instance.timeouts.new](#fn-timeoutsnew) constructor. @@ -220,6 +223,22 @@ Terraform resource block to set or update the project field. - `value` (`string`): The value to set for the `project` field. +### fn withSecurityPolicy + +```ts +withSecurityPolicy() +``` + +`google-beta.string.withSecurityPolicy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the security_policy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `security_policy` field. + + ### fn withTimeouts ```ts @@ -291,6 +310,7 @@ Terraform sub block. **Args**: - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/google_compute_target_pool.md b/docs/4.x/google_compute_target_pool.md index 9b5246b..4fc37cf 100644 --- a/docs/4.x/google_compute_target_pool.md +++ b/docs/4.x/google_compute_target_pool.md @@ -23,6 +23,7 @@ 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 withSecurityPolicy()`](#fn-withsecuritypolicy) * [`fn withSessionAffinity()`](#fn-withsessionaffinity) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) @@ -66,6 +67,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `name` (`string`): A unique name for the resource, required by GCE. Changing this forces a new resource to be created. - `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`): Where the target pool resides. Defaults to project region. When `null`, the `region` field will be omitted from the resulting object. + - `security_policy` (`string`): The resource URL for the security policy associated with this target pool. When `null`, the `security_policy` field will be omitted from the resulting object. - `session_affinity` (`string`): How to distribute load. Options are "NONE" (no affinity). "CLIENT_IP" (hash of the source/dest addresses / ports), and "CLIENT_IP_PROTO" also includes the protocol (default "NONE"). When `null`, the `session_affinity` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_pool.timeouts.new](#fn-timeoutsnew) constructor. @@ -99,6 +101,7 @@ injecting into a complete block. - `name` (`string`): A unique name for the resource, required by GCE. Changing this forces a new resource to be created. - `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`): Where the target pool resides. Defaults to project region. When `null`, the `region` field will be omitted from the resulting object. + - `security_policy` (`string`): The resource URL for the security policy associated with this target pool. When `null`, the `security_policy` field will be omitted from the resulting object. - `session_affinity` (`string`): How to distribute load. Options are "NONE" (no affinity). "CLIENT_IP" (hash of the source/dest addresses / ports), and "CLIENT_IP_PROTO" also includes the protocol (default "NONE"). When `null`, the `session_affinity` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_compute_target_pool.timeouts.new](#fn-timeoutsnew) constructor. @@ -234,6 +237,22 @@ Terraform resource block to set or update the region field. - `value` (`string`): The value to set for the `region` field. +### fn withSecurityPolicy + +```ts +withSecurityPolicy() +``` + +`google-beta.string.withSecurityPolicy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the security_policy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `security_policy` field. + + ### fn withSessionAffinity ```ts diff --git a/docs/4.x/google_container_cluster.md b/docs/4.x/google_container_cluster.md index 7ca0a9f..084c69f 100644 --- a/docs/4.x/google_container_cluster.md +++ b/docs/4.x/google_container_cluster.md @@ -184,6 +184,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-identity_service_confignew) * [`obj ip_allocation_policy`](#obj-ip_allocation_policy) * [`fn new()`](#fn-ip_allocation_policynew) + * [`obj ip_allocation_policy.additional_pod_ranges_config`](#obj-ip_allocation_policyadditional_pod_ranges_config) + * [`fn new()`](#fn-ip_allocation_policyadditional_pod_ranges_confignew) * [`obj ip_allocation_policy.pod_cidr_overprovision_config`](#obj-ip_allocation_policypod_cidr_overprovision_config) * [`fn new()`](#fn-ip_allocation_policypod_cidr_overprovision_confignew) * [`obj logging_config`](#obj-logging_config) @@ -3169,12 +3171,36 @@ Terraform sub block. - `services_ipv4_cidr_block` (`string`): The IP address range of the services IPs in this cluster. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. When `null`, the `services_ipv4_cidr_block` field will be omitted from the resulting object. - `services_secondary_range_name` (`string`): The name of the existing secondary range in the cluster's subnetwork to use for service ClusterIPs. Alternatively, services_ipv4_cidr_block can be used to automatically create a GKE-managed one. When `null`, the `services_secondary_range_name` field will be omitted from the resulting object. - `stack_type` (`string`): The IP Stack type of the cluster. Choose between IPV4 and IPV4_IPV6. Default type is IPV4 Only if not set When `null`, the `stack_type` field will be omitted from the resulting object. + - `additional_pod_ranges_config` (`list[obj]`): AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. When `null`, the `additional_pod_ranges_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_cluster.ip_allocation_policy.additional_pod_ranges_config.new](#fn-ip_allocation_policyadditional_pod_ranges_confignew) constructor. - `pod_cidr_overprovision_config` (`list[obj]`): Configuration for cluster level pod cidr overprovision. Default is disabled=false. When `null`, the `pod_cidr_overprovision_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_container_cluster.ip_allocation_policy.pod_cidr_overprovision_config.new](#fn-ip_allocation_policypod_cidr_overprovision_confignew) constructor. **Returns**: - An attribute object that represents the `ip_allocation_policy` sub block. +## obj ip_allocation_policy.additional_pod_ranges_config + + + +### fn ip_allocation_policy.additional_pod_ranges_config.new + +```ts +new() +``` + + +`google-beta.google_container_cluster.ip_allocation_policy.additional_pod_ranges_config.new` constructs a new object with attributes and blocks configured for the `additional_pod_ranges_config` +Terraform sub block. + + + +**Args**: + - `pod_range_names` (`list`): Name for pod secondary ipv4 range which has the actual range defined ahead. + +**Returns**: + - An attribute object that represents the `additional_pod_ranges_config` sub block. + + ## obj ip_allocation_policy.pod_cidr_overprovision_config diff --git a/docs/4.x/google_dataform_repository_workflow_config.md b/docs/4.x/google_dataform_repository_workflow_config.md new file mode 100644 index 0000000..910a330 --- /dev/null +++ b/docs/4.x/google_dataform_repository_workflow_config.md @@ -0,0 +1,371 @@ +--- +permalink: /google_dataform_repository_workflow_config/ +--- + +# google_dataform_repository_workflow_config + +`google_dataform_repository_workflow_config` represents the `google-beta_google_dataform_repository_workflow_config` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withCronSchedule()`](#fn-withcronschedule) +* [`fn withInvocationConfig()`](#fn-withinvocationconfig) +* [`fn withInvocationConfigMixin()`](#fn-withinvocationconfigmixin) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withRegion()`](#fn-withregion) +* [`fn withReleaseConfig()`](#fn-withreleaseconfig) +* [`fn withRepository()`](#fn-withrepository) +* [`fn withTimeZone()`](#fn-withtimezone) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj invocation_config`](#obj-invocation_config) + * [`fn new()`](#fn-invocation_confignew) + * [`obj invocation_config.included_targets`](#obj-invocation_configincluded_targets) + * [`fn new()`](#fn-invocation_configincluded_targetsnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_dataform_repository_workflow_config.new` injects a new `google-beta_google_dataform_repository_workflow_config` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + google-beta.google_dataform_repository_workflow_config.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_dataform_repository_workflow_config` using the reference: + + $._ref.google-beta_google_dataform_repository_workflow_config.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_dataform_repository_workflow_config.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `cron_schedule` (`string`): Optional. Optional schedule (in cron format) for automatic creation of compilation results. When `null`, the `cron_schedule` field will be omitted from the resulting object. + - `name` (`string`): The workflow's name. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): A reference to the region When `null`, the `region` field will be omitted from the resulting object. + - `release_config` (`string`): The name of the release config whose releaseCompilationResult should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*. + - `repository` (`string`): A reference to the Dataform repository When `null`, the `repository` field will be omitted from the resulting object. + - `time_zone` (`string`): Optional. Specifies the time zone to be used when interpreting cronSchedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. When `null`, the `time_zone` field will be omitted from the resulting object. + - `invocation_config` (`list[obj]`): Optional. If left unset, a default InvocationConfig will be used. When `null`, the `invocation_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataform_repository_workflow_config.invocation_config.new](#fn-invocation_confignew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataform_repository_workflow_config.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_dataform_repository_workflow_config.newAttrs` constructs a new object with attributes and blocks configured for the `google_dataform_repository_workflow_config` +Terraform resource. + +Unlike [google-beta.google_dataform_repository_workflow_config.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `cron_schedule` (`string`): Optional. Optional schedule (in cron format) for automatic creation of compilation results. When `null`, the `cron_schedule` field will be omitted from the resulting object. + - `name` (`string`): The workflow's name. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `region` (`string`): A reference to the region When `null`, the `region` field will be omitted from the resulting object. + - `release_config` (`string`): The name of the release config whose releaseCompilationResult should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*. + - `repository` (`string`): A reference to the Dataform repository When `null`, the `repository` field will be omitted from the resulting object. + - `time_zone` (`string`): Optional. Specifies the time zone to be used when interpreting cronSchedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. When `null`, the `time_zone` field will be omitted from the resulting object. + - `invocation_config` (`list[obj]`): Optional. If left unset, a default InvocationConfig will be used. When `null`, the `invocation_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataform_repository_workflow_config.invocation_config.new](#fn-invocation_confignew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataform_repository_workflow_config.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_dataform_repository_workflow_config` resource into the root Terraform configuration. + + +### fn withCronSchedule + +```ts +withCronSchedule() +``` + +`google-beta.string.withCronSchedule` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the cron_schedule field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `cron_schedule` field. + + +### fn withInvocationConfig + +```ts +withInvocationConfig() +``` + +`google-beta.list[obj].withInvocationConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the invocation_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google-beta.list[obj].withInvocationConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `invocation_config` field. + + +### fn withInvocationConfigMixin + +```ts +withInvocationConfigMixin() +``` + +`google-beta.list[obj].withInvocationConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the invocation_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google-beta.list[obj].withInvocationConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `invocation_config` field. + + +### fn withName + +```ts +withName() +``` + +`google-beta.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withRegion + +```ts +withRegion() +``` + +`google-beta.string.withRegion` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the region field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `region` field. + + +### fn withReleaseConfig + +```ts +withReleaseConfig() +``` + +`google-beta.string.withReleaseConfig` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the release_config field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `release_config` field. + + +### fn withRepository + +```ts +withRepository() +``` + +`google-beta.string.withRepository` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the repository field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `repository` field. + + +### fn withTimeZone + +```ts +withTimeZone() +``` + +`google-beta.string.withTimeZone` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the time_zone field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `time_zone` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google-beta.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google-beta.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google-beta.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj invocation_config + + + +### fn invocation_config.new + +```ts +new() +``` + + +`google-beta.google_dataform_repository_workflow_config.invocation_config.new` constructs a new object with attributes and blocks configured for the `invocation_config` +Terraform sub block. + + + +**Args**: + - `fully_refresh_incremental_tables_enabled` (`bool`): Optional. When set to true, any incremental tables will be fully refreshed. When `null`, the `fully_refresh_incremental_tables_enabled` field will be omitted from the resulting object. + - `included_tags` (`list`): Optional. The set of tags to include. When `null`, the `included_tags` field will be omitted from the resulting object. + - `service_account` (`string`): Optional. The service account to run workflow invocations under. When `null`, the `service_account` field will be omitted from the resulting object. + - `transitive_dependencies_included` (`bool`): Optional. When set to true, transitive dependencies of included actions will be executed. When `null`, the `transitive_dependencies_included` field will be omitted from the resulting object. + - `transitive_dependents_included` (`bool`): Optional. When set to true, transitive dependents of included actions will be executed. When `null`, the `transitive_dependents_included` field will be omitted from the resulting object. + - `included_targets` (`list[obj]`): Optional. The set of action identifiers to include. When `null`, the `included_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-beta.google_dataform_repository_workflow_config.invocation_config.included_targets.new](#fn-invocation_configincluded_targetsnew) constructor. + +**Returns**: + - An attribute object that represents the `invocation_config` sub block. + + +## obj invocation_config.included_targets + + + +### fn invocation_config.included_targets.new + +```ts +new() +``` + + +`google-beta.google_dataform_repository_workflow_config.invocation_config.included_targets.new` constructs a new object with attributes and blocks configured for the `included_targets` +Terraform sub block. + + + +**Args**: + - `database` (`string`): The action's database (Google Cloud project ID). When `null`, the `database` field will be omitted from the resulting object. + - `name` (`string`): The action's name, within database and schema. When `null`, the `name` field will be omitted from the resulting object. + - `schema` (`string`): The action's schema (BigQuery dataset ID), within database. When `null`, the `schema` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `included_targets` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_dataform_repository_workflow_config.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/google_dataplex_datascan.md b/docs/4.x/google_dataplex_datascan.md index 8165663..4d0ea14 100644 --- a/docs/4.x/google_dataplex_datascan.md +++ b/docs/4.x/google_dataplex_datascan.md @@ -35,8 +35,20 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-datanew) * [`obj data_profile_spec`](#obj-data_profile_spec) * [`fn new()`](#fn-data_profile_specnew) + * [`obj data_profile_spec.exclude_fields`](#obj-data_profile_specexclude_fields) + * [`fn new()`](#fn-data_profile_specexclude_fieldsnew) + * [`obj data_profile_spec.include_fields`](#obj-data_profile_specinclude_fields) + * [`fn new()`](#fn-data_profile_specinclude_fieldsnew) + * [`obj data_profile_spec.post_scan_actions`](#obj-data_profile_specpost_scan_actions) + * [`fn new()`](#fn-data_profile_specpost_scan_actionsnew) + * [`obj data_profile_spec.post_scan_actions.bigquery_export`](#obj-data_profile_specpost_scan_actionsbigquery_export) + * [`fn new()`](#fn-data_profile_specpost_scan_actionsbigquery_exportnew) * [`obj data_quality_spec`](#obj-data_quality_spec) * [`fn new()`](#fn-data_quality_specnew) + * [`obj data_quality_spec.post_scan_actions`](#obj-data_quality_specpost_scan_actions) + * [`fn new()`](#fn-data_quality_specpost_scan_actionsnew) + * [`obj data_quality_spec.post_scan_actions.bigquery_export`](#obj-data_quality_specpost_scan_actionsbigquery_export) + * [`fn new()`](#fn-data_quality_specpost_scan_actionsbigquery_exportnew) * [`obj data_quality_spec.rules`](#obj-data_quality_specrules) * [`fn new()`](#fn-data_quality_specrulesnew) * [`obj data_quality_spec.rules.non_null_expectation`](#obj-data_quality_specrulesnon_null_expectation) @@ -468,12 +480,116 @@ Terraform sub block. **Args**: - `row_filter` (`string`): A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 When `null`, the `row_filter` field will be omitted from the resulting object. - - `sampling_percent` (`number`): The percentage of the records to be selected from the dataset for DataScan. When `null`, the `sampling_percent` field will be omitted from the resulting object. + - `sampling_percent` (`number`): The percentage of the records to be selected from the dataset for DataScan. +Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. +Sampling is not applied if 'sampling_percent' is not specified, 0 or 100. When `null`, the `sampling_percent` field will be omitted from the resulting object. + - `exclude_fields` (`list[obj]`): The fields to exclude from data profile. +If specified, the fields will be excluded from data profile, regardless of 'include_fields' value. When `null`, the `exclude_fields` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_profile_spec.exclude_fields.new](#fn-data_profile_specexclude_fieldsnew) constructor. + - `include_fields` (`list[obj]`): The fields to include in data profile. +If not specified, all fields at the time of profile scan job execution are included, except for ones listed in 'exclude_fields'. When `null`, the `include_fields` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_profile_spec.include_fields.new](#fn-data_profile_specinclude_fieldsnew) constructor. + - `post_scan_actions` (`list[obj]`): Actions to take upon job completion. When `null`, the `post_scan_actions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_profile_spec.post_scan_actions.new](#fn-data_profile_specpost_scan_actionsnew) constructor. **Returns**: - An attribute object that represents the `data_profile_spec` sub block. +## obj data_profile_spec.exclude_fields + + + +### fn data_profile_spec.exclude_fields.new + +```ts +new() +``` + + +`google-beta.google_dataplex_datascan.data_profile_spec.exclude_fields.new` constructs a new object with attributes and blocks configured for the `exclude_fields` +Terraform sub block. + + + +**Args**: + - `field_names` (`list`): Expected input is a list of fully qualified names of fields as in the schema. +Only top-level field names for nested fields are supported. +For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. When `null`, the `field_names` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `exclude_fields` sub block. + + +## obj data_profile_spec.include_fields + + + +### fn data_profile_spec.include_fields.new + +```ts +new() +``` + + +`google-beta.google_dataplex_datascan.data_profile_spec.include_fields.new` constructs a new object with attributes and blocks configured for the `include_fields` +Terraform sub block. + + + +**Args**: + - `field_names` (`list`): Expected input is a list of fully qualified names of fields as in the schema. +Only top-level field names for nested fields are supported. +For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. When `null`, the `field_names` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `include_fields` sub block. + + +## obj data_profile_spec.post_scan_actions + + + +### fn data_profile_spec.post_scan_actions.new + +```ts +new() +``` + + +`google-beta.google_dataplex_datascan.data_profile_spec.post_scan_actions.new` constructs a new object with attributes and blocks configured for the `post_scan_actions` +Terraform sub block. + + + +**Args**: + - `bigquery_export` (`list[obj]`): If set, results will be exported to the provided BigQuery table. When `null`, the `bigquery_export` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_profile_spec.post_scan_actions.bigquery_export.new](#fn-data_profile_specdata_profile_specbigquery_exportnew) constructor. + +**Returns**: + - An attribute object that represents the `post_scan_actions` sub block. + + +## obj data_profile_spec.post_scan_actions.bigquery_export + + + +### fn data_profile_spec.post_scan_actions.bigquery_export.new + +```ts +new() +``` + + +`google-beta.google_dataplex_datascan.data_profile_spec.post_scan_actions.bigquery_export.new` constructs a new object with attributes and blocks configured for the `bigquery_export` +Terraform sub block. + + + +**Args**: + - `results_table` (`string`): The BigQuery table to export DataProfileScan results to. +Format://bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID When `null`, the `results_table` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `bigquery_export` sub block. + + ## obj data_quality_spec @@ -492,13 +608,63 @@ Terraform sub block. **Args**: - `row_filter` (`string`): A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 When `null`, the `row_filter` field will be omitted from the resulting object. - - `sampling_percent` (`number`): The percentage of the records to be selected from the dataset for DataScan. When `null`, the `sampling_percent` field will be omitted from the resulting object. + - `sampling_percent` (`number`): The percentage of the records to be selected from the dataset for DataScan. +Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. +Sampling is not applied if 'sampling_percent' is not specified, 0 or 100. When `null`, the `sampling_percent` field will be omitted from the resulting object. + - `post_scan_actions` (`list[obj]`): Actions to take upon job completion. When `null`, the `post_scan_actions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.post_scan_actions.new](#fn-data_quality_specpost_scan_actionsnew) constructor. - `rules` (`list[obj]`): The list of rules to evaluate against a data source. At least one rule is required. When `null`, the `rules` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.new](#fn-data_quality_specrulesnew) constructor. **Returns**: - An attribute object that represents the `data_quality_spec` sub block. +## obj data_quality_spec.post_scan_actions + + + +### fn data_quality_spec.post_scan_actions.new + +```ts +new() +``` + + +`google-beta.google_dataplex_datascan.data_quality_spec.post_scan_actions.new` constructs a new object with attributes and blocks configured for the `post_scan_actions` +Terraform sub block. + + + +**Args**: + - `bigquery_export` (`list[obj]`): If set, results will be exported to the provided BigQuery table. When `null`, the `bigquery_export` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.post_scan_actions.bigquery_export.new](#fn-data_quality_specdata_quality_specbigquery_exportnew) constructor. + +**Returns**: + - An attribute object that represents the `post_scan_actions` sub block. + + +## obj data_quality_spec.post_scan_actions.bigquery_export + + + +### fn data_quality_spec.post_scan_actions.bigquery_export.new + +```ts +new() +``` + + +`google-beta.google_dataplex_datascan.data_quality_spec.post_scan_actions.bigquery_export.new` constructs a new object with attributes and blocks configured for the `bigquery_export` +Terraform sub block. + + + +**Args**: + - `results_table` (`string`): The BigQuery table to export DataQualityScan results to. +Format://bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID When `null`, the `results_table` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `bigquery_export` sub block. + + ## obj data_quality_spec.rules @@ -517,8 +683,15 @@ Terraform sub block. **Args**: - `column` (`string`): The unnested column which this rule is evaluated against. When `null`, the `column` field will be omitted from the resulting object. + - `description` (`string`): Description of the rule. +The maximum length is 1,024 characters. When `null`, the `description` field will be omitted from the resulting object. - `dimension` (`string`): The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"] - `ignore_null` (`bool`): Rows with null values will automatically fail a rule, unless ignoreNull is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules. When `null`, the `ignore_null` field will be omitted from the resulting object. + - `name` (`string`): A mutable name for the rule. +The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). +The maximum length is 63 characters. +Must start with a letter. +Must end with a number or a letter. When `null`, the `name` field will be omitted from the resulting object. - `threshold` (`number`): The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of [0.0, 1.0]. 0 indicates default value (i.e. 1.0). When `null`, the `threshold` field will be omitted from the resulting object. - `non_null_expectation` (`list[obj]`): ColumnMap rule which evaluates whether each column value is null. When `null`, the `non_null_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.non_null_expectation.new](#fn-data_quality_specdata_quality_specnon_null_expectationnew) constructor. - `range_expectation` (`list[obj]`): ColumnMap rule which evaluates whether each column value lies between a specified range. When `null`, the `range_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.range_expectation.new](#fn-data_quality_specdata_quality_specrange_expectationnew) constructor. @@ -527,7 +700,7 @@ Terraform sub block. - `set_expectation` (`list[obj]`): ColumnMap rule which evaluates whether each column value is contained by a specified set. When `null`, the `set_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.set_expectation.new](#fn-data_quality_specdata_quality_specset_expectationnew) constructor. - `statistic_range_expectation` (`list[obj]`): ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range. When `null`, the `statistic_range_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.statistic_range_expectation.new](#fn-data_quality_specdata_quality_specstatistic_range_expectationnew) constructor. - `table_condition_expectation` (`list[obj]`): Table rule which evaluates whether the provided expression is true. When `null`, the `table_condition_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.table_condition_expectation.new](#fn-data_quality_specdata_quality_spectable_condition_expectationnew) constructor. - - `uniqueness_expectation` (`list[obj]`): ColumnAggregate rule which evaluates whether the column has duplicates. When `null`, the `uniqueness_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.uniqueness_expectation.new](#fn-data_quality_specdata_quality_specuniqueness_expectationnew) constructor. + - `uniqueness_expectation` (`list[obj]`): Row-level rule which evaluates whether each column value is unique. When `null`, the `uniqueness_expectation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_dataplex_datascan.data_quality_spec.rules.uniqueness_expectation.new](#fn-data_quality_specdata_quality_specuniqueness_expectationnew) constructor. **Returns**: - An attribute object that represents the `rules` sub block. diff --git a/docs/4.x/google_firebase_android_app.md b/docs/4.x/google_firebase_android_app.md index ef309c8..c00daaf 100644 --- a/docs/4.x/google_firebase_android_app.md +++ b/docs/4.x/google_firebase_android_app.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withApiKeyId()`](#fn-withapikeyid) * [`fn withDeletionPolicy()`](#fn-withdeletionpolicy) * [`fn withDisplayName()`](#fn-withdisplayname) * [`fn withPackageName()`](#fn-withpackagename) @@ -55,6 +56,9 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. + - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the AndroidApp. +If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the AndroidApp. +This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object. - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the AndroidApp to be untracked from terraform state rather than deleted upon 'terraform destroy'. This is useful because the AndroidApp may be serving traffic. Set to 'DELETE' to delete the AndroidApp. Defaults to 'DELETE'. When `null`, the `deletion_policy` field will be omitted from the resulting object. @@ -88,6 +92,9 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: + - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the AndroidApp. +If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the AndroidApp. +This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object. - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the AndroidApp to be untracked from terraform state rather than deleted upon 'terraform destroy'. This is useful because the AndroidApp may be serving traffic. Set to 'DELETE' to delete the AndroidApp. Defaults to 'DELETE'. When `null`, the `deletion_policy` field will be omitted from the resulting object. @@ -103,6 +110,22 @@ Developer Console. When `null`, the `package_name` field will be omitted from th - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_firebase_android_app` resource into the root Terraform configuration. +### fn withApiKeyId + +```ts +withApiKeyId() +``` + +`google-beta.string.withApiKeyId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the api_key_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `api_key_id` field. + + ### fn withDeletionPolicy ```ts diff --git a/docs/4.x/google_firebase_apple_app.md b/docs/4.x/google_firebase_apple_app.md index 14de115..640eff1 100644 --- a/docs/4.x/google_firebase_apple_app.md +++ b/docs/4.x/google_firebase_apple_app.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withApiKeyId()`](#fn-withapikeyid) * [`fn withAppStoreId()`](#fn-withappstoreid) * [`fn withBundleId()`](#fn-withbundleid) * [`fn withDeletionPolicy()`](#fn-withdeletionpolicy) @@ -55,6 +56,9 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. + - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the AppleApp. +If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the AppleApp. +This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object. - `app_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object. - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore. - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the Apple to be untracked from terraform state @@ -87,6 +91,9 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: + - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the AppleApp. +If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the AppleApp. +This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object. - `app_store_id` (`string`): The automatically generated Apple ID assigned to the Apple app by Apple in the Apple App Store. When `null`, the `app_store_id` field will be omitted from the resulting object. - `bundle_id` (`string`): The canonical bundle ID of the Apple app as it would appear in the Apple AppStore. - `deletion_policy` (`string`): (Optional) Set to 'ABANDON' to allow the Apple to be untracked from terraform state @@ -101,6 +108,22 @@ serving traffic. Set to 'DELETE' to delete the Apple. Defaults to 'D - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_firebase_apple_app` resource into the root Terraform configuration. +### fn withApiKeyId + +```ts +withApiKeyId() +``` + +`google-beta.string.withApiKeyId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the api_key_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `api_key_id` field. + + ### fn withAppStoreId ```ts diff --git a/docs/4.x/google_firebase_web_app.md b/docs/4.x/google_firebase_web_app.md index 33262ca..bc08e73 100644 --- a/docs/4.x/google_firebase_web_app.md +++ b/docs/4.x/google_firebase_web_app.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withApiKeyId()`](#fn-withapikeyid) * [`fn withDeletionPolicy()`](#fn-withdeletionpolicy) * [`fn withDisplayName()`](#fn-withdisplayname) * [`fn withProject()`](#fn-withproject) @@ -52,6 +53,9 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. + - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. +If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the WebApp. +This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object. - `deletion_policy` (`string`): Set to 'ABANDON' to allow the WebApp to be untracked from terraform state rather than deleted upon 'terraform destroy'. This is useful becaue the WebApp may be serving traffic. Set to 'DELETE' to delete the WebApp. Default to 'ABANDON' When `null`, the `deletion_policy` field will be omitted from the resulting object. @@ -81,6 +85,9 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: + - `api_key_id` (`string`): The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. +If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the WebApp. +This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. When `null`, the `api_key_id` field will be omitted from the resulting object. - `deletion_policy` (`string`): Set to 'ABANDON' to allow the WebApp to be untracked from terraform state rather than deleted upon 'terraform destroy'. This is useful becaue the WebApp may be serving traffic. Set to 'DELETE' to delete the WebApp. Default to 'ABANDON' When `null`, the `deletion_policy` field will be omitted from the resulting object. @@ -92,6 +99,22 @@ serving traffic. Set to 'DELETE' to delete the WebApp. Default to 'A - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_firebase_web_app` resource into the root Terraform configuration. +### fn withApiKeyId + +```ts +withApiKeyId() +``` + +`google-beta.string.withApiKeyId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the api_key_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `api_key_id` field. + + ### fn withDeletionPolicy ```ts diff --git a/docs/4.x/google_gke_hub_membership_rbac_role_binding.md b/docs/4.x/google_gke_hub_membership_rbac_role_binding.md new file mode 100644 index 0000000..a8b58f8 --- /dev/null +++ b/docs/4.x/google_gke_hub_membership_rbac_role_binding.md @@ -0,0 +1,306 @@ +--- +permalink: /google_gke_hub_membership_rbac_role_binding/ +--- + +# google_gke_hub_membership_rbac_role_binding + +`google_gke_hub_membership_rbac_role_binding` represents the `google-beta_google_gke_hub_membership_rbac_role_binding` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withMembershipId()`](#fn-withmembershipid) +* [`fn withMembershipRbacRoleBindingId()`](#fn-withmembershiprbacrolebindingid) +* [`fn withProject()`](#fn-withproject) +* [`fn withRole()`](#fn-withrole) +* [`fn withRoleMixin()`](#fn-withrolemixin) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withUser()`](#fn-withuser) +* [`obj role`](#obj-role) + * [`fn new()`](#fn-rolenew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google-beta.google_gke_hub_membership_rbac_role_binding.new` injects a new `google-beta_google_gke_hub_membership_rbac_role_binding` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + google-beta.google_gke_hub_membership_rbac_role_binding.new('some_id') + +You can get the reference to the `id` field of the created `google-beta.google_gke_hub_membership_rbac_role_binding` using the reference: + + $._ref.google-beta_google_gke_hub_membership_rbac_role_binding.some_id.get('id') + +This is the same as directly entering `"${ google-beta_google_gke_hub_membership_rbac_role_binding.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `location` (`string`): Location of the Membership + - `membership_id` (`string`): Id of the membership + - `membership_rbac_role_binding_id` (`string`): The client-provided identifier of the RBAC Role Binding. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `user` (`string`): Principal that is be authorized in the cluster (at least of one the oneof +is required). Updating one will unset the other automatically. +user is the name of the user as seen by the kubernetes cluster, example +"alice" or "alice@domain.tld" + - `role` (`list[obj]`): Role to bind to the principal. When `null`, the `role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gke_hub_membership_rbac_role_binding.role.new](#fn-rolenew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gke_hub_membership_rbac_role_binding.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google-beta.google_gke_hub_membership_rbac_role_binding.newAttrs` constructs a new object with attributes and blocks configured for the `google_gke_hub_membership_rbac_role_binding` +Terraform resource. + +Unlike [google-beta.google_gke_hub_membership_rbac_role_binding.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `location` (`string`): Location of the Membership + - `membership_id` (`string`): Id of the membership + - `membership_rbac_role_binding_id` (`string`): The client-provided identifier of the RBAC Role Binding. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `user` (`string`): Principal that is be authorized in the cluster (at least of one the oneof +is required). Updating one will unset the other automatically. +user is the name of the user as seen by the kubernetes cluster, example +"alice" or "alice@domain.tld" + - `role` (`list[obj]`): Role to bind to the principal. When `null`, the `role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gke_hub_membership_rbac_role_binding.role.new](#fn-rolenew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google-beta.google_gke_hub_membership_rbac_role_binding.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `google_gke_hub_membership_rbac_role_binding` resource into the root Terraform configuration. + + +### fn withLocation + +```ts +withLocation() +``` + +`google-beta.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withMembershipId + +```ts +withMembershipId() +``` + +`google-beta.string.withMembershipId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the membership_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `membership_id` field. + + +### fn withMembershipRbacRoleBindingId + +```ts +withMembershipRbacRoleBindingId() +``` + +`google-beta.string.withMembershipRbacRoleBindingId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the membership_rbac_role_binding_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `membership_rbac_role_binding_id` field. + + +### fn withProject + +```ts +withProject() +``` + +`google-beta.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withRole + +```ts +withRole() +``` + +`google-beta.list[obj].withRole` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the role field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [google-beta.list[obj].withRoleMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `role` field. + + +### fn withRoleMixin + +```ts +withRoleMixin() +``` + +`google-beta.list[obj].withRoleMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the role field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [google-beta.list[obj].withRole](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `role` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google-beta.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google-beta.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google-beta.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google-beta.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withUser + +```ts +withUser() +``` + +`google-beta.string.withUser` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the user field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `user` field. + + +## obj role + + + +### fn role.new + +```ts +new() +``` + + +`google-beta.google_gke_hub_membership_rbac_role_binding.role.new` constructs a new object with attributes and blocks configured for the `role` +Terraform sub block. + + + +**Args**: + - `predefined_role` (`string`): PredefinedRole is an ENUM representation of the default Kubernetes Roles Possible values: ["UNKNOWN", "ADMIN", "EDIT", "VIEW", "ANTHOS_SUPPORT"] + +**Returns**: + - An attribute object that represents the `role` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google-beta.google_gke_hub_membership_rbac_role_binding.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/4.x/google_project_access_approval_settings.md b/docs/4.x/google_project_access_approval_settings.md index 2b29eb9..2110e64 100644 --- a/docs/4.x/google_project_access_approval_settings.md +++ b/docs/4.x/google_project_access_approval_settings.md @@ -63,7 +63,7 @@ This property will be ignored if set by an ancestor of the resource, and new non - `notification_emails` (`list`): A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. When `null`, the `notification_emails` field will be omitted from the resulting object. - - `project` (`string`): Deprecated in favor of 'project_id' When `null`, the `project` field will be omitted from the resulting object. + - `project` (`string`): Project id. When `null`, the `project` field will be omitted from the resulting object. - `project_id` (`string`): ID of the project of the access approval settings. - `enrolled_services` (`list[obj]`): A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required @@ -100,7 +100,7 @@ This property will be ignored if set by an ancestor of the resource, and new non - `notification_emails` (`list`): A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. When `null`, the `notification_emails` field will be omitted from the resulting object. - - `project` (`string`): Deprecated in favor of 'project_id' When `null`, the `project` field will be omitted from the resulting object. + - `project` (`string`): Project id. When `null`, the `project` field will be omitted from the resulting object. - `project_id` (`string`): ID of the project of the access approval settings. - `enrolled_services` (`list[obj]`): A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required diff --git a/docs/4.x/google_sql_database_instance.md b/docs/4.x/google_sql_database_instance.md index a14506b..ddfed33 100644 --- a/docs/4.x/google_sql_database_instance.md +++ b/docs/4.x/google_sql_database_instance.md @@ -63,6 +63,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-settingsip_configurationnew) * [`obj settings.ip_configuration.authorized_networks`](#obj-settingsip_configurationauthorized_networks) * [`fn new()`](#fn-settingsip_configurationauthorized_networksnew) + * [`obj settings.ip_configuration.psc_config`](#obj-settingsip_configurationpsc_config) + * [`fn new()`](#fn-settingsip_configurationpsc_confignew) * [`obj settings.location_preference`](#obj-settingslocation_preference) * [`fn new()`](#fn-settingslocation_preferencenew) * [`obj settings.maintenance_window`](#obj-settingsmaintenance_window) @@ -863,6 +865,7 @@ Terraform sub block. - `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. - `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-beta.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-beta.google_sql_database_instance.settings.ip_configuration.psc_config.new](#fn-settingssettingspsc_confignew) constructor. **Returns**: - An attribute object that represents the `ip_configuration` sub block. @@ -893,6 +896,30 @@ Terraform sub block. - An attribute object that represents the `authorized_networks` sub block. +## obj settings.ip_configuration.psc_config + + + +### fn settings.ip_configuration.psc_config.new + +```ts +new() +``` + + +`google-beta.google_sql_database_instance.settings.ip_configuration.psc_config.new` constructs a new object with attributes and blocks configured for the `psc_config` +Terraform sub block. + + + +**Args**: + - `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. + - `psc_enabled` (`bool`): Whether PSC connectivity is enabled for this instance. When `null`, the `psc_enabled` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `psc_config` sub block. + + ## obj settings.location_preference diff --git a/docs/4.x/google_workstations_workstation_config.md b/docs/4.x/google_workstations_workstation_config.md index f86daa2..571c6d0 100644 --- a/docs/4.x/google_workstations_workstation_config.md +++ b/docs/4.x/google_workstations_workstation_config.md @@ -575,6 +575,9 @@ Terraform sub block. **Args**: - `boot_disk_size_gb` (`number`): Size of the boot disk in GB. When `null`, the `boot_disk_size_gb` field will be omitted from the resulting object. - `disable_public_ip_addresses` (`bool`): Whether instances have no public IP address. When `null`, the `disable_public_ip_addresses` field will be omitted from the resulting object. + - `enable_nested_virtualization` (`bool`): Whether to enable nested virtualization on the Compute Engine VMs backing the Workstations. + +See https://cloud.google.com/workstations/docs/reference/rest/v1beta/projects.locations.workstationClusters.workstationConfigs#GceInstance.FIELDS.enable_nested_virtualization When `null`, the `enable_nested_virtualization` field will be omitted from the resulting object. - `machine_type` (`string`): The name of a Compute Engine machine type. When `null`, the `machine_type` field will be omitted from the resulting object. - `pool_size` (`number`): Number of instances to pool for faster workstation startup. When `null`, the `pool_size` field will be omitted from the resulting object. - `service_account` (`string`): Email address of the service account that will be used on VM instances used to support this config. This service account must have permission to pull the specified container image. If not set, VMs will run without a service account, in which case the image must be publicly accessible. When `null`, the `service_account` field will be omitted from the resulting object.