Skip to content

Commit

Permalink
[Object Storage] update: docs for resource and data source tf
Browse files Browse the repository at this point in the history
[Object Storage] update: docs for resource and data source tf
  • Loading branch information
hoanglm committed Nov 18, 2024
1 parent 92b2df3 commit f0d4ee9
Show file tree
Hide file tree
Showing 21 changed files with 777 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/data-sources/object_storage_access_key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "fptcloud_object_storage_access_key Data Source - terraform-provider-fptcloud"
subcategory: ""
description: |-
---

# fptcloud_object_storage_access_key (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `region_name` (String) The region name that's are the same with the region name in the S3 service. Currently, we have: HCM-01, HCM-02, HN-01, HN-02
- `vpc_id` (String)

### Read-Only

- `credentials` (List of Object) (see [below for nested schema](#nestedatt--credentials))
- `id` (String) The ID of this resource.

<a id="nestedatt--credentials"></a>
### Nested Schema for `credentials`

Read-Only:

- `access_key` (String)
- `active` (Boolean)
43 changes: 43 additions & 0 deletions docs/data-sources/object_storage_bucket.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "fptcloud_object_storage_bucket Data Source - terraform-provider-fptcloud"
subcategory: ""
description: |-
---

# fptcloud_object_storage_bucket (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `region_name` (String) The region name that's are the same with the region name in the S3 service. Currently, we have: HCM-01, HCM-02, HN-01, HN-02
- `vpc_id` (String) The VPC ID

### Optional

- `page` (Number) Page number
- `page_size` (Number) Number of items per page

### Read-Only

- `id` (String) The ID of this resource.
- `list_bucket_result` (List of Object) (see [below for nested schema](#nestedatt--list_bucket_result))

<a id="nestedatt--list_bucket_result"></a>
### Nested Schema for `list_bucket_result`

Read-Only:

- `bucket_name` (String)
- `creation_date` (String)
- `endpoint` (String)
- `is_empty` (Boolean)
- `is_enabled_logging` (Boolean)
- `s3_service_id` (String)
64 changes: 64 additions & 0 deletions docs/data-sources/object_storage_bucket_acl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "fptcloud_object_storage_bucket_acl Data Source - terraform-provider-fptcloud"
subcategory: ""
description: |-
---

# fptcloud_object_storage_bucket_acl (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `bucket_name` (String) Name of the bucket to config the ACL
- `region_name` (String) The region name that's are the same with the region name in the S3 service. Currently, we have: HCM-01, HCM-02, HN-01, HN-02
- `vpc_id` (String) The VPC ID

### Read-Only

- `bucket_acl` (List of Object) (see [below for nested schema](#nestedatt--bucket_acl))
- `canned_acl` (String) The Access Control List (ACL) status of the bucket which can be one of the following values: private, public-read, default is private
- `id` (String) The ID of this resource.
- `status` (Boolean) The status after configuring the bucket ACL

<a id="nestedatt--bucket_acl"></a>
### Nested Schema for `bucket_acl`

Read-Only:

- `grants` (List of Object) (see [below for nested schema](#nestedobjatt--bucket_acl--grants))
- `owner` (List of Object) (see [below for nested schema](#nestedobjatt--bucket_acl--owner))

<a id="nestedobjatt--bucket_acl--grants"></a>
### Nested Schema for `bucket_acl.grants`

Read-Only:

- `grantee` (List of Object) (see [below for nested schema](#nestedobjatt--bucket_acl--grants--grantee))
- `permission` (String)

<a id="nestedobjatt--bucket_acl--grants--grantee"></a>
### Nested Schema for `bucket_acl.grants.grantee`

Read-Only:

- `display_name` (String)
- `id` (String)
- `type` (String)



<a id="nestedobjatt--bucket_acl--owner"></a>
### Nested Schema for `bucket_acl.owner`

Read-Only:

- `display_name` (String)
- `id` (String)
44 changes: 44 additions & 0 deletions docs/data-sources/object_storage_bucket_cors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "fptcloud_object_storage_bucket_cors Data Source - terraform-provider-fptcloud"
subcategory: ""
description: |-
---

# fptcloud_object_storage_bucket_cors (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `bucket_name` (String) Name of the bucket
- `region_name` (String) The region name that's are the same with the region name in the S3 service. Currently, we have: HCM-01, HCM-02, HN-01, HN-02
- `vpc_id` (String) The VPC ID

### Optional

- `page` (Number) The page number
- `page_size` (Number) The number of items to return in each page

### Read-Only

- `cors_rule` (List of Object) The bucket cors rule (see [below for nested schema](#nestedatt--cors_rule))
- `id` (String) The ID of this resource.

<a id="nestedatt--cors_rule"></a>
### Nested Schema for `cors_rule`

Read-Only:

- `allowed_headers` (List of String)
- `allowed_methods` (List of String)
- `allowed_origins` (List of String)
- `expose_headers` (List of String)
- `id` (String)
- `max_age_seconds` (Number)
77 changes: 77 additions & 0 deletions docs/data-sources/object_storage_bucket_lifecycle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "fptcloud_object_storage_bucket_lifecycle Data Source - terraform-provider-fptcloud"
subcategory: ""
description: |-
---

# fptcloud_object_storage_bucket_lifecycle (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `bucket_name` (String) Name of the bucket to fetch policy for
- `region_name` (String) The region name that's are the same with the region name in the S3 service. Currently, we have: HCM-01, HCM-02, HN-01, HN-02
- `vpc_id` (String) The VPC ID

### Optional

- `page` (Number) The page number
- `page_size` (Number) The number of items to return in each page

### Read-Only

- `id` (String) The ID of this resource.
- `life_cycle_rules` (List of Object) (see [below for nested schema](#nestedatt--life_cycle_rules))

<a id="nestedatt--life_cycle_rules"></a>
### Nested Schema for `life_cycle_rules`

Read-Only:

- `abort_incomplete_multipart_upload` (List of Object) (see [below for nested schema](#nestedobjatt--life_cycle_rules--abort_incomplete_multipart_upload))
- `expiration` (List of Object) (see [below for nested schema](#nestedobjatt--life_cycle_rules--expiration))
- `filter` (List of Object) (see [below for nested schema](#nestedobjatt--life_cycle_rules--filter))
- `id` (String)
- `noncurrent_version_expiration` (List of Object) (see [below for nested schema](#nestedobjatt--life_cycle_rules--noncurrent_version_expiration))
- `prefix` (String)
- `status` (String)

<a id="nestedobjatt--life_cycle_rules--abort_incomplete_multipart_upload"></a>
### Nested Schema for `life_cycle_rules.abort_incomplete_multipart_upload`

Read-Only:

- `days_after_initiation` (Number)


<a id="nestedobjatt--life_cycle_rules--expiration"></a>
### Nested Schema for `life_cycle_rules.expiration`

Read-Only:

- `days` (Number)
- `expired_object_delete_marker` (Boolean)


<a id="nestedobjatt--life_cycle_rules--filter"></a>
### Nested Schema for `life_cycle_rules.filter`

Read-Only:

- `prefix` (String)


<a id="nestedobjatt--life_cycle_rules--noncurrent_version_expiration"></a>
### Nested Schema for `life_cycle_rules.noncurrent_version_expiration`

Read-Only:

- `noncurrent_days` (Number)
27 changes: 27 additions & 0 deletions docs/data-sources/object_storage_bucket_policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "fptcloud_object_storage_bucket_policy Data Source - terraform-provider-fptcloud"
subcategory: ""
description: |-
---

# fptcloud_object_storage_bucket_policy (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `bucket_name` (String) Name of the bucket to fetch policy for
- `region_name` (String) The region name that's are the same with the region name in the S3 service. Currently, we have: HCM-01, HCM-02, HN-01, HN-02
- `vpc_id` (String) The VPC ID

### Read-Only

- `id` (String) The ID of this resource.
- `policy` (String) The bucket policy in JSON format
31 changes: 31 additions & 0 deletions docs/data-sources/object_storage_bucket_static_website.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "fptcloud_object_storage_bucket_static_website Data Source - terraform-provider-fptcloud"
subcategory: ""
description: |-
---

# fptcloud_object_storage_bucket_static_website (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `bucket_name` (String) Name of the bucket to fetch policy for
- `region_name` (String) The region name that's are the same with the region name in the S3 service. Currently, we have: HCM-01, HCM-02, HN-01, HN-02
- `vpc_id` (String) The VPC ID

### Optional

- `error_document_key` (String)
- `index_document_suffix` (String)

### Read-Only

- `id` (String) The ID of this resource.
30 changes: 30 additions & 0 deletions docs/data-sources/object_storage_bucket_versioning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "fptcloud_object_storage_bucket_versioning Data Source - terraform-provider-fptcloud"
subcategory: ""
description: |-
---

# fptcloud_object_storage_bucket_versioning (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `bucket_name` (String) Name of the bucket
- `region_name` (String) The region name that's are the same with the region name in the S3 service. Currently, we have: HCM-01, HCM-02, HN-01, HN-02
- `vpc_id` (String) The VPC ID

### Optional

- `versioning_status` (String) Status of the versioning, must be Enabled or Suspended

### Read-Only

- `id` (String) The ID of this resource.
41 changes: 41 additions & 0 deletions docs/data-sources/object_storage_sub_user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "fptcloud_object_storage_sub_user Data Source - terraform-provider-fptcloud"
subcategory: ""
description: |-
---

# fptcloud_object_storage_sub_user (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `region_name` (String) The region name that's are the same with the region name in the S3 service. Currently, we have: HCM-01, HCM-02, HN-01, HN-02
- `vpc_id` (String) The VPC ID

### Optional

- `page` (Number) Page number
- `page_size` (Number) Number of items per page

### Read-Only

- `id` (String) The ID of this resource.
- `list_sub_user` (List of Object) List of sub-users (see [below for nested schema](#nestedatt--list_sub_user))

<a id="nestedatt--list_sub_user"></a>
### Nested Schema for `list_sub_user`

Read-Only:

- `active` (Boolean)
- `arn` (String)
- `role` (String)
- `user_id` (String)
Loading

0 comments on commit f0d4ee9

Please sign in to comment.