From 4c775a1f3941f9e603eae5b1b4388bac2aea2b18 Mon Sep 17 00:00:00 2001 From: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> Date: Tue, 14 Mar 2023 11:17:21 -0500 Subject: [PATCH] Update dependency hashicorp/terraform-provider-google to v4.57.0 (#24) Signed-off-by: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> Co-authored-by: renovate[bot] --- 4.x/_gen/main.libsonnet | 5 + ...ext_manager_authorized_orgs_desc.libsonnet | 140 ++++++++ .../resources/apigee_env_keystore.libsonnet | 78 +++++ .../resources/apigee_env_references.libsonnet | 124 +++++++ .../bigquery_capacity_commitment.libsonnet | 154 +++++++++ .../resources/firestore_database.libsonnet | 140 ++++++++ docs/4.x/README.md | 5 + ...ss_context_manager_authorized_orgs_desc.md | 302 ++++++++++++++++++ docs/4.x/apigee_env_keystore.md | 179 +++++++++++ docs/4.x/apigee_env_references.md | 236 ++++++++++++++ docs/4.x/bigquery_capacity_commitment.md | 281 ++++++++++++++++ docs/4.x/firestore_database.md | 270 ++++++++++++++++ 12 files changed, 1914 insertions(+) create mode 100644 4.x/_gen/resources/access_context_manager_authorized_orgs_desc.libsonnet create mode 100644 4.x/_gen/resources/apigee_env_keystore.libsonnet create mode 100644 4.x/_gen/resources/apigee_env_references.libsonnet create mode 100644 4.x/_gen/resources/bigquery_capacity_commitment.libsonnet create mode 100644 4.x/_gen/resources/firestore_database.libsonnet create mode 100644 docs/4.x/access_context_manager_authorized_orgs_desc.md create mode 100644 docs/4.x/apigee_env_keystore.md create mode 100644 docs/4.x/apigee_env_references.md create mode 100644 docs/4.x/bigquery_capacity_commitment.md create mode 100644 docs/4.x/firestore_database.md diff --git a/4.x/_gen/main.libsonnet b/4.x/_gen/main.libsonnet index 7fb5d89..375d12b 100644 --- a/4.x/_gen/main.libsonnet +++ b/4.x/_gen/main.libsonnet @@ -9,6 +9,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); access_context_manager_access_policy_iam_binding: (import 'resources/access_context_manager_access_policy_iam_binding.libsonnet'), access_context_manager_access_policy_iam_member: (import 'resources/access_context_manager_access_policy_iam_member.libsonnet'), access_context_manager_access_policy_iam_policy: (import 'resources/access_context_manager_access_policy_iam_policy.libsonnet'), + access_context_manager_authorized_orgs_desc: (import 'resources/access_context_manager_authorized_orgs_desc.libsonnet'), access_context_manager_gcp_user_access_binding: (import 'resources/access_context_manager_gcp_user_access_binding.libsonnet'), access_context_manager_service_perimeter: (import 'resources/access_context_manager_service_perimeter.libsonnet'), access_context_manager_service_perimeter_resource: (import 'resources/access_context_manager_service_perimeter_resource.libsonnet'), @@ -20,6 +21,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); alloydb_instance: (import 'resources/alloydb_instance.libsonnet'), apigee_addons_config: (import 'resources/apigee_addons_config.libsonnet'), apigee_endpoint_attachment: (import 'resources/apigee_endpoint_attachment.libsonnet'), + apigee_env_keystore: (import 'resources/apigee_env_keystore.libsonnet'), + apigee_env_references: (import 'resources/apigee_env_references.libsonnet'), apigee_envgroup: (import 'resources/apigee_envgroup.libsonnet'), apigee_envgroup_attachment: (import 'resources/apigee_envgroup_attachment.libsonnet'), apigee_environment: (import 'resources/apigee_environment.libsonnet'), @@ -56,6 +59,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_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'), bigquery_connection_iam_member: (import 'resources/bigquery_connection_iam_member.libsonnet'), @@ -346,6 +350,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); filestore_snapshot: (import 'resources/filestore_snapshot.libsonnet'), firebaserules_release: (import 'resources/firebaserules_release.libsonnet'), firebaserules_ruleset: (import 'resources/firebaserules_ruleset.libsonnet'), + firestore_database: (import 'resources/firestore_database.libsonnet'), firestore_document: (import 'resources/firestore_document.libsonnet'), firestore_index: (import 'resources/firestore_index.libsonnet'), folder: (import 'resources/folder.libsonnet'), diff --git a/4.x/_gen/resources/access_context_manager_authorized_orgs_desc.libsonnet b/4.x/_gen/resources/access_context_manager_authorized_orgs_desc.libsonnet new file mode 100644 index 0000000..2c0344a --- /dev/null +++ b/4.x/_gen/resources/access_context_manager_authorized_orgs_desc.libsonnet @@ -0,0 +1,140 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='access_context_manager_authorized_orgs_desc', url='', help='`access_context_manager_authorized_orgs_desc` represents the `google_access_context_manager_authorized_orgs_desc` 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.access_context_manager_authorized_orgs_desc.new` injects a new `google_access_context_manager_authorized_orgs_desc` 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.access_context_manager_authorized_orgs_desc.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.access_context_manager_authorized_orgs_desc` using the reference:\n\n $._ref.google_access_context_manager_authorized_orgs_desc.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_access_context_manager_authorized_orgs_desc.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `asset_type` (`string`): The type of entities that need to use the authorization relationship during\nevaluation, such as a device. Valid values are \u0026#34;ASSET_TYPE_DEVICE\u0026#34; and\n\u0026#34;ASSET_TYPE_CREDENTIAL_STRENGTH\u0026#34;. Possible values: [\u0026#34;ASSET_TYPE_DEVICE\u0026#34;, \u0026#34;ASSET_TYPE_CREDENTIAL_STRENGTH\u0026#34;] When `null`, the `asset_type` field will be omitted from the resulting object.\n - `authorization_direction` (`string`): The direction of the authorization relationship between this organization\nand the organizations listed in the \u0026#34;orgs\u0026#34; field. The valid values for this\nfield include the following:\n\nAUTHORIZATION_DIRECTION_FROM: Allows this organization to evaluate traffic\nin the organizations listed in the \u0026#39;orgs\u0026#39; field.\n\nAUTHORIZATION_DIRECTION_TO: Allows the organizations listed in the \u0026#39;orgs\u0026#39;\nfield to evaluate the traffic in this organization.\n\nFor the authorization relationship to take effect, all of the organizations\nmust authorize and specify the appropriate relationship direction. For\nexample, if organization A authorized organization B and C to evaluate its\ntraffic, by specifying \u0026#34;AUTHORIZATION_DIRECTION_TO\u0026#34; as the authorization\ndirection, organizations B and C must specify\n\u0026#34;AUTHORIZATION_DIRECTION_FROM\u0026#34; as the authorization direction in their\n\u0026#34;AuthorizedOrgsDesc\u0026#34; resource. Possible values: [\u0026#34;AUTHORIZATION_DIRECTION_TO\u0026#34;, \u0026#34;AUTHORIZATION_DIRECTION_FROM\u0026#34;] When `null`, the `authorization_direction` field will be omitted from the resulting object.\n - `authorization_type` (`string`): A granular control type for authorization levels. Valid value is \u0026#34;AUTHORIZATION_TYPE_TRUST\u0026#34;. Possible values: [\u0026#34;AUTHORIZATION_TYPE_TRUST\u0026#34;] When `null`, the `authorization_type` field will be omitted from the resulting object.\n - `name` (`string`): Resource name for the \u0026#39;AuthorizedOrgsDesc\u0026#39;. Format:\n\u0026#39;accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}\u0026#39;.\nThe \u0026#39;authorized_orgs_desc\u0026#39; component must begin with a letter, followed by\nalphanumeric characters or \u0026#39;_\u0026#39;.\nAfter you create an \u0026#39;AuthorizedOrgsDesc\u0026#39;, you cannot change its \u0026#39;name\u0026#39;.\n - `orgs` (`list`): The list of organization ids in this AuthorizedOrgsDesc.\nFormat: \u0026#39;organizations/\u0026lt;org_number\u0026gt;\u0026#39;\nExample: \u0026#39;organizations/123456\u0026#39; When `null`, the `orgs` field will be omitted from the resulting object.\n - `parent` (`string`): Required. Resource name for the access policy which owns this \u0026#39;AuthorizedOrgsDesc\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.access_context_manager_authorized_orgs_desc.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + name, + parent, + asset_type=null, + authorization_direction=null, + authorization_type=null, + orgs=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_access_context_manager_authorized_orgs_desc', + label=resourceLabel, + attrs=self.newAttrs( + asset_type=asset_type, + authorization_direction=authorization_direction, + authorization_type=authorization_type, + name=name, + orgs=orgs, + parent=parent, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.access_context_manager_authorized_orgs_desc.newAttrs` constructs a new object with attributes and blocks configured for the `access_context_manager_authorized_orgs_desc`\nTerraform resource.\n\nUnlike [google.access_context_manager_authorized_orgs_desc.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `asset_type` (`string`): The type of entities that need to use the authorization relationship during\nevaluation, such as a device. Valid values are "ASSET_TYPE_DEVICE" and\n"ASSET_TYPE_CREDENTIAL_STRENGTH". Possible values: ["ASSET_TYPE_DEVICE", "ASSET_TYPE_CREDENTIAL_STRENGTH"] When `null`, the `asset_type` field will be omitted from the resulting object.\n - `authorization_direction` (`string`): The direction of the authorization relationship between this organization\nand the organizations listed in the "orgs" field. The valid values for this\nfield include the following:\n\nAUTHORIZATION_DIRECTION_FROM: Allows this organization to evaluate traffic\nin the organizations listed in the 'orgs' field.\n\nAUTHORIZATION_DIRECTION_TO: Allows the organizations listed in the 'orgs'\nfield to evaluate the traffic in this organization.\n\nFor the authorization relationship to take effect, all of the organizations\nmust authorize and specify the appropriate relationship direction. For\nexample, if organization A authorized organization B and C to evaluate its\ntraffic, by specifying "AUTHORIZATION_DIRECTION_TO" as the authorization\ndirection, organizations B and C must specify\n"AUTHORIZATION_DIRECTION_FROM" as the authorization direction in their\n"AuthorizedOrgsDesc" resource. Possible values: ["AUTHORIZATION_DIRECTION_TO", "AUTHORIZATION_DIRECTION_FROM"] When `null`, the `authorization_direction` field will be omitted from the resulting object.\n - `authorization_type` (`string`): A granular control type for authorization levels. Valid value is "AUTHORIZATION_TYPE_TRUST". Possible values: ["AUTHORIZATION_TYPE_TRUST"] When `null`, the `authorization_type` field will be omitted from the resulting object.\n - `name` (`string`): Resource name for the 'AuthorizedOrgsDesc'. Format:\n'accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}'.\nThe 'authorized_orgs_desc' component must begin with a letter, followed by\nalphanumeric characters or '_'.\nAfter you create an 'AuthorizedOrgsDesc', you cannot change its 'name'.\n - `orgs` (`list`): The list of organization ids in this AuthorizedOrgsDesc.\nFormat: 'organizations/<org_number>'\nExample: 'organizations/123456' When `null`, the `orgs` field will be omitted from the resulting object.\n - `parent` (`string`): Required. Resource name for the access policy which owns this 'AuthorizedOrgsDesc'.\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.access_context_manager_authorized_orgs_desc.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 `access_context_manager_authorized_orgs_desc` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + name, + parent, + asset_type=null, + authorization_direction=null, + authorization_type=null, + orgs=null, + timeouts=null + ):: std.prune(a={ + asset_type: asset_type, + authorization_direction: authorization_direction, + authorization_type: authorization_type, + name: name, + orgs: orgs, + parent: parent, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.access_context_manager_authorized_orgs_desc.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, + }), + }, + '#withAssetType':: d.fn(help='`google.string.withAssetType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the asset_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `asset_type` field.\n', args=[]), + withAssetType(resourceLabel, value): { + resource+: { + google_access_context_manager_authorized_orgs_desc+: { + [resourceLabel]+: { + asset_type: value, + }, + }, + }, + }, + '#withAuthorizationDirection':: d.fn(help='`google.string.withAuthorizationDirection` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the authorization_direction field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `authorization_direction` field.\n', args=[]), + withAuthorizationDirection(resourceLabel, value): { + resource+: { + google_access_context_manager_authorized_orgs_desc+: { + [resourceLabel]+: { + authorization_direction: value, + }, + }, + }, + }, + '#withAuthorizationType':: d.fn(help='`google.string.withAuthorizationType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the authorization_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `authorization_type` field.\n', args=[]), + withAuthorizationType(resourceLabel, value): { + resource+: { + google_access_context_manager_authorized_orgs_desc+: { + [resourceLabel]+: { + authorization_type: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_access_context_manager_authorized_orgs_desc+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withOrgs':: d.fn(help='`google.list.withOrgs` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the orgs field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `orgs` field.\n', args=[]), + withOrgs(resourceLabel, value): { + resource+: { + google_access_context_manager_authorized_orgs_desc+: { + [resourceLabel]+: { + orgs: value, + }, + }, + }, + }, + '#withParent':: d.fn(help='`google.string.withParent` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the parent field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `parent` field.\n', args=[]), + withParent(resourceLabel, value): { + resource+: { + google_access_context_manager_authorized_orgs_desc+: { + [resourceLabel]+: { + parent: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_access_context_manager_authorized_orgs_desc+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_access_context_manager_authorized_orgs_desc+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/apigee_env_keystore.libsonnet b/4.x/_gen/resources/apigee_env_keystore.libsonnet new file mode 100644 index 0000000..a3651cc --- /dev/null +++ b/4.x/_gen/resources/apigee_env_keystore.libsonnet @@ -0,0 +1,78 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='apigee_env_keystore', url='', help='`apigee_env_keystore` represents the `google_apigee_env_keystore` 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.apigee_env_keystore.new` injects a new `google_apigee_env_keystore` 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.apigee_env_keystore.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.apigee_env_keystore` using the reference:\n\n $._ref.google_apigee_env_keystore.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_apigee_env_keystore.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 - `env_id` (`string`): The Apigee environment group associated with the Apigee environment,\nin the format \u0026#39;organizations/{{org_name}}/environments/{{env_name}}\u0026#39;.\n - `name` (`string`): The name of the newly created keystore. When `null`, the `name` 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.apigee_env_keystore.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, + env_id, + name=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_apigee_env_keystore', + label=resourceLabel, + attrs=self.newAttrs(env_id=env_id, name=name, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.apigee_env_keystore.newAttrs` constructs a new object with attributes and blocks configured for the `apigee_env_keystore`\nTerraform resource.\n\nUnlike [google.apigee_env_keystore.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 - `env_id` (`string`): The Apigee environment group associated with the Apigee environment,\nin the format 'organizations/{{org_name}}/environments/{{env_name}}'.\n - `name` (`string`): The name of the newly created keystore. When `null`, the `name` 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.apigee_env_keystore.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 `apigee_env_keystore` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + env_id, + name=null, + timeouts=null + ):: std.prune(a={ + env_id: env_id, + name: name, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.apigee_env_keystore.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, + }), + }, + '#withEnvId':: d.fn(help='`google.string.withEnvId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the env_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 `env_id` field.\n', args=[]), + withEnvId(resourceLabel, value): { + resource+: { + google_apigee_env_keystore+: { + [resourceLabel]+: { + env_id: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_apigee_env_keystore+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_apigee_env_keystore+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_apigee_env_keystore+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/apigee_env_references.libsonnet b/4.x/_gen/resources/apigee_env_references.libsonnet new file mode 100644 index 0000000..c23500f --- /dev/null +++ b/4.x/_gen/resources/apigee_env_references.libsonnet @@ -0,0 +1,124 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='apigee_env_references', url='', help='`apigee_env_references` represents the `google_apigee_env_references` 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.apigee_env_references.new` injects a new `google_apigee_env_references` 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.apigee_env_references.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.apigee_env_references` using the reference:\n\n $._ref.google_apigee_env_references.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_apigee_env_references.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`): Optional. A human-readable description of this reference. When `null`, the `description` field will be omitted from the resulting object.\n - `env_id` (`string`): The Apigee environment group associated with the Apigee environment,\nin the format \u0026#39;organizations/{{org_name}}/environments/{{env_name}}\u0026#39;.\n - `name` (`string`): Required. The resource id of this reference. Values must match the regular expression [\\w\\s-.]\u0026#43;.\n - `refers` (`string`): Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.\n - `resource_type` (`string`): The type of resource referred to by this reference. Valid values are \u0026#39;KeyStore\u0026#39; or \u0026#39;TrustStore\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.apigee_env_references.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, + env_id, + name, + refers, + resource_type, + description=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_apigee_env_references', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + env_id=env_id, + name=name, + refers=refers, + resource_type=resource_type, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.apigee_env_references.newAttrs` constructs a new object with attributes and blocks configured for the `apigee_env_references`\nTerraform resource.\n\nUnlike [google.apigee_env_references.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`): Optional. A human-readable description of this reference. When `null`, the `description` field will be omitted from the resulting object.\n - `env_id` (`string`): The Apigee environment group associated with the Apigee environment,\nin the format 'organizations/{{org_name}}/environments/{{env_name}}'.\n - `name` (`string`): Required. The resource id of this reference. Values must match the regular expression [\\w\\s-.]+.\n - `refers` (`string`): Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType.\n - `resource_type` (`string`): The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.\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.apigee_env_references.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 `apigee_env_references` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + env_id, + name, + refers, + resource_type, + description=null, + timeouts=null + ):: std.prune(a={ + description: description, + env_id: env_id, + name: name, + refers: refers, + resource_type: resource_type, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.apigee_env_references.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, + '#withDescription':: d.fn(help='`google.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + google_apigee_env_references+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withEnvId':: d.fn(help='`google.string.withEnvId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the env_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 `env_id` field.\n', args=[]), + withEnvId(resourceLabel, value): { + resource+: { + google_apigee_env_references+: { + [resourceLabel]+: { + env_id: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_apigee_env_references+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withRefers':: d.fn(help='`google.string.withRefers` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the refers 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 `refers` field.\n', args=[]), + withRefers(resourceLabel, value): { + resource+: { + google_apigee_env_references+: { + [resourceLabel]+: { + refers: value, + }, + }, + }, + }, + '#withResourceType':: d.fn(help='`google.string.withResourceType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the resource_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `resource_type` field.\n', args=[]), + withResourceType(resourceLabel, value): { + resource+: { + google_apigee_env_references+: { + [resourceLabel]+: { + resource_type: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_apigee_env_references+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_apigee_env_references+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/bigquery_capacity_commitment.libsonnet b/4.x/_gen/resources/bigquery_capacity_commitment.libsonnet new file mode 100644 index 0000000..2c7cc60 --- /dev/null +++ b/4.x/_gen/resources/bigquery_capacity_commitment.libsonnet @@ -0,0 +1,154 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='bigquery_capacity_commitment', url='', help='`bigquery_capacity_commitment` represents the `google_bigquery_capacity_commitment` 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.bigquery_capacity_commitment.new` injects a new `google_bigquery_capacity_commitment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.bigquery_capacity_commitment.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.bigquery_capacity_commitment` using the reference:\n\n $._ref.google_bigquery_capacity_commitment.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_bigquery_capacity_commitment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `capacity_commitment_id` (`string`): The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is\nempty. This field must only contain lower case alphanumeric characters or dashes. The first and last character\ncannot be a dash. Max length is 64 characters. NOTE: this ID won\u0026#39;t be kept if the capacity commitment is split\nor merged. When `null`, the `capacity_commitment_id` field will be omitted from the resulting object.\n - `enforce_single_admin_project_per_org` (`string`): If true, fail the request if another project in the organization has a capacity commitment. When `null`, the `enforce_single_admin_project_per_org` field will be omitted from the resulting object.\n - `location` (`string`): The geographic location where the transfer config should reside.\nExamples: US, EU, asia-northeast1. The default value is US. When `null`, the `location` field will be omitted from the resulting object.\n - `plan` (`string`): Capacity commitment plan. Valid values are FLEX, TRIAL, MONTHLY, ANNUAL\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 - `renewal_plan` (`string`): The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. When `null`, the `renewal_plan` field will be omitted from the resulting object.\n - `slot_count` (`number`): Number of slots in this commitment.\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.bigquery_capacity_commitment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + plan, + slot_count, + capacity_commitment_id=null, + enforce_single_admin_project_per_org=null, + location=null, + project=null, + renewal_plan=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_bigquery_capacity_commitment', + label=resourceLabel, + attrs=self.newAttrs( + capacity_commitment_id=capacity_commitment_id, + enforce_single_admin_project_per_org=enforce_single_admin_project_per_org, + location=location, + plan=plan, + project=project, + renewal_plan=renewal_plan, + slot_count=slot_count, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.bigquery_capacity_commitment.newAttrs` constructs a new object with attributes and blocks configured for the `bigquery_capacity_commitment`\nTerraform resource.\n\nUnlike [google.bigquery_capacity_commitment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `capacity_commitment_id` (`string`): The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is\nempty. This field must only contain lower case alphanumeric characters or dashes. The first and last character\ncannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split\nor merged. When `null`, the `capacity_commitment_id` field will be omitted from the resulting object.\n - `enforce_single_admin_project_per_org` (`string`): If true, fail the request if another project in the organization has a capacity commitment. When `null`, the `enforce_single_admin_project_per_org` field will be omitted from the resulting object.\n - `location` (`string`): The geographic location where the transfer config should reside.\nExamples: US, EU, asia-northeast1. The default value is US. When `null`, the `location` field will be omitted from the resulting object.\n - `plan` (`string`): Capacity commitment plan. Valid values are FLEX, TRIAL, MONTHLY, ANNUAL\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `renewal_plan` (`string`): The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. When `null`, the `renewal_plan` field will be omitted from the resulting object.\n - `slot_count` (`number`): Number of slots in this commitment.\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.bigquery_capacity_commitment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `bigquery_capacity_commitment` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + plan, + slot_count, + capacity_commitment_id=null, + enforce_single_admin_project_per_org=null, + location=null, + project=null, + renewal_plan=null, + timeouts=null + ):: std.prune(a={ + capacity_commitment_id: capacity_commitment_id, + enforce_single_admin_project_per_org: enforce_single_admin_project_per_org, + location: location, + plan: plan, + project: project, + renewal_plan: renewal_plan, + slot_count: slot_count, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.bigquery_capacity_commitment.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, + }), + }, + '#withCapacityCommitmentId':: d.fn(help='`google.string.withCapacityCommitmentId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the capacity_commitment_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 `capacity_commitment_id` field.\n', args=[]), + withCapacityCommitmentId(resourceLabel, value): { + resource+: { + google_bigquery_capacity_commitment+: { + [resourceLabel]+: { + capacity_commitment_id: value, + }, + }, + }, + }, + '#withEnforceSingleAdminProjectPerOrg':: d.fn(help='`google.string.withEnforceSingleAdminProjectPerOrg` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the enforce_single_admin_project_per_org 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 `enforce_single_admin_project_per_org` field.\n', args=[]), + withEnforceSingleAdminProjectPerOrg(resourceLabel, value): { + resource+: { + google_bigquery_capacity_commitment+: { + [resourceLabel]+: { + enforce_single_admin_project_per_org: value, + }, + }, + }, + }, + '#withLocation':: d.fn(help='`google.string.withLocation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `location` field.\n', args=[]), + withLocation(resourceLabel, value): { + resource+: { + google_bigquery_capacity_commitment+: { + [resourceLabel]+: { + location: value, + }, + }, + }, + }, + '#withPlan':: d.fn(help='`google.string.withPlan` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the plan field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `plan` field.\n', args=[]), + withPlan(resourceLabel, value): { + resource+: { + google_bigquery_capacity_commitment+: { + [resourceLabel]+: { + plan: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_bigquery_capacity_commitment+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withRenewalPlan':: d.fn(help='`google.string.withRenewalPlan` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the renewal_plan field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `renewal_plan` field.\n', args=[]), + withRenewalPlan(resourceLabel, value): { + resource+: { + google_bigquery_capacity_commitment+: { + [resourceLabel]+: { + renewal_plan: value, + }, + }, + }, + }, + '#withSlotCount':: d.fn(help='`google.number.withSlotCount` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the slot_count 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 `slot_count` field.\n', args=[]), + withSlotCount(resourceLabel, value): { + resource+: { + google_bigquery_capacity_commitment+: { + [resourceLabel]+: { + slot_count: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_bigquery_capacity_commitment+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_bigquery_capacity_commitment+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/4.x/_gen/resources/firestore_database.libsonnet b/4.x/_gen/resources/firestore_database.libsonnet new file mode 100644 index 0000000..045bc57 --- /dev/null +++ b/4.x/_gen/resources/firestore_database.libsonnet @@ -0,0 +1,140 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='firestore_database', url='', help='`firestore_database` represents the `google_firestore_database` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`google.firestore_database.new` injects a new `google_firestore_database` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n google.firestore_database.new('some_id')\n\nYou can get the reference to the `id` field of the created `google.firestore_database` using the reference:\n\n $._ref.google_firestore_database.some_id.get('id')\n\nThis is the same as directly entering `\"${ google_firestore_database.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `app_engine_integration_mode` (`string`): The App Engine integration mode to use for this database. Possible values: [\u0026#34;ENABLED\u0026#34;, \u0026#34;DISABLED\u0026#34;] When `null`, the `app_engine_integration_mode` field will be omitted from the resulting object.\n - `concurrency_mode` (`string`): The concurrency control mode to use for this database. Possible values: [\u0026#34;OPTIMISTIC\u0026#34;, \u0026#34;PESSIMISTIC\u0026#34;, \u0026#34;OPTIMISTIC_WITH_ENTITY_GROUPS\u0026#34;] When `null`, the `concurrency_mode` field will be omitted from the resulting object.\n - `location_id` (`string`): The location of the database. Available databases are listed at\nhttps://cloud.google.com/firestore/docs/locations.\n - `name` (`string`): Required. The ID to use for the database, which will become the final\ncomponent of the database\u0026#39;s resource name. This value should be 4-63\ncharacters. Valid characters are /[a-z][0-9]-/ with first character\na letter and the last a letter or a number. Must not be\nUUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.\n\u0026#34;(default)\u0026#34; database id is also valid.\n - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object.\n - `type` (`string`): The type of the database.\nSee https://cloud.google.com/datastore/docs/firestore-or-datastore\nfor information about how to choose. Possible values: [\u0026#34;FIRESTORE_NATIVE\u0026#34;, \u0026#34;DATASTORE_MODE\u0026#34;]\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.firestore_database.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + location_id, + name, + type, + app_engine_integration_mode=null, + concurrency_mode=null, + project=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='google_firestore_database', + label=resourceLabel, + attrs=self.newAttrs( + app_engine_integration_mode=app_engine_integration_mode, + concurrency_mode=concurrency_mode, + location_id=location_id, + name=name, + project=project, + timeouts=timeouts, + type=type + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`google.firestore_database.newAttrs` constructs a new object with attributes and blocks configured for the `firestore_database`\nTerraform resource.\n\nUnlike [google.firestore_database.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `app_engine_integration_mode` (`string`): The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"] When `null`, the `app_engine_integration_mode` field will be omitted from the resulting object.\n - `concurrency_mode` (`string`): The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"] When `null`, the `concurrency_mode` field will be omitted from the resulting object.\n - `location_id` (`string`): The location of the database. Available databases are listed at\nhttps://cloud.google.com/firestore/docs/locations.\n - `name` (`string`): Required. The ID to use for the database, which will become the final\ncomponent of the database's resource name. This value should be 4-63\ncharacters. Valid characters are /[a-z][0-9]-/ with first character\na letter and the last a letter or a number. Must not be\nUUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.\n"(default)" database id is also valid.\n - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object.\n - `type` (`string`): The type of the database.\nSee https://cloud.google.com/datastore/docs/firestore-or-datastore\nfor information about how to choose. Possible values: ["FIRESTORE_NATIVE", "DATASTORE_MODE"]\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.firestore_database.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `firestore_database` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + location_id, + name, + type, + app_engine_integration_mode=null, + concurrency_mode=null, + project=null, + timeouts=null + ):: std.prune(a={ + app_engine_integration_mode: app_engine_integration_mode, + concurrency_mode: concurrency_mode, + location_id: location_id, + name: name, + project: project, + timeouts: timeouts, + type: type, + }), + timeouts:: { + '#new':: d.fn(help='\n`google.firestore_database.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, + }), + }, + '#withAppEngineIntegrationMode':: d.fn(help='`google.string.withAppEngineIntegrationMode` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the app_engine_integration_mode 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_engine_integration_mode` field.\n', args=[]), + withAppEngineIntegrationMode(resourceLabel, value): { + resource+: { + google_firestore_database+: { + [resourceLabel]+: { + app_engine_integration_mode: value, + }, + }, + }, + }, + '#withConcurrencyMode':: d.fn(help='`google.string.withConcurrencyMode` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the concurrency_mode 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 `concurrency_mode` field.\n', args=[]), + withConcurrencyMode(resourceLabel, value): { + resource+: { + google_firestore_database+: { + [resourceLabel]+: { + concurrency_mode: value, + }, + }, + }, + }, + '#withLocationId':: d.fn(help='`google.string.withLocationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `location_id` field.\n', args=[]), + withLocationId(resourceLabel, value): { + resource+: { + google_firestore_database+: { + [resourceLabel]+: { + location_id: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`google.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + google_firestore_database+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withProject':: d.fn(help='`google.string.withProject` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the project field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `project` field.\n', args=[]), + withProject(resourceLabel, value): { + resource+: { + google_firestore_database+: { + [resourceLabel]+: { + project: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + google_firestore_database+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + google_firestore_database+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withType':: d.fn(help='`google.string.withType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `type` field.\n', args=[]), + withType(resourceLabel, value): { + resource+: { + google_firestore_database+: { + [resourceLabel]+: { + type: value, + }, + }, + }, + }, +} diff --git a/docs/4.x/README.md b/docs/4.x/README.md index d95cc53..33d1bb4 100644 --- a/docs/4.x/README.md +++ b/docs/4.x/README.md @@ -18,6 +18,7 @@ project. * [access_context_manager_access_policy_iam_binding](access_context_manager_access_policy_iam_binding.md) * [access_context_manager_access_policy_iam_member](access_context_manager_access_policy_iam_member.md) * [access_context_manager_access_policy_iam_policy](access_context_manager_access_policy_iam_policy.md) +* [access_context_manager_authorized_orgs_desc](access_context_manager_authorized_orgs_desc.md) * [access_context_manager_gcp_user_access_binding](access_context_manager_gcp_user_access_binding.md) * [access_context_manager_service_perimeter](access_context_manager_service_perimeter.md) * [access_context_manager_service_perimeter_resource](access_context_manager_service_perimeter_resource.md) @@ -29,6 +30,8 @@ project. * [alloydb_instance](alloydb_instance.md) * [apigee_addons_config](apigee_addons_config.md) * [apigee_endpoint_attachment](apigee_endpoint_attachment.md) +* [apigee_env_keystore](apigee_env_keystore.md) +* [apigee_env_references](apigee_env_references.md) * [apigee_envgroup](apigee_envgroup.md) * [apigee_envgroup_attachment](apigee_envgroup_attachment.md) * [apigee_environment](apigee_environment.md) @@ -65,6 +68,7 @@ project. * [bigquery_analytics_hub_listing_iam_binding](bigquery_analytics_hub_listing_iam_binding.md) * [bigquery_analytics_hub_listing_iam_member](bigquery_analytics_hub_listing_iam_member.md) * [bigquery_analytics_hub_listing_iam_policy](bigquery_analytics_hub_listing_iam_policy.md) +* [bigquery_capacity_commitment](bigquery_capacity_commitment.md) * [bigquery_connection](bigquery_connection.md) * [bigquery_connection_iam_binding](bigquery_connection_iam_binding.md) * [bigquery_connection_iam_member](bigquery_connection_iam_member.md) @@ -356,6 +360,7 @@ project. * [filestore_snapshot](filestore_snapshot.md) * [firebaserules_release](firebaserules_release.md) * [firebaserules_ruleset](firebaserules_ruleset.md) +* [firestore_database](firestore_database.md) * [firestore_document](firestore_document.md) * [firestore_index](firestore_index.md) * [folder](folder.md) diff --git a/docs/4.x/access_context_manager_authorized_orgs_desc.md b/docs/4.x/access_context_manager_authorized_orgs_desc.md new file mode 100644 index 0000000..5378f72 --- /dev/null +++ b/docs/4.x/access_context_manager_authorized_orgs_desc.md @@ -0,0 +1,302 @@ +--- +permalink: /access_context_manager_authorized_orgs_desc/ +--- + +# access_context_manager_authorized_orgs_desc + +`access_context_manager_authorized_orgs_desc` represents the `google_access_context_manager_authorized_orgs_desc` 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 withAssetType()`](#fn-withassettype) +* [`fn withAuthorizationDirection()`](#fn-withauthorizationdirection) +* [`fn withAuthorizationType()`](#fn-withauthorizationtype) +* [`fn withName()`](#fn-withname) +* [`fn withOrgs()`](#fn-withorgs) +* [`fn withParent()`](#fn-withparent) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.access_context_manager_authorized_orgs_desc.new` injects a new `google_access_context_manager_authorized_orgs_desc` 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.access_context_manager_authorized_orgs_desc.new('some_id') + +You can get the reference to the `id` field of the created `google.access_context_manager_authorized_orgs_desc` using the reference: + + $._ref.google_access_context_manager_authorized_orgs_desc.some_id.get('id') + +This is the same as directly entering `"${ google_access_context_manager_authorized_orgs_desc.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. + - `asset_type` (`string`): The type of entities that need to use the authorization relationship during +evaluation, such as a device. Valid values are "ASSET_TYPE_DEVICE" and +"ASSET_TYPE_CREDENTIAL_STRENGTH". Possible values: ["ASSET_TYPE_DEVICE", "ASSET_TYPE_CREDENTIAL_STRENGTH"] When `null`, the `asset_type` field will be omitted from the resulting object. + - `authorization_direction` (`string`): The direction of the authorization relationship between this organization +and the organizations listed in the "orgs" field. The valid values for this +field include the following: + +AUTHORIZATION_DIRECTION_FROM: Allows this organization to evaluate traffic +in the organizations listed in the 'orgs' field. + +AUTHORIZATION_DIRECTION_TO: Allows the organizations listed in the 'orgs' +field to evaluate the traffic in this organization. + +For the authorization relationship to take effect, all of the organizations +must authorize and specify the appropriate relationship direction. For +example, if organization A authorized organization B and C to evaluate its +traffic, by specifying "AUTHORIZATION_DIRECTION_TO" as the authorization +direction, organizations B and C must specify +"AUTHORIZATION_DIRECTION_FROM" as the authorization direction in their +"AuthorizedOrgsDesc" resource. Possible values: ["AUTHORIZATION_DIRECTION_TO", "AUTHORIZATION_DIRECTION_FROM"] When `null`, the `authorization_direction` field will be omitted from the resulting object. + - `authorization_type` (`string`): A granular control type for authorization levels. Valid value is "AUTHORIZATION_TYPE_TRUST". Possible values: ["AUTHORIZATION_TYPE_TRUST"] When `null`, the `authorization_type` field will be omitted from the resulting object. + - `name` (`string`): Resource name for the 'AuthorizedOrgsDesc'. Format: +'accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}'. +The 'authorized_orgs_desc' component must begin with a letter, followed by +alphanumeric characters or '_'. +After you create an 'AuthorizedOrgsDesc', you cannot change its 'name'. + - `orgs` (`list`): The list of organization ids in this AuthorizedOrgsDesc. +Format: 'organizations/<org_number>' +Example: 'organizations/123456' When `null`, the `orgs` field will be omitted from the resulting object. + - `parent` (`string`): Required. Resource name for the access policy which owns this 'AuthorizedOrgsDesc'. + - `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.access_context_manager_authorized_orgs_desc.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.access_context_manager_authorized_orgs_desc.newAttrs` constructs a new object with attributes and blocks configured for the `access_context_manager_authorized_orgs_desc` +Terraform resource. + +Unlike [google.access_context_manager_authorized_orgs_desc.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**: + - `asset_type` (`string`): The type of entities that need to use the authorization relationship during +evaluation, such as a device. Valid values are "ASSET_TYPE_DEVICE" and +"ASSET_TYPE_CREDENTIAL_STRENGTH". Possible values: ["ASSET_TYPE_DEVICE", "ASSET_TYPE_CREDENTIAL_STRENGTH"] When `null`, the `asset_type` field will be omitted from the resulting object. + - `authorization_direction` (`string`): The direction of the authorization relationship between this organization +and the organizations listed in the "orgs" field. The valid values for this +field include the following: + +AUTHORIZATION_DIRECTION_FROM: Allows this organization to evaluate traffic +in the organizations listed in the 'orgs' field. + +AUTHORIZATION_DIRECTION_TO: Allows the organizations listed in the 'orgs' +field to evaluate the traffic in this organization. + +For the authorization relationship to take effect, all of the organizations +must authorize and specify the appropriate relationship direction. For +example, if organization A authorized organization B and C to evaluate its +traffic, by specifying "AUTHORIZATION_DIRECTION_TO" as the authorization +direction, organizations B and C must specify +"AUTHORIZATION_DIRECTION_FROM" as the authorization direction in their +"AuthorizedOrgsDesc" resource. Possible values: ["AUTHORIZATION_DIRECTION_TO", "AUTHORIZATION_DIRECTION_FROM"] When `null`, the `authorization_direction` field will be omitted from the resulting object. + - `authorization_type` (`string`): A granular control type for authorization levels. Valid value is "AUTHORIZATION_TYPE_TRUST". Possible values: ["AUTHORIZATION_TYPE_TRUST"] When `null`, the `authorization_type` field will be omitted from the resulting object. + - `name` (`string`): Resource name for the 'AuthorizedOrgsDesc'. Format: +'accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}'. +The 'authorized_orgs_desc' component must begin with a letter, followed by +alphanumeric characters or '_'. +After you create an 'AuthorizedOrgsDesc', you cannot change its 'name'. + - `orgs` (`list`): The list of organization ids in this AuthorizedOrgsDesc. +Format: 'organizations/<org_number>' +Example: 'organizations/123456' When `null`, the `orgs` field will be omitted from the resulting object. + - `parent` (`string`): Required. Resource name for the access policy which owns this 'AuthorizedOrgsDesc'. + - `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.access_context_manager_authorized_orgs_desc.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 `access_context_manager_authorized_orgs_desc` resource into the root Terraform configuration. + + +### fn withAssetType + +```ts +withAssetType() +``` + +`google.string.withAssetType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the asset_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `asset_type` field. + + +### fn withAuthorizationDirection + +```ts +withAuthorizationDirection() +``` + +`google.string.withAuthorizationDirection` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the authorization_direction field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `authorization_direction` field. + + +### fn withAuthorizationType + +```ts +withAuthorizationType() +``` + +`google.string.withAuthorizationType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the authorization_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `authorization_type` field. + + +### fn withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withOrgs + +```ts +withOrgs() +``` + +`google.list.withOrgs` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the orgs field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `orgs` field. + + +### fn withParent + +```ts +withParent() +``` + +`google.string.withParent` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the parent field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `parent` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.access_context_manager_authorized_orgs_desc.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/apigee_env_keystore.md b/docs/4.x/apigee_env_keystore.md new file mode 100644 index 0000000..30c76af --- /dev/null +++ b/docs/4.x/apigee_env_keystore.md @@ -0,0 +1,179 @@ +--- +permalink: /apigee_env_keystore/ +--- + +# apigee_env_keystore + +`apigee_env_keystore` represents the `google_apigee_env_keystore` 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 withEnvId()`](#fn-withenvid) +* [`fn withName()`](#fn-withname) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.apigee_env_keystore.new` injects a new `google_apigee_env_keystore` 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.apigee_env_keystore.new('some_id') + +You can get the reference to the `id` field of the created `google.apigee_env_keystore` using the reference: + + $._ref.google_apigee_env_keystore.some_id.get('id') + +This is the same as directly entering `"${ google_apigee_env_keystore.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. + - `env_id` (`string`): The Apigee environment group associated with the Apigee environment, +in the format 'organizations/{{org_name}}/environments/{{env_name}}'. + - `name` (`string`): The name of the newly created keystore. When `null`, the `name` 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.apigee_env_keystore.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.apigee_env_keystore.newAttrs` constructs a new object with attributes and blocks configured for the `apigee_env_keystore` +Terraform resource. + +Unlike [google.apigee_env_keystore.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**: + - `env_id` (`string`): The Apigee environment group associated with the Apigee environment, +in the format 'organizations/{{org_name}}/environments/{{env_name}}'. + - `name` (`string`): The name of the newly created keystore. When `null`, the `name` 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.apigee_env_keystore.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 `apigee_env_keystore` resource into the root Terraform configuration. + + +### fn withEnvId + +```ts +withEnvId() +``` + +`google.string.withEnvId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the env_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `env_id` field. + + +### fn withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.apigee_env_keystore.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/apigee_env_references.md b/docs/4.x/apigee_env_references.md new file mode 100644 index 0000000..69e4e22 --- /dev/null +++ b/docs/4.x/apigee_env_references.md @@ -0,0 +1,236 @@ +--- +permalink: /apigee_env_references/ +--- + +# apigee_env_references + +`apigee_env_references` represents the `google_apigee_env_references` 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 withEnvId()`](#fn-withenvid) +* [`fn withName()`](#fn-withname) +* [`fn withRefers()`](#fn-withrefers) +* [`fn withResourceType()`](#fn-withresourcetype) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.apigee_env_references.new` injects a new `google_apigee_env_references` 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.apigee_env_references.new('some_id') + +You can get the reference to the `id` field of the created `google.apigee_env_references` using the reference: + + $._ref.google_apigee_env_references.some_id.get('id') + +This is the same as directly entering `"${ google_apigee_env_references.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`): Optional. A human-readable description of this reference. When `null`, the `description` field will be omitted from the resulting object. + - `env_id` (`string`): The Apigee environment group associated with the Apigee environment, +in the format 'organizations/{{org_name}}/environments/{{env_name}}'. + - `name` (`string`): Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+. + - `refers` (`string`): Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType. + - `resource_type` (`string`): The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'. + - `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.apigee_env_references.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.apigee_env_references.newAttrs` constructs a new object with attributes and blocks configured for the `apigee_env_references` +Terraform resource. + +Unlike [google.apigee_env_references.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`): Optional. A human-readable description of this reference. When `null`, the `description` field will be omitted from the resulting object. + - `env_id` (`string`): The Apigee environment group associated with the Apigee environment, +in the format 'organizations/{{org_name}}/environments/{{env_name}}'. + - `name` (`string`): Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+. + - `refers` (`string`): Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resourceType. + - `resource_type` (`string`): The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'. + - `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.apigee_env_references.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 `apigee_env_references` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`google.string.withDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `description` field. + + +### fn withEnvId + +```ts +withEnvId() +``` + +`google.string.withEnvId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the env_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `env_id` field. + + +### fn withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withRefers + +```ts +withRefers() +``` + +`google.string.withRefers` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the refers field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `refers` field. + + +### fn withResourceType + +```ts +withResourceType() +``` + +`google.string.withResourceType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the resource_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `resource_type` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.apigee_env_references.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/bigquery_capacity_commitment.md b/docs/4.x/bigquery_capacity_commitment.md new file mode 100644 index 0000000..2c99806 --- /dev/null +++ b/docs/4.x/bigquery_capacity_commitment.md @@ -0,0 +1,281 @@ +--- +permalink: /bigquery_capacity_commitment/ +--- + +# bigquery_capacity_commitment + +`bigquery_capacity_commitment` represents the `google_bigquery_capacity_commitment` 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 withCapacityCommitmentId()`](#fn-withcapacitycommitmentid) +* [`fn withEnforceSingleAdminProjectPerOrg()`](#fn-withenforcesingleadminprojectperorg) +* [`fn withLocation()`](#fn-withlocation) +* [`fn withPlan()`](#fn-withplan) +* [`fn withProject()`](#fn-withproject) +* [`fn withRenewalPlan()`](#fn-withrenewalplan) +* [`fn withSlotCount()`](#fn-withslotcount) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.bigquery_capacity_commitment.new` injects a new `google_bigquery_capacity_commitment` 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.bigquery_capacity_commitment.new('some_id') + +You can get the reference to the `id` field of the created `google.bigquery_capacity_commitment` using the reference: + + $._ref.google_bigquery_capacity_commitment.some_id.get('id') + +This is the same as directly entering `"${ google_bigquery_capacity_commitment.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `capacity_commitment_id` (`string`): The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is +empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character +cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split +or merged. When `null`, the `capacity_commitment_id` field will be omitted from the resulting object. + - `enforce_single_admin_project_per_org` (`string`): If true, fail the request if another project in the organization has a capacity commitment. When `null`, the `enforce_single_admin_project_per_org` field will be omitted from the resulting object. + - `location` (`string`): The geographic location where the transfer config should reside. +Examples: US, EU, asia-northeast1. The default value is US. When `null`, the `location` field will be omitted from the resulting object. + - `plan` (`string`): Capacity commitment plan. Valid values are FLEX, TRIAL, MONTHLY, ANNUAL + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `renewal_plan` (`string`): The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. When `null`, the `renewal_plan` field will be omitted from the resulting object. + - `slot_count` (`number`): Number of slots in this commitment. + - `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.bigquery_capacity_commitment.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.bigquery_capacity_commitment.newAttrs` constructs a new object with attributes and blocks configured for the `bigquery_capacity_commitment` +Terraform resource. + +Unlike [google.bigquery_capacity_commitment.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `capacity_commitment_id` (`string`): The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is +empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character +cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split +or merged. When `null`, the `capacity_commitment_id` field will be omitted from the resulting object. + - `enforce_single_admin_project_per_org` (`string`): If true, fail the request if another project in the organization has a capacity commitment. When `null`, the `enforce_single_admin_project_per_org` field will be omitted from the resulting object. + - `location` (`string`): The geographic location where the transfer config should reside. +Examples: US, EU, asia-northeast1. The default value is US. When `null`, the `location` field will be omitted from the resulting object. + - `plan` (`string`): Capacity commitment plan. Valid values are FLEX, TRIAL, MONTHLY, ANNUAL + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `renewal_plan` (`string`): The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. When `null`, the `renewal_plan` field will be omitted from the resulting object. + - `slot_count` (`number`): Number of slots in this commitment. + - `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.bigquery_capacity_commitment.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 `bigquery_capacity_commitment` resource into the root Terraform configuration. + + +### fn withCapacityCommitmentId + +```ts +withCapacityCommitmentId() +``` + +`google.string.withCapacityCommitmentId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the capacity_commitment_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `capacity_commitment_id` field. + + +### fn withEnforceSingleAdminProjectPerOrg + +```ts +withEnforceSingleAdminProjectPerOrg() +``` + +`google.string.withEnforceSingleAdminProjectPerOrg` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the enforce_single_admin_project_per_org field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `enforce_single_admin_project_per_org` field. + + +### fn withLocation + +```ts +withLocation() +``` + +`google.string.withLocation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location` field. + + +### fn withPlan + +```ts +withPlan() +``` + +`google.string.withPlan` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the plan field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `plan` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withRenewalPlan + +```ts +withRenewalPlan() +``` + +`google.string.withRenewalPlan` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the renewal_plan field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `renewal_plan` field. + + +### fn withSlotCount + +```ts +withSlotCount() +``` + +`google.number.withSlotCount` constructs a mixin object that can be merged into the `number` +Terraform resource block to set or update the slot_count field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`number`): The value to set for the `slot_count` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.bigquery_capacity_commitment.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/firestore_database.md b/docs/4.x/firestore_database.md new file mode 100644 index 0000000..bbf43aa --- /dev/null +++ b/docs/4.x/firestore_database.md @@ -0,0 +1,270 @@ +--- +permalink: /firestore_database/ +--- + +# firestore_database + +`firestore_database` represents the `google_firestore_database` 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 withAppEngineIntegrationMode()`](#fn-withappengineintegrationmode) +* [`fn withConcurrencyMode()`](#fn-withconcurrencymode) +* [`fn withLocationId()`](#fn-withlocationid) +* [`fn withName()`](#fn-withname) +* [`fn withProject()`](#fn-withproject) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withType()`](#fn-withtype) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`google.firestore_database.new` injects a new `google_firestore_database` 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.firestore_database.new('some_id') + +You can get the reference to the `id` field of the created `google.firestore_database` using the reference: + + $._ref.google_firestore_database.some_id.get('id') + +This is the same as directly entering `"${ google_firestore_database.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. + - `app_engine_integration_mode` (`string`): The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"] When `null`, the `app_engine_integration_mode` field will be omitted from the resulting object. + - `concurrency_mode` (`string`): The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"] When `null`, the `concurrency_mode` field will be omitted from the resulting object. + - `location_id` (`string`): The location of the database. Available databases are listed at +https://cloud.google.com/firestore/docs/locations. + - `name` (`string`): Required. The ID to use for the database, which will become the final +component of the database's resource name. This value should be 4-63 +characters. Valid characters are /[a-z][0-9]-/ with first character +a letter and the last a letter or a number. Must not be +UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. +"(default)" database id is also valid. + - `project` (`string`): Set the `project` field on the resulting resource block. When `null`, the `project` field will be omitted from the resulting object. + - `type` (`string`): The type of the database. +See https://cloud.google.com/datastore/docs/firestore-or-datastore +for information about how to choose. Possible values: ["FIRESTORE_NATIVE", "DATASTORE_MODE"] + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.firestore_database.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`google.firestore_database.newAttrs` constructs a new object with attributes and blocks configured for the `firestore_database` +Terraform resource. + +Unlike [google.firestore_database.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**: + - `app_engine_integration_mode` (`string`): The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"] When `null`, the `app_engine_integration_mode` field will be omitted from the resulting object. + - `concurrency_mode` (`string`): The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"] When `null`, the `concurrency_mode` field will be omitted from the resulting object. + - `location_id` (`string`): The location of the database. Available databases are listed at +https://cloud.google.com/firestore/docs/locations. + - `name` (`string`): Required. The ID to use for the database, which will become the final +component of the database's resource name. This value should be 4-63 +characters. Valid characters are /[a-z][0-9]-/ with first character +a letter and the last a letter or a number. Must not be +UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. +"(default)" database id is also valid. + - `project` (`string`): Set the `project` field on the resulting object. When `null`, the `project` field will be omitted from the resulting object. + - `type` (`string`): The type of the database. +See https://cloud.google.com/datastore/docs/firestore-or-datastore +for information about how to choose. Possible values: ["FIRESTORE_NATIVE", "DATASTORE_MODE"] + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [google.firestore_database.timeouts.new](#fn-timeoutsnew) constructor. + +**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 `firestore_database` resource into the root Terraform configuration. + + +### fn withAppEngineIntegrationMode + +```ts +withAppEngineIntegrationMode() +``` + +`google.string.withAppEngineIntegrationMode` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the app_engine_integration_mode field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `app_engine_integration_mode` field. + + +### fn withConcurrencyMode + +```ts +withConcurrencyMode() +``` + +`google.string.withConcurrencyMode` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the concurrency_mode field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `concurrency_mode` field. + + +### fn withLocationId + +```ts +withLocationId() +``` + +`google.string.withLocationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the location_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `location_id` field. + + +### fn withName + +```ts +withName() +``` + +`google.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withProject + +```ts +withProject() +``` + +`google.string.withProject` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the project field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `project` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`google.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [google.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`google.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [google.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withType + +```ts +withType() +``` + +`google.string.withType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `type` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`google.firestore_database.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.