Skip to content

Commit 1752a7c

Browse files
chore(docs): update documentation for #16 (#18)
Co-authored-by: kangasta <[email protected]>
1 parent 7cc20fa commit 1752a7c

File tree

2 files changed

+59
-2
lines changed

2 files changed

+59
-2
lines changed

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "objsto Provider"
44
subcategory: ""
55
description: |-
6-
The objsto provider is used to manage S3 compatible object storage services such as UpCloud Managed Object Storage https://upcloud.com/products/object-storage.
6+
The objsto provider is used to manage S3 compatible object storage services such as UpCloud Managed Object Storage https://upcloud.com/products/object-storage. The provider manages the resources using the S3 API of the target object storage service.
77
---
88

99
# objsto Provider
1010

11-
The `objsto` provider is used to manage S3 compatible object storage services such as [UpCloud Managed Object Storage](https://upcloud.com/products/object-storage).
11+
The `objsto` provider is used to manage S3 compatible object storage services such as [UpCloud Managed Object Storage](https://upcloud.com/products/object-storage). The provider manages the resources using the S3 API of the target object storage service.
1212

1313
## Example Usage
1414

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "objsto_bucket_cors_configuration Resource - objsto"
4+
subcategory: ""
5+
description: |-
6+
A bucket CORS configuration resource. Note that there can only be one CORS configuration per bucket.
7+
---
8+
9+
# objsto_bucket_cors_configuration (Resource)
10+
11+
A bucket CORS configuration resource. Note that there can only be one CORS configuration per bucket.
12+
13+
## Example Usage
14+
15+
```terraform
16+
resource "objsto_bucket" "example" {
17+
bucket = "example"
18+
}
19+
20+
resource "objsto_bucket_cors_configuration" "this" {
21+
bucket = objsto_bucket.example.bucket
22+
23+
cors_rule {
24+
allowed_headers = ["*"]
25+
allowed_methods = ["GET", "HEAD", "DELETE", "PUT", "POST"]
26+
allowed_origins = ["*"]
27+
expose_headers = ["x-amz-server-side-encryption"]
28+
max_age_seconds = 3000
29+
}
30+
}
31+
```
32+
33+
<!-- schema generated by tfplugindocs -->
34+
## Schema
35+
36+
### Required Attributes
37+
38+
- `bucket` (String) The name of the bucket for which to configure the CORS.
39+
40+
### Blocks
41+
42+
- `cors_rule` (Block List) A CORS rule to apply to the bucket. (see [below for nested schema](#nestedblock--cors_rule))
43+
44+
<a id="nestedblock--cors_rule"></a>
45+
### Nested Schema for `cors_rule`
46+
47+
Required Attributes:
48+
49+
- `allowed_methods` (Set of String) The allowed HTTP methods for this rule.
50+
- `allowed_origins` (Set of String) The allowed origins for this rule.
51+
52+
Optional Attributes:
53+
54+
- `allowed_headers` (Set of String) The headers to include in `Access-Control-Request-Headers` header.
55+
- `expose_headers` (Set of String) The headers to include in the `Access-Control-Expose-Headers` header.
56+
- `id` (String) The identifier of the rule.
57+
- `max_age_seconds` (Number) The cache time in seconds.

0 commit comments

Comments
 (0)