blob: f50ccc4522f2d7aa3f864d9a9025362fd4e83ba7 [file] [log] [blame]
---
# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** Type: MMv1 ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file in
# .github/CONTRIBUTING.md.
#
# ----------------------------------------------------------------------------
subcategory: "Integration Connectors"
description: |-
An Integration connectors Endpoint Attachment.
---
# google\_integration\_connectors\_endpoint\_attachment
An Integration connectors Endpoint Attachment.
To get more information about EndpointAttachment, see:
* [API documentation](https://cloud.google.com/integration-connectors/docs/reference/rest/v1/projects.locations.endpointAttachments)
* How-to Guides
* [Official Documentation](https://cloud.google.com/integration-connectors/docs/create-endpoint-attachment)
<div class = "oics-button" style="float: right; margin: 0 0 -15px">
<a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=integration_connectors_endpoint_attachment&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank">
<img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
</a>
</div>
## Example Usage - Integration Connectors Endpoint Attachment
```hcl
resource "google_integration_connectors_endpoint_attachment" "sampleendpointattachment" {
name = "test-endpoint-attachment"
location = "us-central1"
description = "tf created description"
service_attachment = "projects/connectors-example/regions/us-central1/serviceAttachments/test"
labels = {
foo = "bar"
}
}
```
## Argument Reference
The following arguments are supported:
* `service_attachment` -
(Required)
The path of the service attachment.
* `location` -
(Required)
Location in which Endpoint Attachment needs to be created.
* `name` -
(Required)
Name of Endpoint Attachment needs to be created.
- - -
* `description` -
(Optional)
Description of the resource.
* `labels` -
(Optional)
Resource labels to represent user provided metadata.
**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field `effective_labels` for all of the labels present on the resource.
* `project` - (Optional) The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
## Attributes Reference
In addition to the arguments listed above, the following computed attributes are exported:
* `id` - an identifier for the resource with format `projects/{{project}}/locations/{{location}}/endpointAttachments/{{name}}`
* `create_time` -
Time the Namespace was created in UTC.
* `update_time` -
Time the Namespace was updated in UTC.
* `endpoint_ip` -
The Private Service Connect connection endpoint ip.
* `terraform_labels` -
The combination of labels configured directly on the resource
and default labels configured on the provider.
* `effective_labels` -
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
## Timeouts
This resource provides the following
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:
- `create` - Default is 5 minutes.
- `update` - Default is 5 minutes.
- `delete` - Default is 5 minutes.
## Import
EndpointAttachment can be imported using any of these accepted formats:
* `projects/{{project}}/locations/{{location}}/endpointAttachments/{{name}}`
* `{{project}}/{{location}}/{{name}}`
* `{{location}}/{{name}}`
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EndpointAttachment using one of the formats above. For example:
```tf
import {
id = "projects/{{project}}/locations/{{location}}/endpointAttachments/{{name}}"
to = google_integration_connectors_endpoint_attachment.default
}
```
When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), EndpointAttachment can be imported using one of the formats above. For example:
```
$ terraform import google_integration_connectors_endpoint_attachment.default projects/{{project}}/locations/{{location}}/endpointAttachments/{{name}}
$ terraform import google_integration_connectors_endpoint_attachment.default {{project}}/{{location}}/{{name}}
$ terraform import google_integration_connectors_endpoint_attachment.default {{location}}/{{name}}
```
## User Project Overrides
This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override).