From b61ae8509d9a3b8e6c26a367523cb7daef15bbdb Mon Sep 17 00:00:00 2001 From: Andrew Tulloch Date: Thu, 23 Jan 2025 21:58:13 +0000 Subject: [PATCH] docs --- ...network_resource_association.html.markdown | 75 +++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 website/docs/r/vpclattice_service_network_resource_association.html.markdown diff --git a/website/docs/r/vpclattice_service_network_resource_association.html.markdown b/website/docs/r/vpclattice_service_network_resource_association.html.markdown new file mode 100644 index 00000000000..87846c716c5 --- /dev/null +++ b/website/docs/r/vpclattice_service_network_resource_association.html.markdown @@ -0,0 +1,75 @@ +--- +subcategory: "VPC Lattice" +layout: "aws" +page_title: "AWS: aws_vpclattice_service_network_resource_association" +description: |- + Terraform resource for managing an AWS VPC Lattice Service Network Resource Association. +--- +# Resource: aws_vpclattice_service_network_resource_association + +Terraform resource for managing an AWS VPC Lattice Service Network Resource Association. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_vpclattice_service_network_resource_association" "example" { + resource_configuration_identifier = aws_vpclattice_resource_configuration.example.id + service_network_identifier = aws_vpclattice_service_network.example.id + + tags = { + Name = "Example" + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `resource_configuration_identifier` - (Required) Identifier of Resource Configuration to associate to the Service Network. +* `service_network_identifier` - (Required) Identifier of the Service Network to associate the Resource to. + +The following arguments are optional: + +* `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `arn` - ARN of the Service Network Resource Association. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information. +* `id` - ID ot the association. +* `dns_entry` DNS entry of the association in the service network. + * `domain_name` The domain name of the association in the service network. + * `hosted_zone_id` The ID of the hosted zone containing the domain name. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +### `resource_configuration_definition` Block + + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `5m`) +* `delete` - (Default `5m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import VPC Lattice Service Network Resource Association using the `example_id_arg`. For example: + +```terraform +import { + to = aws_vpclattice_service_network_resource_association.example + id = "snra-1234567890abcef12" +} +``` + +Using `terraform import`, import VPC Lattice Service Network Resource Association using the `snra-1234567890abcef12`. For example: + +```console +% terraform import aws_vpclattice_service_network_resource_association.example snra-1234567890abcef12 +```