github.com/minamijoyo/terraform@v0.7.8-0.20161029001309-18b3736ba44b/website/source/docs/providers/aws/r/redshift_cluster.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_redshift_cluster"
     4  sidebar_current: "docs-aws-resource-redshift-cluster"
     5  ---
     6  
     7  # aws\_redshift\_cluster
     8  
     9  Provides a Redshift Cluster Resource.
    10  
    11  ## Example Usage
    12  
    13  ```
    14  resource "aws_redshift_cluster" "default" {
    15    cluster_identifier = "tf-redshift-cluster"
    16    database_name = "mydb"
    17    master_username = "foo"
    18    master_password = "Mustbe8characters"
    19    node_type = "dc1.large"
    20    cluster_type = "single-node"
    21  }
    22  ```
    23  
    24  ## Argument Reference
    25  
    26  For more detailed documentation about each argument, refer to
    27  the [AWS official documentation](http://docs.aws.amazon.com/cli/latest/reference/redshift/index.html#cli-aws-redshift).
    28  
    29  The following arguments are supported:
    30  
    31  * `cluster_identifier` - (Required) The Cluster Identifier. Must be a lower case
    32  string.
    33  * `database_name` - (Optional) The name of the first database to be created when the cluster is created.
    34   If you do not provide a name, Amazon Redshift will create a default database called `dev`.
    35  * `node_type` - (Required) The node type to be provisioned for the cluster.
    36  * `master_password` - (Optional) Password for the master DB user. Note that this may
    37      show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and 
    38      contain at least one uppercase letter, one lowercase letter, and one number.
    39  * `master_username` - (Required) Username for the master DB user
    40  * `cluster_security_groups` - (Optional) A list of security groups to be associated with this cluster.
    41  * `vpc_security_group_ids` - (Optional) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
    42  * `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).
    43  * `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.
    44  * `preferred_maintenance_window` - (Optional) The weekly time range (in UTC) during which automated cluster maintenance can occur.
    45                                                Format: ddd:hh24:mi-ddd:hh24:mi
    46  * `cluster_parameter_group_name` - (Optional) The name of the parameter group to be associated with this cluster.
    47  * `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.
    48  * `port` - (Optional) The port number on which the cluster accepts incoming connections.
    49                        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.
    50  * `cluster_version` - (Optional) The version of the Amazon Redshift engine software that you want to deploy on the cluster.
    51                                   The version selected runs on all the nodes in the cluster.
    52  * `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
    53  * `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.
    54  * `publicly_accessible` - (Optional) If true, the cluster can be accessed from a public network. Default is `true`.
    55  * `encrypted` - (Optional) If true , the data in the cluster is encrypted at rest.
    56  * `kms_key_id` - (Optional) The ARN for the KMS encryption key. When specifying `kms_key_id`, `encrypted` needs to be set to true
    57  * `elastic_ip` - (Optional) The Elastic IP (EIP) address for the cluster.
    58  * `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.
    59  * `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.
    60  * `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.
    61  * `enable_logging` - (Optional) Enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster. Defaults to `false`.
    62  * `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.
    63  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)
    64  * `s3_key_prefix` - (Optional) The prefix applied to the log file names.
    65  * `tags` - (Optional) A mapping of tags to assign to the resource.
    66  
    67  
    68  ## Attributes Reference
    69  
    70  The following attributes are exported:
    71  
    72  * `id` - The Redshift Cluster ID.
    73  * `cluster_identifier` - The Cluster Identifier
    74  * `cluster_type` - The cluster type
    75  * `node_type` - The type of nodes in the cluster
    76  * `database_name` - The name of the default database in the Cluster
    77  * `availability_zone` - The availability zone of the Cluster
    78  * `automated_snapshot_retention_period` - The backup retention period
    79  * `preferred_maintenance_window` - The backup window
    80  * `endpoint` - The connection endpoint
    81  * `encrypted` - Whether the data in the cluster is encrypted
    82  * `cluster_security_groups` - The security groups associated with the cluster
    83  * `vpc_security_group_ids` - The VPC security group Ids associated with the cluster
    84  * `port` - The Port the cluster responds on
    85  * `cluster_version` - The version of Redshift engine software
    86  * `cluster_parameter_group_name` - The name of the parameter group to be associated with this cluster
    87  * `cluster_subnet_group_name` - The name of a cluster subnet group to be associated with this cluster
    88  * `cluster_public_key` - The public key for the cluster
    89  * `cluster_revision_number` - The specific revision number of the database in the cluster
    90  
    91  ## Import
    92  
    93  Redshift Clusters can be imported using the `cluster_identifier`, e.g. 
    94  
    95  ```
    96  $ terraform import aws_redshift_cluster.myprodcluster tf-redshift-cluster-12345
    97  ```