-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #480 from instaclustr/terraform-jenkins-branch-202…
…4-11-22T102410Z terraform-jenkins-branch-2024-11-22T102410Z
- Loading branch information
Showing
3 changed files
with
100 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
40 changes: 40 additions & 0 deletions
40
docs/data-sources/clickhouse_integration_s3_v2_instance.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
page_title: "instaclustr_clickhouse_integration_s3_v2_instance Data Source - terraform-provider-instaclustr" | ||
subcategory: "" | ||
description: |- | ||
--- | ||
|
||
# instaclustr_clickhouse_integration_s3_v2_instance (Data Source) | ||
ClickHouse Integration With S3 - Enables Access | ||
## Example Usage | ||
``` | ||
data "instaclustr_clickhouse_integration_s3_v2_instance" "example" { | ||
id = "<id>" // the value of the `id` attribute defined in the root schema below | ||
} | ||
``` | ||
## Glossary | ||
The following terms are used to describe attributes in the schema of this data source: | ||
- **_read-only_** - These are attributes that can only be read and not provided as an input to the data source. | ||
- **_required_** - These attributes must be provided for the data source's information to be queried. | ||
- **_nested block_** - These attributes use the [Terraform block syntax](https://www.terraform.io/language/attr-as-blocks) when defined as an input in the Terraform code. Attributes with the type **_repeatable nested block_** are the same except that the nested block can be defined multiple times with varying nested attributes. When reading nested block attributes, an index must be provided when accessing the contents of the nested block, example - `my_resource.nested_block_attribute[0].nested_attribute`. | ||
## Root Level Schema | ||
### Read-only attributes | ||
*___region___*<br> | ||
<ins>Type</ins>: list of objects, read-only<br> | ||
<br>List of S3 regions to integrate with<br><br> | ||
*___id___*<br> | ||
<ins>Type</ins>: string, read-only<br> | ||
<br>ID of the S3 Integration<br><br> | ||
*___cluster_id___*<br> | ||
<ins>Type</ins>: string, read-only<br> | ||
<br>ID of the ClickHouse cluster<br><br> | ||
<a id="nested--region"></a> | ||
## Nested schema for `region` | ||
List of S3 regions to integrate with<br> | ||
### Read-only attributes | ||
*___status___*<br> | ||
<ins>Type</ins>: string, read-only<br> | ||
<br>Status of the S3 Integration<br><br> | ||
*___target___*<br> | ||
<ins>Type</ins>: string, read-only<br> | ||
<br>Target region for the S3 Integration (or 'ALL_REGIONS' for all regions)<br><br> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
page_title: "instaclustr_clickhouse_integration_s3_v2 Resource - terraform-provider-instaclustr" | ||
subcategory: "" | ||
description: |- | ||
--- | ||
|
||
# instaclustr_clickhouse_integration_s3_v2 (Resource) | ||
ClickHouse Integration With S3 - Enables Access | ||
## Example Usage | ||
``` | ||
resource "instaclustr_clickhouse_integration_s3_v2" "example" { | ||
region { | ||
target = "US-EAST-1" | ||
} | ||
region { | ||
target = "US-WEST-1" | ||
} | ||
cluster_id = "71e4380e-32ac-4fa7-ab42-c165fe35aa55" | ||
} | ||
``` | ||
## Glossary | ||
The following terms are used to describe attributes in the schema of this resource: | ||
- **_read-only_** - These are attributes that can only be read and not provided as an input to the resource. | ||
- **_required_** - These attributes must be provided for the resource to be created. | ||
- **_optional_** - These input attributes can be omitted, and doing so may result in a default value being used. | ||
- **_immutable_** - These are input attributes that cannot be changed after the resource is created. | ||
- **_updatable_** - These input attributes can be updated to a different value if needed, and doing so will trigger an update operation. | ||
- **_nested block_** - These attributes use the [Terraform block syntax](https://www.terraform.io/language/attr-as-blocks) when defined as an input in the Terraform code. Attributes with the type **_repeatable nested block_** are the same except that the nested block can be defined multiple times with varying nested attributes. When reading nested block attributes, an index must be provided when accessing the contents of the nested block, example - `my_resource.nested_block_attribute[0].nested_attribute`. | ||
## Root Level Schema | ||
### Input attributes - Optional | ||
*___region___*<br> | ||
<ins>Type</ins>: list of objects, optional, updatable<br> | ||
<br>List of S3 regions to integrate with<br><br> | ||
*___cluster_id___*<br> | ||
<ins>Type</ins>: string, optional, updatable<br> | ||
<br>ID of the ClickHouse cluster<br><br> | ||
### Read-only attributes | ||
*___id___*<br> | ||
<ins>Type</ins>: string, read-only<br> | ||
<br>ID of the S3 Integration<br><br> | ||
<a id="nested--region"></a> | ||
## Nested schema for `region` | ||
List of S3 regions to integrate with<br> | ||
### Input attributes - Required | ||
*___target___*<br> | ||
<ins>Type</ins>: string, required, updatable<br> | ||
<br>Target region for the S3 Integration (or 'ALL_REGIONS' for all regions)<br><br> | ||
### Read-only attributes | ||
*___status___*<br> | ||
<ins>Type</ins>: string, read-only<br> | ||
<br>Status of the S3 Integration<br><br> | ||
## Import | ||
This resource can be imported using the `terraform import` command as follows: | ||
``` | ||
terraform import instaclustr_clickhouse_integration_s3_v2.[resource-name] "[resource-id]" | ||
``` | ||
`[resource-id]` is the unique identifier for this resource matching the value of the `id` attribute defined in the root schema above. |