ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/source/docs/providers/aws/r/redshift_cluster.html.markdown

99 lines
6.9 KiB
Markdown
Raw Normal View History

Adding the documentation for the AWS Redshift Subnet Group resource also removed the notion of tags from the redshift security group and parameter group documentation until that has been implemented Redshift Cluster CRUD and acceptance tests Removing the Acceptance test for the Cluster Updates. You cannot delete a cluster immediately after performing an operation on it. We would need to add a lot of retry logic to the system to get this test to work Adding some schema validation for RedShift cluster Adding the last of the pieces of a first draft of the Redshift work - this is the documentation
2015-11-12 10:45:22 +01:00
---
layout: "aws"
page_title: "AWS: aws_redshift_cluster"
sidebar_current: "docs-aws-resource-redshift-cluster"
---
# aws\_redshift\_cluster
provider/aws: Support for Redshift Cluster encryption using a KMS key (#6712)
2016-05-17 18:12:39 +02:00
Provides a Redshift Cluster Resource.
Adding the documentation for the AWS Redshift Subnet Group resource also removed the notion of tags from the redshift security group and parameter group documentation until that has been implemented Redshift Cluster CRUD and acceptance tests Removing the Acceptance test for the Cluster Updates. You cannot delete a cluster immediately after performing an operation on it. We would need to add a lot of retry logic to the system to get this test to work Adding some schema validation for RedShift cluster Adding the last of the pieces of a first draft of the Redshift work - this is the documentation
2015-11-12 10:45:22 +01:00
## Example Usage
minor clean ups after #3862
2016-01-13 23:58:07 +01:00
```
Adding the documentation for the AWS Redshift Subnet Group resource also removed the notion of tags from the redshift security group and parameter group documentation until that has been implemented Redshift Cluster CRUD and acceptance tests Removing the Acceptance test for the Cluster Updates. You cannot delete a cluster immediately after performing an operation on it. We would need to add a lot of retry logic to the system to get this test to work Adding some schema validation for RedShift cluster Adding the last of the pieces of a first draft of the Redshift work - this is the documentation
2015-11-12 10:45:22 +01:00
resource "aws_redshift_cluster" "default" {
cluster_identifier = "tf-redshift-cluster"
database_name = "mydb"
master_username = "foo"
master_password = "Mustbe8characters"
node_type = "dc1.large"
cluster_type = "single-node"
}
minor clean ups after #3862
2016-01-13 23:58:07 +01:00
```
Adding the documentation for the AWS Redshift Subnet Group resource also removed the notion of tags from the redshift security group and parameter group documentation until that has been implemented Redshift Cluster CRUD and acceptance tests Removing the Acceptance test for the Cluster Updates. You cannot delete a cluster immediately after performing an operation on it. We would need to add a lot of retry logic to the system to get this test to work Adding some schema validation for RedShift cluster Adding the last of the pieces of a first draft of the Redshift work - this is the documentation
2015-11-12 10:45:22 +01:00
## Argument Reference
For more detailed documentation about each argument, refer to
the [AWS official documentation](http://docs.aws.amazon.com/cli/latest/reference/redshift/index.html#cli-aws-redshift).
The following arguments are supported:
* `cluster_identifier` - (Required) The Cluster Identifier. Must be a lower case
string.
* `database_name` - (Optional) The name of the first database to be created when the cluster is created.
If you do not provide a name, Amazon Redshift will create a default database called `dev`.
provider/aws: Add support to `aws_redshift_cluster` for restoring from (#8414) snapshot Fixes #6406 Adds 2 new parameters: * `snapshot_identifier` * `snapshot_cluster_identifier` These will be used to allow the Redshift cluster to be restored from a pre-existing snapshot. Also makes the redshift username and password fields optional as these are not required for the snapshot ``` % make testacc TEST=./builtin/providers/aws TESTARGS='-run=TestAccAWSRedshiftCluster_' ==> Checking that code complies with gofmt requirements... /Users/stacko/Code/go/bin/stringer go generate $(go list ./... | grep -v /terraform/vendor/) 2016/08/23 12:04:53 Generated command/internal_plugin_list.go TF_ACC=1 go test ./builtin/providers/aws -v -run=TestAccAWSRedshiftCluster_ -timeout 120m === RUN TestAccAWSRedshiftCluster_importBasic --- PASS: TestAccAWSRedshiftCluster_importBasic (741.03s) === RUN TestAccAWSRedshiftCluster_basic --- PASS: TestAccAWSRedshiftCluster_basic (656.33s) === RUN TestAccAWSRedshiftCluster_loggingEnabled --- PASS: TestAccAWSRedshiftCluster_loggingEnabled (718.65s) === RUN TestAccAWSRedshiftCluster_iamRoles --- PASS: TestAccAWSRedshiftCluster_iamRoles (818.10s) === RUN TestAccAWSRedshiftCluster_publiclyAccessible --- PASS: TestAccAWSRedshiftCluster_publiclyAccessible (853.30s) === RUN TestAccAWSRedshiftCluster_updateNodeCount --- PASS: TestAccAWSRedshiftCluster_updateNodeCount (2083.37s) === RUN TestAccAWSRedshiftCluster_tags --- PASS: TestAccAWSRedshiftCluster_tags (621.15s) PASS ok github.com/hashicorp/terraform/builtin/providers/aws 6491.963s ``` When deploying this, I was able to use config as follows: ``` resource "aws_redshift_cluster" "restore" { cluster_identifier = "my-test-restored-cluster" snapshot_identifier = "sample-snapshot-for-restore" node_type = "dc1.large" } ``` And it resulted in: ``` terraform apply [WARN] /Users/stacko/Code/go/bin/terraform-provider-aws overrides an internal plugin for aws-provider. If you did not expect to see this message you will need to remove the old plugin. See https://www.terraform.io/docs/internals/internal-plugins.html aws_redshift_cluster.restore: Creating... allow_version_upgrade: "" => "true" automated_snapshot_retention_period: "" => "1" availability_zone: "" => "<computed>" bucket_name: "" => "<computed>" cluster_identifier: "" => "my-test-restored-cluster" cluster_parameter_group_name: "" => "<computed>" cluster_public_key: "" => "<computed>" cluster_revision_number: "" => "<computed>" cluster_security_groups.#: "" => "<computed>" cluster_subnet_group_name: "" => "<computed>" cluster_type: "" => "<computed>" cluster_version: "" => "1.0" database_name: "" => "<computed>" enable_logging: "" => "false" encrypted: "" => "<computed>" endpoint: "" => "<computed>" iam_roles.#: "" => "<computed>" kms_key_id: "" => "<computed>" node_type: "" => "dc1.large" number_of_nodes: "" => "1" port: "" => "5439" preferred_maintenance_window: "" => "<computed>" publicly_accessible: "" => "true" s3_key_prefix: "" => "<computed>" skip_final_snapshot: "" => "true" snapshot_identifier: "" => "sample-snapshot-for-restore" vpc_security_group_ids.#: "" => "<computed>" .......... aws_redshift_cluster.restore: Still creating... (5m20s elapsed) aws_redshift_cluster.restore: Creation complete Apply complete! Resources: 1 added, 0 changed, 0 destroyed. ```
2016-08-24 11:58:05 +02:00
* `node_type` - (Optional) The node type to be provisioned for the cluster.
* `master_password` - (Optional) Password for the master DB user. Note that this may
Adding the documentation for the AWS Redshift Subnet Group resource also removed the notion of tags from the redshift security group and parameter group documentation until that has been implemented Redshift Cluster CRUD and acceptance tests Removing the Acceptance test for the Cluster Updates. You cannot delete a cluster immediately after performing an operation on it. We would need to add a lot of retry logic to the system to get this test to work Adding some schema validation for RedShift cluster Adding the last of the pieces of a first draft of the Redshift work - this is the documentation
2015-11-12 10:45:22 +01:00
show up in logs, and it will be stored in the state file
* `master_username` - (Required) Username for the master DB user
* `cluster_security_groups` - (Optional) A list of security groups to be associated with this cluster.
* `vpc_security_group_ids` - (Optional) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
* `cluster_subnet_group_name` - (Optional) The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
* `availability_zone` - (Optional) The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
* `preferred_maintenance_window` - (Optional) The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
* `cluster_parameter_group_name` - (Optional) The name of the parameter group to be associated with this cluster.
provider/aws: Redshift Cluster not allowing 0 for (#6537) automated_snapshot_retention_period The default value for `automated_snapshot_retention_period` is 1. Therefore, it can be included in the `CreateClusterInput` without needing to check that it is set. This was actually stopping people from setting the value to 0 (disabling the snapshots) as there is an issue in `d.GetOk()` evaluating 0 for int
2016-05-08 20:29:36 +02:00
* `automated_snapshot_retention_period` - (Optional) The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.
Adding the documentation for the AWS Redshift Subnet Group resource also removed the notion of tags from the redshift security group and parameter group documentation until that has been implemented Redshift Cluster CRUD and acceptance tests Removing the Acceptance test for the Cluster Updates. You cannot delete a cluster immediately after performing an operation on it. We would need to add a lot of retry logic to the system to get this test to work Adding some schema validation for RedShift cluster Adding the last of the pieces of a first draft of the Redshift work - this is the documentation
2015-11-12 10:45:22 +01:00
* `port` - (Optional) The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
* `cluster_version` - (Optional) The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
* `allow_version_upgrade` - (Optional) If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is true
* `number_of_nodes` - (Optional) The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
provider/aws: `aws_redshift_cluster` publicly_accessible now defaults to true
2016-02-23 00:11:55 +01:00
* `publicly_accessible` - (Optional) If true, the cluster can be accessed from a public network. Default is `true`.
Adding the documentation for the AWS Redshift Subnet Group resource also removed the notion of tags from the redshift security group and parameter group documentation until that has been implemented Redshift Cluster CRUD and acceptance tests Removing the Acceptance test for the Cluster Updates. You cannot delete a cluster immediately after performing an operation on it. We would need to add a lot of retry logic to the system to get this test to work Adding some schema validation for RedShift cluster Adding the last of the pieces of a first draft of the Redshift work - this is the documentation
2015-11-12 10:45:22 +01:00
* `encrypted` - (Optional) If true , the data in the cluster is encrypted at rest.
Ensure kms_key_id docs indicate it is an ARN (#7842) If you specify just a bare ID, then the initial application works but subsequent applications may end up doing bad things, like: ``` -/+ aws_ebs_volume.vol_1 availability_zone: "us-east-1a" => "us-east-1a" encrypted: "true" => "true" iops: "" => "<computed>" kms_key_id: "arn:aws:kms:us-east-1:123456789:key/59faf88b-0912-4cca-8b6c-bd107a6ba8c4" => "59faf88b-0912-4cca-8b6c-bd107a6ba8c4" (forces new resource) size: "100" => "100" snapshot_id: "" => "<computed>" ```
2016-07-28 09:44:09 +02:00
* `kms_key_id` - (Optional) The ARN for the KMS encryption key. When specifying `kms_key_id`, `encrypted` needs to be set to true
Adding the documentation for the AWS Redshift Subnet Group resource also removed the notion of tags from the redshift security group and parameter group documentation until that has been implemented Redshift Cluster CRUD and acceptance tests Removing the Acceptance test for the Cluster Updates. You cannot delete a cluster immediately after performing an operation on it. We would need to add a lot of retry logic to the system to get this test to work Adding some schema validation for RedShift cluster Adding the last of the pieces of a first draft of the Redshift work - this is the documentation
2015-11-12 10:45:22 +01:00
* `elastic_ip` - (Optional) The Elastic IP (EIP) address for the cluster.
Changing the default for ship_final_snapshot on redshift_cluster to be true so as to match the code
2016-01-31 22:48:05 +01:00
* `skip_final_snapshot` - (Optional) Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is true.
provider/aws: Support for Redshift Cluster encryption using a KMS key (#6712)
2016-05-17 18:12:39 +02:00
* `final_snapshot_identifier` - (Optional) The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, `skip_final_snapshot` must be false.
provider/aws: Add support to `aws_redshift_cluster` for ``iam_roles`` (#6647)
2016-05-24 23:44:46 +02:00
* `iam_roles` - (Optional) A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
provider/aws: Enable Redshift Cluster Logging (#7813) Fixes #7423 ``` % make testacc TEST=./builtin/providers/aws TESTARGS='-run=TestAccAWSRedshiftCluster_loggingEnabled' ==> Checking that code complies with gofmt requirements... go generate $(go list ./... | grep -v /terraform/vendor/) TF_ACC=1 go test ./builtin/providers/aws -v -run=TestAccAWSRedshiftCluster_loggingEnabled -timeout 120m === RUN TestAccAWSRedshiftCluster_loggingEnabled --- PASS: TestAccAWSRedshiftCluster_loggingEnabled (675.21s) PASS ok github.com/hashicorp/terraform/builtin/providers/aws 675.233s ```
2016-07-27 23:16:32 +02:00
* `enable_logging` - (Optional) Enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster. Defaults to `false`.
* `bucket_name` - (Optional, required when `enable_logging` is `true`) The name of an existing S3 bucket where the log files are to be stored. Must be in the same region as the cluster and the cluster must have read bucket and put object permissions.
For more information on the permissions required for the bucket, please read the AWS [documentation](http://docs.aws.amazon.com/redshift/latest/mgmt/db-auditing.html#db-auditing-enable-logging)
* `s3_key_prefix` - (Optional) The prefix applied to the log file names.
provider/aws: Add support to `aws_redshift_cluster` for restoring from (#8414) snapshot Fixes #6406 Adds 2 new parameters: * `snapshot_identifier` * `snapshot_cluster_identifier` These will be used to allow the Redshift cluster to be restored from a pre-existing snapshot. Also makes the redshift username and password fields optional as these are not required for the snapshot ``` % make testacc TEST=./builtin/providers/aws TESTARGS='-run=TestAccAWSRedshiftCluster_' ==> Checking that code complies with gofmt requirements... /Users/stacko/Code/go/bin/stringer go generate $(go list ./... | grep -v /terraform/vendor/) 2016/08/23 12:04:53 Generated command/internal_plugin_list.go TF_ACC=1 go test ./builtin/providers/aws -v -run=TestAccAWSRedshiftCluster_ -timeout 120m === RUN TestAccAWSRedshiftCluster_importBasic --- PASS: TestAccAWSRedshiftCluster_importBasic (741.03s) === RUN TestAccAWSRedshiftCluster_basic --- PASS: TestAccAWSRedshiftCluster_basic (656.33s) === RUN TestAccAWSRedshiftCluster_loggingEnabled --- PASS: TestAccAWSRedshiftCluster_loggingEnabled (718.65s) === RUN TestAccAWSRedshiftCluster_iamRoles --- PASS: TestAccAWSRedshiftCluster_iamRoles (818.10s) === RUN TestAccAWSRedshiftCluster_publiclyAccessible --- PASS: TestAccAWSRedshiftCluster_publiclyAccessible (853.30s) === RUN TestAccAWSRedshiftCluster_updateNodeCount --- PASS: TestAccAWSRedshiftCluster_updateNodeCount (2083.37s) === RUN TestAccAWSRedshiftCluster_tags --- PASS: TestAccAWSRedshiftCluster_tags (621.15s) PASS ok github.com/hashicorp/terraform/builtin/providers/aws 6491.963s ``` When deploying this, I was able to use config as follows: ``` resource "aws_redshift_cluster" "restore" { cluster_identifier = "my-test-restored-cluster" snapshot_identifier = "sample-snapshot-for-restore" node_type = "dc1.large" } ``` And it resulted in: ``` terraform apply [WARN] /Users/stacko/Code/go/bin/terraform-provider-aws overrides an internal plugin for aws-provider. If you did not expect to see this message you will need to remove the old plugin. See https://www.terraform.io/docs/internals/internal-plugins.html aws_redshift_cluster.restore: Creating... allow_version_upgrade: "" => "true" automated_snapshot_retention_period: "" => "1" availability_zone: "" => "<computed>" bucket_name: "" => "<computed>" cluster_identifier: "" => "my-test-restored-cluster" cluster_parameter_group_name: "" => "<computed>" cluster_public_key: "" => "<computed>" cluster_revision_number: "" => "<computed>" cluster_security_groups.#: "" => "<computed>" cluster_subnet_group_name: "" => "<computed>" cluster_type: "" => "<computed>" cluster_version: "" => "1.0" database_name: "" => "<computed>" enable_logging: "" => "false" encrypted: "" => "<computed>" endpoint: "" => "<computed>" iam_roles.#: "" => "<computed>" kms_key_id: "" => "<computed>" node_type: "" => "dc1.large" number_of_nodes: "" => "1" port: "" => "5439" preferred_maintenance_window: "" => "<computed>" publicly_accessible: "" => "true" s3_key_prefix: "" => "<computed>" skip_final_snapshot: "" => "true" snapshot_identifier: "" => "sample-snapshot-for-restore" vpc_security_group_ids.#: "" => "<computed>" .......... aws_redshift_cluster.restore: Still creating... (5m20s elapsed) aws_redshift_cluster.restore: Creation complete Apply complete! Resources: 1 added, 0 changed, 0 destroyed. ```
2016-08-24 11:58:05 +02:00
* `snapshot_identifier` - (Optional) The name of the snapshot from which to create the new cluster.
* `snapshot_cluster_identifier` - (Optional) The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
provider/aws: Support tags for AWS redshift cluster (#5356)
2016-05-24 19:43:12 +02:00
* `tags` - (Optional) A mapping of tags to assign to the resource.
Adding the documentation for the AWS Redshift Subnet Group resource also removed the notion of tags from the redshift security group and parameter group documentation until that has been implemented Redshift Cluster CRUD and acceptance tests Removing the Acceptance test for the Cluster Updates. You cannot delete a cluster immediately after performing an operation on it. We would need to add a lot of retry logic to the system to get this test to work Adding some schema validation for RedShift cluster Adding the last of the pieces of a first draft of the Redshift work - this is the documentation
2015-11-12 10:45:22 +01:00
provider/aws: Add support to `aws_redshift_cluster` for ``iam_roles`` (#6647)
2016-05-24 23:44:46 +02:00
Adding the documentation for the AWS Redshift Subnet Group resource also removed the notion of tags from the redshift security group and parameter group documentation until that has been implemented Redshift Cluster CRUD and acceptance tests Removing the Acceptance test for the Cluster Updates. You cannot delete a cluster immediately after performing an operation on it. We would need to add a lot of retry logic to the system to get this test to work Adding some schema validation for RedShift cluster Adding the last of the pieces of a first draft of the Redshift work - this is the documentation
2015-11-12 10:45:22 +01:00
## Attributes Reference
The following attributes are exported:
* `id` - The Redshift Cluster ID.
* `cluster_identifier` - The Cluster Identifier
* `cluster_type` - The cluster type
* `node_type` - The type of nodes in the cluster
* `database_name` - The name of the default database in the Cluster
* `availability_zone` - The availability zone of the Cluster
* `automated_snapshot_retention_period` - The backup retention period
* `preferred_maintenance_window` - The backup window
* `endpoint` - The connection endpoint
* `encrypted` - Whether the data in the cluster is encrypted
* `cluster_security_groups` - The security groups associated with the cluster
* `vpc_security_group_ids` - The VPC security group Ids associated with the cluster
* `port` - The Port the cluster responds on
* `cluster_version` - The version of Redshift engine software
* `cluster_parameter_group_name` - The name of the parameter group to be associated with this cluster
* `cluster_subnet_group_name` - The name of a cluster subnet group to be associated with this cluster
* `cluster_public_key` - The public key for the cluster
provider/aws: Support for Redshift Cluster encryption using a KMS key (#6712)
2016-05-17 18:12:39 +02:00
* `cluster_revision_number` - The specific revision number of the database in the cluster
documentation/aws: More additions of Import documention to the AWS (#7729) resources
2016-07-21 00:28:59 +02:00
## Import
Redshift Clusters can be imported using the `cluster_identifier`, e.g.
```
$ terraform import aws_redshift_cluster.myprodcluster tf-redshift-cluster-12345
Ensure kms_key_id docs indicate it is an ARN (#7842) If you specify just a bare ID, then the initial application works but subsequent applications may end up doing bad things, like: ``` -/+ aws_ebs_volume.vol_1 availability_zone: "us-east-1a" => "us-east-1a" encrypted: "true" => "true" iops: "" => "<computed>" kms_key_id: "arn:aws:kms:us-east-1:123456789:key/59faf88b-0912-4cca-8b6c-bd107a6ba8c4" => "59faf88b-0912-4cca-8b6c-bd107a6ba8c4" (forces new resource) size: "100" => "100" snapshot_id: "" => "<computed>" ```
2016-07-28 09:44:09 +02:00
```