mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-29 10:21:01 -06:00
Website: Adding an import section to the bottom of the page of importable resources (#7703)
* docs/digitalocean: Adding an import section to the bottom of the DO importable resources * docs/azurerm: Adding the Import sections for the AzureRM Importable resources * docs/aws: Adding the import sections to the AWS provider pages
This commit is contained in:
parent
e1c3eba144
commit
2559c19c8d
@ -29,3 +29,11 @@ The following arguments are supported:
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The name of the SimpleDB domain
|
||||
|
||||
## Import
|
||||
|
||||
SimpleDB Domains can be imported using the `name`, e.g.
|
||||
|
||||
```
|
||||
terraform import aws_simpledb_domain.users users
|
||||
```
|
@ -34,3 +34,10 @@ The following attributes are exported:
|
||||
* `id` - The ARN of the SNS topic
|
||||
* `arn` - The ARN of the SNS topic, as a more obvious property (clone of id)
|
||||
|
||||
## Import
|
||||
|
||||
SNS Topics can be imported using the `topic arn`, e.g.
|
||||
|
||||
```
|
||||
terraform import aws_sns_topic.user_updates arn:aws:sns:us-west-2:0123456789012:my-topic
|
||||
```
|
@ -96,3 +96,11 @@ The following attributes are exported:
|
||||
* `endpoint` - The full endpoint to send data to (SQS ARN, HTTP(S) URL, Application ARN, SMS number, etc.)
|
||||
* `arn` - The ARN of the subscription stored as a more user-friendly property
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
SNS Topic Subscriptions can be imported using the `subscription arn`, e.g.
|
||||
|
||||
```
|
||||
terraform import aws_sns_topic_subscription.user_updates_sqs_target arn:aws:sns:us-west-2:0123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f
|
||||
```
|
@ -40,3 +40,11 @@ The following attributes are exported:
|
||||
|
||||
* `id` - The URL for the created Amazon SQS queue.
|
||||
* `arn` - The ARN of the SQS queue
|
||||
|
||||
## Import
|
||||
|
||||
SQS Queues can be imported using the `queue url`, e.g.
|
||||
|
||||
```
|
||||
terraform import aws_sqs_queue.public_queue https://queue.amazonaws.com/80398EXAMPLE/MyQueue
|
||||
```
|
@ -44,3 +44,12 @@ The following attributes are exported:
|
||||
* `cidr_block` - The CIDR block for the subnet.
|
||||
* `vpc_id` - The VPC ID.
|
||||
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
Subnets can be imported using the `subnet id`, e.g.
|
||||
|
||||
```
|
||||
terraform import aws_subnet.public_subnet subnet-9d4a7b6c
|
||||
```
|
@ -64,3 +64,11 @@ The following attributes are exported:
|
||||
|
||||
|
||||
[1]: http://docs.aws.amazon.com/fr_fr/AWSEC2/latest/UserGuide/vpc-classiclink.html
|
||||
|
||||
## Import
|
||||
|
||||
VPNs can be imported using the `vpn id`, e.g.
|
||||
|
||||
```
|
||||
terraform import aws_vpn.test_vpn vpc-a01106c2
|
||||
```
|
@ -61,3 +61,12 @@ The following attributes are exported:
|
||||
|
||||
You can find more technical documentation about DHCP Options Set in the
|
||||
official [AWS User Guide](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html).
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
VPC DHCP Options can be imported using the `dhcp options id`, e.g.
|
||||
|
||||
```
|
||||
terraform import aws_vpc_dhcp_options.my_options dopt-d9070ebb
|
||||
```
|
@ -36,3 +36,12 @@ The following attributes are exported:
|
||||
|
||||
* `id` - The ID of the VPC endpoint.
|
||||
* `prefix_list_id` - The prefix list ID of the exposed service.
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
VPN Endpoints can be imported using the `vpc endpoint id`, e.g.
|
||||
|
||||
```
|
||||
terraform import aws_vpc_endpoint.endpoint1 vpce-3ecf2a57
|
||||
```
|
@ -66,3 +66,11 @@ The following attributes are exported:
|
||||
|
||||
## Notes
|
||||
If you are not the owner of both VPCs, or do not enable auto_accept you will still have to accept the peering with the AWS Console, aws-cli or aws-sdk-go.
|
||||
|
||||
## Import
|
||||
|
||||
VPC Peering resources can be imported using the `vpc peering id`, e.g.
|
||||
|
||||
```
|
||||
terraform import aws_vpc_peering_connection.test_connection pcx-111aaa111
|
||||
```
|
@ -61,3 +61,12 @@ The following attributes are exported:
|
||||
* `tunnel2_preshared_key` - The preshared key of the second VPN tunnel.
|
||||
* `type` - The type of VPN connection.
|
||||
* `vpn_gateway_id` - The ID of the virtual private gateway to which the connection is attached.
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
VPN Connections can be imported using the `vpn connection id`, e.g.
|
||||
|
||||
```
|
||||
terraform import aws_vpn_connection.testvpnconnection vpn-40f41529
|
||||
```
|
@ -36,3 +36,11 @@ The following attributes are exported:
|
||||
|
||||
* `id` - The ID of the VPN Gateway.
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
VPN Gateways can be imported using the `vpn gateway id`, e.g.
|
||||
|
||||
```
|
||||
terraform import aws_vpn_gateway.testvpngateway vgw-9a4cacf3
|
||||
```
|
@ -50,4 +50,13 @@ The following arguments are supported:
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The virtual AvailabilitySet ID.
|
||||
* `id` - The virtual AvailabilitySet ID.
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
Availability Sets can be imported using the `resource id`, e.g.
|
||||
|
||||
```
|
||||
terraform import azurerm_availability_set.group1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Compute/availabilitySets/webAvailSet
|
||||
```
|
||||
|
@ -39,3 +39,12 @@ The following attributes are exported:
|
||||
* `id` - The DNS Zone ID.
|
||||
* `max_number_of_record_sets` - (Optional) Maximum number of Records in the zone. Defaults to `1000`.
|
||||
* `number_of_record_sets` - (Optional) The number of records already in the zone.
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
DNS Zones can be imported using the `resource id`, e.g.
|
||||
|
||||
```
|
||||
terraform import azurerm_dns_zone.zone1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/dnsZones/zone1
|
||||
```
|
@ -46,3 +46,11 @@ The following arguments are supported:
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The local network gateway unique ID within Azure.
|
||||
|
||||
## Import
|
||||
|
||||
Local Network Gateways can be imported using the `resource id`, e.g.
|
||||
|
||||
```
|
||||
terraform import azurerm_local_network_gateway.lng1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/microsoft.network/localnetworkgateways/lng1
|
||||
```
|
||||
|
@ -88,3 +88,12 @@ The `security_rule` block supports:
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The Network Security Group ID.
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
Network Security Groups can be imported using the `resource id`, e.g.
|
||||
|
||||
```
|
||||
terraform import azurerm_network_security_group.group1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/networkSecurityGroups/mySecurityGroup
|
||||
```
|
||||
|
@ -72,4 +72,13 @@ The following arguments are supported:
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The Network Security Rule ID.
|
||||
* `id` - The Network Security Rule ID.
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
Network Security Rules can be imported using the `resource id`, e.g.
|
||||
|
||||
```
|
||||
terraform import azurerm_network_security_rule.rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/networkSecurityGroups/mySecurityGroup/securityRules/rule1
|
||||
```
|
@ -58,4 +58,13 @@ The following attributes are exported:
|
||||
|
||||
* `id` - The Public IP ID.
|
||||
* `ip_address` - The IP address value that was allocated.
|
||||
* `fqdn` - Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone
|
||||
* `fqdn` - Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
Public IPs can be imported using the `resource id`, e.g.
|
||||
|
||||
```
|
||||
terraform import azurerm_public_ip.myPublicIp /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/publicIPAddresses/myPublicIpAddress1
|
||||
```
|
@ -40,3 +40,12 @@ The following arguments are supported:
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The resource group ID.
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
Resource Groups can be imported using the `resource id`, e.g.
|
||||
|
||||
```
|
||||
terraform import azurerm_resource_group.mygroup /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup
|
||||
```
|
||||
|
@ -55,4 +55,13 @@ The following arguments are supported:
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The SQL Firewall Rule ID.
|
||||
* `id` - The SQL Firewall Rule ID.
|
||||
|
||||
## Import
|
||||
|
||||
SQL Firewall Rules can be imported using the `resource id`, e.g.
|
||||
|
||||
```
|
||||
terraform import azurerm_sql_firewall_rule.rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Sql/servers/myserver/firewallRules/rule1
|
||||
```
|
||||
|
||||
|
@ -72,3 +72,12 @@ The following attributes are exported in addition to the arguments listed above:
|
||||
* `primary_file_endpoint` - The endpoint URL for file storage in the primary location.
|
||||
* `primary_access_key` - The primary access key for the storage account
|
||||
* `secondary_access_key` - The secondary access key for the storage account
|
||||
|
||||
## Import
|
||||
|
||||
Virtual Networks can be imported using the `resource id`, e.g.
|
||||
|
||||
```
|
||||
terraform import azurerm_storage_account.storageAcc1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount
|
||||
```
|
||||
|
||||
|
@ -80,3 +80,12 @@ The `subnet` block supports:
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The virtual NetworkConfiguration ID.
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
Virtual Networks can be imported using the `resource id`, e.g.
|
||||
|
||||
```
|
||||
terraform import azurerm_virtual_network.testNetwork /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/virtualNetworks/myvnet1
|
||||
```
|
@ -35,3 +35,12 @@ The following attributes are exported:
|
||||
|
||||
* `id` - The name of the domain
|
||||
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
Domains can be imported using the `domain name`, e.g.
|
||||
|
||||
```
|
||||
terraform import digitalocean_domain.mydomain mytestdomain.com
|
||||
```
|
@ -70,3 +70,11 @@ The following attributes are exported:
|
||||
* `status` - The status of the droplet
|
||||
* `tags` - The tags associated with the droplet
|
||||
* `volume_ids` - A list of the attached block storage volumes
|
||||
|
||||
## Import
|
||||
|
||||
Droplets can be imported using the droplet `id`, e.g.
|
||||
|
||||
```
|
||||
terraform import digitalocean_droplet.mydroplet 100823
|
||||
```
|
||||
|
@ -42,3 +42,11 @@ The following arguments are supported:
|
||||
The following attributes are exported:
|
||||
|
||||
* `ip_address` - The IP Address of the resource
|
||||
|
||||
## Import
|
||||
|
||||
Floating IPs can be imported using the `ip`, e.g.
|
||||
|
||||
```
|
||||
terraform import digitalocean_floating_ip.myip 192.168.0.1
|
||||
```
|
@ -39,3 +39,11 @@ The following attributes are exported:
|
||||
* `name` - The name of the SSH key
|
||||
* `public_key` - The text of the public key
|
||||
* `fingerprint` - The fingerprint of the SSH key
|
||||
|
||||
## Import
|
||||
|
||||
SSH Keys can be imported using the `ssh key id`, e.g.
|
||||
|
||||
```
|
||||
terraform import digitalocean_ssh_key.mykey 263654
|
||||
```
|
@ -43,3 +43,12 @@ The following attributes are exported:
|
||||
|
||||
* `id` - The name of the tag
|
||||
* `name` - The name of the tag
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
Tags can be imported using the `name`, e.g.
|
||||
|
||||
```
|
||||
terraform import digitalocean_tag.mytag tagname
|
||||
```
|
@ -42,4 +42,13 @@ The following arguments are supported:
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The unique identifier for the block storage volume.
|
||||
* `id` - The unique identifier for the block storage volume.
|
||||
|
||||
|
||||
## Import
|
||||
|
||||
Volumes can be imported using the `volume id`, e.g.
|
||||
|
||||
```
|
||||
terraform import digitalocean_volume.volumea 506f78a4-e098-11e5-ad9f-000f53306ae1
|
||||
```
|
Loading…
Reference in New Issue
Block a user