Skip to content

Commit

Permalink
Merge pull request hashicorp#1736 from quixoticmonk/d-improve-awscc_n…
Browse files Browse the repository at this point in the history
…eptune_db_cluster

docs: added example for awscc_neptune_db_cluster
  • Loading branch information
marcosentino authored Jul 8, 2024
2 parents f3d3e10 + 702ad12 commit 90ad144
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 2 deletions.
28 changes: 26 additions & 2 deletions docs/resources/neptune_db_cluster.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_neptune_db_cluster Resource - terraform-provider-awscc"
subcategory: ""
description: |-
Expand All @@ -10,7 +9,32 @@ description: |-

The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.


## Example Usage

### Create a Neptune DB cluster. If no subnet group is specified, a default subnet group is created.

```terraform
resource "awscc_neptune_db_cluster" "default" {
db_cluster_identifier = "example"
backup_retention_period = 5
preferred_backup_window = "07:00-09:00"
iam_auth_enabled = true
db_port = 8182
copy_tags_to_snapshot = true
enable_cloudwatch_logs_exports = ["audit"]
engine_version = "1.3.1.0"
preferred_maintenance_window = "sun:10:00-sun:10:30"
storage_encrypted = true
# Use ARN from awscc_kms_key to avoid drift due to short id
# Reference : https://github.com/hashicorp/terraform-provider-awscc/issues/1735
kms_key_id = awscc_kms_key.example.arn
tags = [{
key = "Modified By"
value = "AWSCC"
}]
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
20 changes: 20 additions & 0 deletions examples/resources/awscc_neptune_db_cluster/neptune_db_cluster.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
resource "awscc_neptune_db_cluster" "default" {
db_cluster_identifier = "example"
backup_retention_period = 5
preferred_backup_window = "07:00-09:00"
iam_auth_enabled = true
db_port = 8182
copy_tags_to_snapshot = true
enable_cloudwatch_logs_exports = ["audit"]
engine_version = "1.3.1.0"
preferred_maintenance_window = "sun:10:00-sun:10:30"
storage_encrypted = true
# Use ARN from awscc_kms_key to avoid drift due to short id
# Reference : https://github.com/hashicorp/terraform-provider-awscc/issues/1735
kms_key_id = awscc_kms_key.example.arn

tags = [{
key = "Modified By"
value = "AWSCC"
}]
}
27 changes: 27 additions & 0 deletions templates/resources/neptune_db_cluster.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: ""
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

{{ .Description | trimspace }}

## Example Usage

### Create a Neptune DB cluster. If no subnet group is specified, a default subnet group is created.

{{ tffile (printf "examples/resources/%s/neptune_db_cluster.tf" .Name)}}

{{ .SchemaMarkdown | trimspace }}
{{- if .HasImport }}

## Import

Import is supported using the following syntax:

{{ codefile "shell" .ImportFile }}

{{- end }}

0 comments on commit 90ad144

Please sign in to comment.