|
| 1 | +--- |
| 2 | +# ---------------------------------------------------------------------------- |
| 3 | +# |
| 4 | +# *** AUTO GENERATED CODE *** Type: MMv1 *** |
| 5 | +# |
| 6 | +# ---------------------------------------------------------------------------- |
| 7 | +# |
| 8 | +# This file is automatically generated by Magic Modules and manual |
| 9 | +# changes will be clobbered when the file is regenerated. |
| 10 | +# |
| 11 | +# Please read more about how to change this file in |
| 12 | +# .github/CONTRIBUTING.md. |
| 13 | +# |
| 14 | +# ---------------------------------------------------------------------------- |
| 15 | +subcategory: "Gemini for Google Cloud" |
| 16 | +description: |- |
| 17 | + The resource for managing ReleaseChannel settings for Admin Control. |
| 18 | +--- |
| 19 | + |
| 20 | +# google_gemini_release_channel_setting |
| 21 | + |
| 22 | +The resource for managing ReleaseChannel settings for Admin Control. |
| 23 | + |
| 24 | +~> **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. |
| 25 | +See [Provider Versions](https://terraform.io/docs/providers/google/guides/provider_versions.html) for more details on beta resources. |
| 26 | + |
| 27 | + |
| 28 | +<div class = "oics-button" style="float: right; margin: 0 0 -15px"> |
| 29 | + <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md&cloudshell_working_dir=gemini_release_channel_setting_basic&open_in_editor=main.tf" target="_blank"> |
| 30 | + <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;"> |
| 31 | + </a> |
| 32 | +</div> |
| 33 | +## Example Usage - Gemini Release Channel Setting Basic |
| 34 | + |
| 35 | + |
| 36 | +```hcl |
| 37 | +resource "google_gemini_release_channel_setting" "example" { |
| 38 | + provider = google-beta |
| 39 | + release_channel_setting_id = "ls1-tf" |
| 40 | + location = "global" |
| 41 | + release_channel = "EXPERIMENTAL" |
| 42 | +} |
| 43 | +``` |
| 44 | + |
| 45 | +## Argument Reference |
| 46 | + |
| 47 | +The following arguments are supported: |
| 48 | + |
| 49 | + |
| 50 | +* `location` - |
| 51 | + (Required) |
| 52 | + Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. |
| 53 | + |
| 54 | +* `release_channel_setting_id` - |
| 55 | + (Required) |
| 56 | + Required. Id of the requesting object. |
| 57 | + If auto-generating Id server-side, remove this field and |
| 58 | + release_channel_setting_id from the method_signature of Create RPC |
| 59 | + |
| 60 | + |
| 61 | +- - - |
| 62 | + |
| 63 | + |
| 64 | +* `labels` - |
| 65 | + (Optional) |
| 66 | + Optional. Labels as key value pairs. |
| 67 | + **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. |
| 68 | + Please refer to the field `effective_labels` for all of the labels present on the resource. |
| 69 | + |
| 70 | +* `release_channel` - |
| 71 | + (Optional) |
| 72 | + Optional. Release channel to be used. |
| 73 | + Possible values: |
| 74 | + STABLE |
| 75 | + EXPERIMENTAL |
| 76 | + |
| 77 | +* `project` - (Optional) The ID of the project in which the resource belongs. |
| 78 | + If it is not provided, the provider project is used. |
| 79 | + |
| 80 | + |
| 81 | +## Attributes Reference |
| 82 | + |
| 83 | +In addition to the arguments listed above, the following computed attributes are exported: |
| 84 | + |
| 85 | +* `id` - an identifier for the resource with format `projects/{{project}}/locations/{{location}}/releaseChannelSettings/{{release_channel_setting_id}}` |
| 86 | + |
| 87 | +* `create_time` - |
| 88 | + Output only. [Output only] Create time stamp. |
| 89 | + |
| 90 | +* `update_time` - |
| 91 | + Output only. [Output only] Update time stamp. |
| 92 | + |
| 93 | +* `name` - |
| 94 | + Identifier. Name of the resource. |
| 95 | + Format:projects/{project}/locations/{location}/releaseChannelSettings/{releaseChannelSetting} |
| 96 | + |
| 97 | +* `terraform_labels` - |
| 98 | + The combination of labels configured directly on the resource |
| 99 | + and default labels configured on the provider. |
| 100 | + |
| 101 | +* `effective_labels` - |
| 102 | + All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services. |
| 103 | + |
| 104 | + |
| 105 | +## Timeouts |
| 106 | + |
| 107 | +This resource provides the following |
| 108 | +[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options: |
| 109 | + |
| 110 | +- `create` - Default is 20 minutes. |
| 111 | +- `update` - Default is 20 minutes. |
| 112 | +- `delete` - Default is 20 minutes. |
| 113 | + |
| 114 | +## Import |
| 115 | + |
| 116 | + |
| 117 | +ReleaseChannelSetting can be imported using any of these accepted formats: |
| 118 | + |
| 119 | +* `projects/{{project}}/locations/{{location}}/releaseChannelSettings/{{release_channel_setting_id}}` |
| 120 | +* `{{project}}/{{location}}/{{release_channel_setting_id}}` |
| 121 | +* `{{location}}/{{release_channel_setting_id}}` |
| 122 | + |
| 123 | + |
| 124 | +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ReleaseChannelSetting using one of the formats above. For example: |
| 125 | + |
| 126 | +```tf |
| 127 | +import { |
| 128 | + id = "projects/{{project}}/locations/{{location}}/releaseChannelSettings/{{release_channel_setting_id}}" |
| 129 | + to = google_gemini_release_channel_setting.default |
| 130 | +} |
| 131 | +``` |
| 132 | + |
| 133 | +When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), ReleaseChannelSetting can be imported using one of the formats above. For example: |
| 134 | + |
| 135 | +``` |
| 136 | +$ terraform import google_gemini_release_channel_setting.default projects/{{project}}/locations/{{location}}/releaseChannelSettings/{{release_channel_setting_id}} |
| 137 | +$ terraform import google_gemini_release_channel_setting.default {{project}}/{{location}}/{{release_channel_setting_id}} |
| 138 | +$ terraform import google_gemini_release_channel_setting.default {{location}}/{{release_channel_setting_id}} |
| 139 | +``` |
| 140 | + |
| 141 | +## User Project Overrides |
| 142 | + |
| 143 | +This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override). |
0 commit comments