diff --git a/README.md b/README.md index f96f6e8..5fc774e 100644 --- a/README.md +++ b/README.md @@ -118,139 +118,6 @@ module "neptune" { ## Requirements -| Name | Version | -| ------------------------------------------------------------------------- | ------- | -| [terraform](#requirement\_terraform) | >= 1.0 | -| [aws](#requirement\_aws) | >= 5.25 | - -## Providers - -| Name | Version | -| ------------------------------------------------- | ------- | -| [aws](#provider\_aws) | >= 5.25 | - -## Modules - -No modules. - -## Resources - -| Name | Type | -| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | -| [aws_iam_role_policy_attachment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | -| [aws_neptune_cluster.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/neptune_cluster) | resource | -| [aws_neptune_cluster_endpoint.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/neptune_cluster_endpoint) | resource | -| [aws_neptune_cluster_instance.primary](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/neptune_cluster_instance) | resource | -| [aws_neptune_cluster_instance.read_replicas](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/neptune_cluster_instance) | resource | -| [aws_neptune_cluster_parameter_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/neptune_cluster_parameter_group) | resource | -| [aws_neptune_cluster_snapshot.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/neptune_cluster_snapshot) | resource | -| [aws_neptune_event_subscription.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/neptune_event_subscription) | resource | -| [aws_neptune_global_cluster.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/neptune_global_cluster) | resource | -| [aws_neptune_parameter_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/neptune_parameter_group) | resource | -| [aws_neptune_subnet_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/neptune_subnet_group) | resource | -| [aws_security_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | -| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source | -| [aws_iam_policy_document.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | -| [aws_partition.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/partition) | data source | -| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source | - -## Inputs - -| Name | Description | Type | Default | Required | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | :------: | -| [allow\_major\_version\_upgrade](#input\_allow\_major\_version\_upgrade) | (Optional) Specifies whether upgrades between different major versions are allowed. You must set it to true when providing an engine\_version parameter that uses a different major version than the DB cluster's current version. | `bool` | `false` | no | -| [apply\_immediately](#input\_apply\_immediately) | Specifies whether cluster modifications are applied immediately | `bool` | `true` | no | -| [availability\_zones](#input\_availability\_zones) | (Optional) A list of EC2 Availability Zones that instances in the Neptune cluster can be created in. | `list(string)` | `null` | no | -| [backup\_retention\_period](#input\_backup\_retention\_period) | The number of days to retain backups for | `number` | `7` | no | -| [cluster\_identifier](#input\_cluster\_identifier) | The cluster identifier | `string` | n/a | yes | -| [cluster\_identifier\_prefix](#input\_cluster\_identifier\_prefix) | (Optional) Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster\_identifier. | `string` | `null` | no | -| [copy\_tags\_to\_snapshot](#input\_copy\_tags\_to\_snapshot) | (Optional) If set to true, tags are copied to any snapshot of the DB cluster that is created. | `bool` | `null` | no | -| [create\_neptune\_cluster](#input\_create\_neptune\_cluster) | Whether or not to create a Neptune cluster | `bool` | `true` | no | -| [create\_neptune\_cluster\_endpoint](#input\_create\_neptune\_cluster\_endpoint) | Whether or not to create Neptune cluster endpoints. | `bool` | `false` | no | -| [create\_neptune\_cluster\_parameter\_group](#input\_create\_neptune\_cluster\_parameter\_group) | Whether or not to create a Neptune cluster parameter group | `bool` | `true` | no | -| [create\_neptune\_cluster\_snapshot](#input\_create\_neptune\_cluster\_snapshot) | Whether or not to create a Neptune cluster snapshot | `bool` | `true` | no | -| [create\_neptune\_global\_cluster](#input\_create\_neptune\_global\_cluster) | Whether or not to create a Neptune global cluster | `bool` | `false` | no | -| [create\_neptune\_iam\_role](#input\_create\_neptune\_iam\_role) | Whether or not to create and attach a Neptune IAM role | `bool` | `true` | no | -| [create\_neptune\_instance](#input\_create\_neptune\_instance) | Whether or not to create Neptune instances | `bool` | `true` | no | -| [create\_neptune\_parameter\_group](#input\_create\_neptune\_parameter\_group) | Whether or not to create a Neptune DB parameter group | `bool` | `true` | no | -| [create\_neptune\_security\_group](#input\_create\_neptune\_security\_group) | Whether or not to create a Neptune security group | `bool` | `true` | no | -| [create\_neptune\_subnet\_group](#input\_create\_neptune\_subnet\_group) | Whether or not to create a Neptune subnet group | `bool` | `true` | no | -| [create\_timeout](#input\_create\_timeout) | Timeout for creating the Neptune cluster snapshot | `string` | `"20m"` | no | -| [db\_cluster\_identifier](#input\_db\_cluster\_identifier) | The DB Cluster Identifier from which to take the snapshot | `string` | `null` | no | -| [db\_cluster\_snapshot\_identifier](#input\_db\_cluster\_snapshot\_identifier) | The Identifier for the snapshot | `string` | `null` | no | -| [deletion\_protection](#input\_deletion\_protection) | (Optional) A value that indicates whether the DB cluster has deletion protection enabled | `bool` | `false` | no | -| [enable\_cloudwatch\_logs\_exports](#input\_enable\_cloudwatch\_logs\_exports) | (Optional) A list of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports `audit` and `slowquery`. | `list(string)` | `null` | no | -| [enable\_serverless](#input\_enable\_serverless) | Whether or not to create a Serverless Neptune cluster | `bool` | `true` | no | -| [engine\_version](#input\_engine\_version) | The database engine version | `string` | `"1.2.0.1"` | no | -| [event\_subscriptions](#input\_event\_subscriptions) | Map of Neptune event subscriptions with names and SNS topic ARNs

Example:
{
"subscription1" = "arn:aws:sns:us-east-1:123456789012:topic1",
"subscription2" = "arn:aws:sns:us-east-1:123456789012:topic2"
} | `map(string)` | `null` | no | -| [final\_snapshot\_identifier](#input\_final\_snapshot\_identifier) | (Optional) The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made. | `string` | `null` | no | -| [global\_cluster\_deletion\_protection](#input\_global\_cluster\_deletion\_protection) | (Optional) Whether or not the global cluster should have deletion protection enabled. Default: false. | `bool` | `false` | no | -| [global\_cluster\_engine](#input\_global\_cluster\_engine) | (Optional) Name of the database engine to be used for the global cluster. Valid values: neptune. | `string` | `null` | no | -| [global\_cluster\_engine\_version](#input\_global\_cluster\_engine\_version) | (Optional) Engine version of the global database. Must be compatible with Neptune global cluster versions. | `string` | `null` | no | -| [global\_cluster\_identifier](#input\_global\_cluster\_identifier) | (Optional) The global cluster identifier specified on aws\_neptune\_global\_cluster. | `string` | `null` | no | -| [global\_cluster\_source\_db\_cluster\_identifier](#input\_global\_cluster\_source\_db\_cluster\_identifier) | (Optional) ARN of a Neptune DB Cluster to use as the primary DB cluster of the global cluster. | `string` | `null` | no | -| [global\_cluster\_storage\_encrypted](#input\_global\_cluster\_storage\_encrypted) | (Optional) Specifies whether the global cluster is encrypted. The default is false unless the source DB cluster is encrypted. | `bool` | `null` | no | -| [iam\_database\_authentication\_enabled](#input\_iam\_database\_authentication\_enabled) | Specifies whether IAM database authentication is enabled | `bool` | `true` | no | -| [iam\_roles](#input\_iam\_roles) | (Optional) A List of ARNs for the IAM roles to associate to the Neptune Cluster | `list(string)` | `null` | no | -| [instance\_class](#input\_instance\_class) | The instance class to use for the Neptune instances (e.g., db.r5.large, db.serverless). | `string` | `"db.serverless"` | no | -| [kms\_key\_arn](#input\_kms\_key\_arn) | (Optional) The ARN for the KMS encryption key. When specifying kms\_key\_arn, storage\_encrypted needs to be set to true. | `string` | `null` | no | -| [max\_capacity](#input\_max\_capacity) | The maximum Neptune Capacity Units (NCUs) for the cluster | `number` | `128` | no | -| [min\_capacity](#input\_min\_capacity) | The minimum Neptune Capacity Units (NCUs) for the cluster | `number` | `2.5` | no | -| [neptune\_cluster\_endpoints](#input\_neptune\_cluster\_endpoints) | A map of Neptune cluster endpoints to create. | 
map(object({
    endpoint_type    = string
    static_members   = list(string)
    excluded_members = list(string)
    tags             = map(string)
  }))
| `{}` | no | -| [neptune\_cluster\_instance\_tags](#input\_neptune\_cluster\_instance\_tags) | Tags for the Neptune cluster instances | `map(string)` | `{}` | no | -| [neptune\_cluster\_parameter\_group\_tags](#input\_neptune\_cluster\_parameter\_group\_tags) | Tags for the Neptune cluster parameter group | `map(string)` | `{}` | no | -| [neptune\_cluster\_parameters](#input\_neptune\_cluster\_parameters) | A map of Neptune cluster parameter settings | 
map(object({
    key   = string
    value = string
  }))
| 
{
  "parameter1": {
    "key": "neptune_enable_audit_log",
    "value": "1"
  }
}
| no | -| [neptune\_db\_parameters](#input\_neptune\_db\_parameters) | A map of Neptune DB parameter settings | 
map(object({
    key   = string
    value = string
  }))
| 
{
  "parameter1": {
    "key": "neptune_query_timeout",
    "value": "25"
  }
}
| no | -| [neptune\_event\_subscription\_tags](#input\_neptune\_event\_subscription\_tags) | Tags for the Neptune event subscription | `map(string)` | `{}` | no | -| [neptune\_family](#input\_neptune\_family) | The family of the neptune cluster and parameter group. | `string` | `"neptune1.2"` | no | -| [neptune\_parameter\_group\_tags](#input\_neptune\_parameter\_group\_tags) | Tags for the Neptune parameter group | `map(string)` | `{}` | no | -| [neptune\_port](#input\_neptune\_port) | Network port for the Neptune DB Cluster | `number` | `8182` | no | -| [neptune\_role\_description](#input\_neptune\_role\_description) | Description for the Neptune IAM role | `string` | `null` | no | -| [neptune\_role\_name](#input\_neptune\_role\_name) | Name for the Neptune IAM role | `string` | `"iam-role-neptune"` | no | -| [neptune\_role\_permissions\_boundary](#input\_neptune\_role\_permissions\_boundary) | ARN of the policy that is used to set the permissions boundary for the Neptune IAM role | `string` | `null` | no | -| [neptune\_security\_group\_tags](#input\_neptune\_security\_group\_tags) | Tags for the Neptune security group | `map(string)` | `{}` | no | -| [neptune\_subnet\_cidrs](#input\_neptune\_subnet\_cidrs) | A list of subnet CIDRs where the Neptune cluster is situated | `list(string)` | 
[
  "10.0.0.0/8"
]
| no | -| [neptune\_subnet\_group\_tags](#input\_neptune\_subnet\_group\_tags) | Tags for the Neptune subnet group | `map(string)` | `{}` | no | -| [port](#input\_port) | (Optional) The port on which the Neptune accepts connections. | `number` | `8182` | no | -| [preferred\_backup\_window](#input\_preferred\_backup\_window) | The daily time range during which automated backups are created | `string` | `"07:00-09:00"` | no | -| [preferred\_maintenance\_window](#input\_preferred\_maintenance\_window) | (Optional) The weekly time range during which system maintenance can occur, in UTC, e.g., 'wed:04:00-wed:04:30'. | `string` | `null` | no | -| [read\_replica\_count](#input\_read\_replica\_count) | Number of read replicas to create. | `number` | `0` | no | -| [replication\_source\_identifier](#input\_replication\_source\_identifier) | (Optional) ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica. | `string` | `null` | no | -| [skip\_final\_snapshot](#input\_skip\_final\_snapshot) | Determines whether a final Neptune snapshot is created before deletion | `bool` | `true` | no | -| [snapshot\_identifier](#input\_snapshot\_identifier) | (Optional) Specifies whether or not to create this cluster from a snapshot. | `string` | `null` | no | -| [storage\_encrypted](#input\_storage\_encrypted) | (Optional) Specifies whether the Neptune cluster is encrypted. | `bool` | `true` | no | -| [storage\_type](#input\_storage\_type) | (Optional) Storage type associated with the cluster (standard or iopt1). Default: standard | `string` | `"standard"` | no | -| [subnet\_ids](#input\_subnet\_ids) | A list of subnet IDs to associate with the Neptune cluster | `list(string)` | `null` | no | -| [tags](#input\_tags) | A map of tags to assign to the Neptune cluster | `map(string)` | `{}` | no | -| [vpc\_id](#input\_vpc\_id) | The VPC ID for the Neptune cluster and security group | `string` | `null` | no | -| [vpc\_security\_group\_ids](#input\_vpc\_security\_group\_ids) | (Optional) List of VPC security groups to associate with the Cluster | `list(string)` | `null` | no | - -## Outputs - -| Name | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| [neptune\_cluster\_arn](#output\_neptune\_cluster\_arn) | ARN of the Neptune cluster | -| [neptune\_cluster\_endpoint](#output\_neptune\_cluster\_endpoint) | The endpoint of the Neptune cluster | -| [neptune\_cluster\_endpoint\_ids](#output\_neptune\_cluster\_endpoint\_ids) | IDs of the Neptune cluster endpoints | -| [neptune\_cluster\_id](#output\_neptune\_cluster\_id) | ID of the Neptune cluster | -| [neptune\_cluster\_reader\_endpoint](#output\_neptune\_cluster\_reader\_endpoint) | The reader endpoint of the Neptune cluster | -| [neptune\_cluster\_resource\_id](#output\_neptune\_cluster\_resource\_id) | The resource ID of the Neptune cluster | -| [neptune\_cluster\_snapshot\_arn](#output\_neptune\_cluster\_snapshot\_arn) | The Amazon Resource Name (ARN) for the DB Cluster Snapshot | -| [neptune\_db\_parameter\_group\_id](#output\_neptune\_db\_parameter\_group\_id) | ID of the Neptune DB parameter group | -| [neptune\_event\_subscription\_ids](#output\_neptune\_event\_subscription\_ids) | IDs of the Neptune event subscriptions | -| [neptune\_global\_cluster\_arn](#output\_neptune\_global\_cluster\_arn) | ARN of the Neptune global cluster | -| [neptune\_global\_cluster\_id](#output\_neptune\_global\_cluster\_id) | ID of the Neptune global cluster | -| [neptune\_global\_cluster\_members](#output\_neptune\_global\_cluster\_members) | A set of objects containing global cluster members | -| [neptune\_global\_cluster\_resource\_id](#output\_neptune\_global\_cluster\_resource\_id) | AWS Region-unique, immutable identifier for the global database cluster | -| [neptune\_iam\_role\_arn](#output\_neptune\_iam\_role\_arn) | ARN of the IAM role for Neptune | -| [neptune\_instance\_id](#output\_neptune\_instance\_id) | ID of the Neptune cluster instance | -| [neptune\_parameter\_group\_id](#output\_neptune\_parameter\_group\_id) | ID of the Neptune cluster parameter group | -| [neptune\_security\_group\_id](#output\_neptune\_security\_group\_id) | ID of the Neptune security group | -| [neptune\_subnet\_group\_id](#output\_neptune\_subnet\_group\_id) | ID of the Neptune subnet group | - -## Requirements - | Name | Version | | ------------------------------------------------------------------------- | -------- | | [terraform](#requirement\_terraform) | >= 1.0 |