Skip to content

Commit 6a5c3c2

Browse files
joescharfjoescharf
committed
generate docs
1 parent 4fcc1cd commit 6a5c3c2

File tree

5 files changed

+88
-10
lines changed

5 files changed

+88
-10
lines changed

‎docs/data-sources/targets.md

+23
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,40 @@ Optional:
4848
<a id="nestedatt--targets--sanitize"></a>
4949
### Nested Schema for `targets.sanitize`
5050

51+
Optional:
52+
53+
- `storage_profile` (Attributes) Storage provider configuration for Sanitized Snapshots (see [below for nested schema](#nestedatt--targets--sanitize--storage_profile))
54+
5155
Read-Only:
5256

5357
- `dst_url` (String) The destination URL of the database used to sanitizea snapshot
5458
- `query` (String) The query used to sanitize the snapshot
5559

60+
<a id="nestedatt--targets--sanitize--storage_profile"></a>
61+
### Nested Schema for `targets.sanitize.storage_profile`
62+
63+
Optional:
64+
65+
- `id` (String) The unique identifier for the storage profile
66+
67+
5668

5769
<a id="nestedatt--targets--snapshot"></a>
5870
### Nested Schema for `targets.snapshot`
5971

72+
Optional:
73+
74+
- `storage_profile` (Attributes) Storage provider configuration for Snapshots (see [below for nested schema](#nestedatt--targets--snapshot--storage_profile))
75+
6076
Read-Only:
6177

6278
- `dst_url` (String) The destination URL for the target snapshot (will be overwritten)
6379
- `src_bytes` (Number) The size of the source database in bytes
6480
- `src_url` (String) The source URL for the target snapshot
81+
82+
<a id="nestedatt--targets--snapshot--storage_profile"></a>
83+
### Nested Schema for `targets.snapshot.storage_profile`
84+
85+
Optional:
86+
87+
- `id` (String) The unique identifier for the storage profile

‎docs/resources/storage_profile.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "dbsnapper_storage_profile Resource - dbsnapper"
4+
subcategory: ""
5+
description: |-
6+
Storage Profile resource
7+
---
8+
9+
# dbsnapper_storage_profile (Resource)
10+
11+
Storage Profile resource
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `access_key` (String, Sensitive) The access key of the storage profile
21+
- `bucket` (String) The bucket of the storage profile
22+
- `name` (String) The name of the storage profile
23+
- `secret_key` (String, Sensitive) The secret key of the storage profile
24+
- `sp_provider` (String) The provider for the storage profile, one of the following: ['s3', 'r2']
25+
26+
### Optional
27+
28+
- `account_id` (String) The account ID at the storage provider - Required for Cloudflare
29+
- `prefix` (String) The prefix of the storage profile
30+
- `region` (String) The region of the storage profile
31+
32+
### Read-Only
33+
34+
- `created_at` (String) The time the storage profile was created
35+
- `id` (String) The unique identifier for the storage profile
36+
- `status` (String) The status of the storage profile
37+
- `updated_at` (String) The time the storage profile was last updated

‎docs/resources/target.md

+18
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,20 @@ Required:
4343
Optional:
4444

4545
- `dst_url` (String) The destination URL for the target snapshot (will be overwritten)
46+
- `storage_profile` (Attributes) Storage provider configuration for Snapshots (see [below for nested schema](#nestedatt--snapshot--storage_profile))
4647

4748
Read-Only:
4849

4950
- `src_bytes` (Number) The size of the source database in bytes
5051

52+
<a id="nestedatt--snapshot--storage_profile"></a>
53+
### Nested Schema for `snapshot.storage_profile`
54+
55+
Optional:
56+
57+
- `id` (String) The unique identifier for the storage profile
58+
59+
5160

5261
<a id="nestedatt--sanitize"></a>
5362
### Nested Schema for `sanitize`
@@ -56,6 +65,15 @@ Optional:
5665

5766
- `dst_url` (String) The destination URL of the database used to sanitizea snapshot
5867
- `query` (String) The query used to sanitize the snapshot
68+
- `storage_profile` (Attributes) Storage provider configuration for Sanitized Snapshots (see [below for nested schema](#nestedatt--sanitize--storage_profile))
69+
70+
<a id="nestedatt--sanitize--storage_profile"></a>
71+
### Nested Schema for `sanitize.storage_profile`
72+
73+
Optional:
74+
75+
- `id` (String) The unique identifier for the storage profile
76+
5977

6078

6179
<a id="nestedatt--share"></a>

‎examples/resources/storage_profile/resource.tf

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
resource "dbsnapper_storage_profile" "tf_sp_example" {
2-
name = "tf_sp_example"
2+
name = "tf_sp_example"
33
sp_provider = "s3" # s3, r2
44

5-
region = "us-east-1"
5+
region = "us-east-1"
66
account_id = "" # for cloudflare
7-
7+
88
access_key = "AKIAxxxxxxxxxxxx"
99
secret_key = "xxxxxxxxxxxxxxxxxxxx"
1010

‎examples/resources/target_with_storage_profile/resource.tf

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
resource "dbsnapper_storage_profile" "tfex" {
2-
name = "tf_sp_tfex"
2+
name = "tf_sp_tfex"
33
sp_provider = "s3"
4-
region = "us-east-1"
5-
account_id = ""
6-
access_key = "AKIAxxxxxxxx"
7-
secret_key = "xxxxxxxxxxxxxxxxxxxx"
8-
bucket = "dbsnapper-test-s3"
9-
prefix = "terraform"
4+
region = "us-east-1"
5+
account_id = ""
6+
access_key = "AKIAxxxxxxxx"
7+
secret_key = "xxxxxxxxxxxxxxxxxxxx"
8+
bucket = "dbsnapper-test-s3"
9+
prefix = "terraform"
1010
}
1111

1212
resource "dbsnapper_target" "tfex" {

0 commit comments

Comments
 (0)