amazonka-redshift-0.3.5: Amazon Redshift SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.Redshift.CreateCluster

Contents

Description

Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to AmazonRedshift Clusters in the Amazon Redshift Cluster Management Guide .

http://docs.aws.amazon.com/redshift/latest/APIReference/API_CreateCluster.html

Synopsis

Request

data CreateCluster Source

Instances

Request constructor

createCluster Source

Arguments

:: Text

ccClusterIdentifier

-> Text

ccNodeType

-> Text

ccMasterUsername

-> Text

ccMasterUserPassword

-> CreateCluster 

CreateCluster constructor.

The fields accessible through corresponding lenses are:

Request lenses

ccAllowVersionUpgrade :: Lens' CreateCluster (Maybe Bool) Source

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

ccAutomatedSnapshotRetentionPeriod :: Lens' CreateCluster (Maybe Int) Source

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 CreateClusterSnapshot .

Default: '1'

Constraints: Must be a value from 0 to 35.

ccAvailabilityZone :: Lens' CreateCluster (Maybe Text) Source

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.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: 'us-east-1d'

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

ccClusterIdentifier :: Lens' CreateCluster Text Source

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: myexamplecluster

ccClusterParameterGroupName :: Lens' CreateCluster (Maybe Text) Source

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with AmazonRedshift Parameter Groups

Constraints:

Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.

ccClusterSecurityGroups :: Lens' CreateCluster [Text] Source

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

ccClusterSubnetGroupName :: Lens' CreateCluster (Maybe Text) Source

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).

ccClusterType :: Lens' CreateCluster (Maybe Text) Source

The type of the cluster. When cluster type is specified as 'single-node', the NumberOfNodes parameter is not required. 'multi-node', the NumberOfNodes parameter is required.

Valid Values: 'multi-node' | 'single-node'

Default: 'multi-node'

ccClusterVersion :: Lens' CreateCluster (Maybe Text) Source

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.

Constraints: Only version 1.0 is currently available.

Example: '1.0'

ccDBName :: Lens' CreateCluster (Maybe Text) Source

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

Must contain 1 to 64 alphanumeric characters. Must contain only lowercase letters. Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

ccElasticIp :: Lens' CreateCluster (Maybe Text) Source

The Elastic IP (EIP) address for the cluster.

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch YourCluster in the Amazon Redshift Cluster Management Guide.

ccEncrypted :: Lens' CreateCluster (Maybe Bool) Source

If true, the data in the cluster is encrypted at rest.

Default: false

ccHsmClientCertificateIdentifier :: Lens' CreateCluster (Maybe Text) Source

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

ccHsmConfigurationIdentifier :: Lens' CreateCluster (Maybe Text) Source

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

ccKmsKeyId :: Lens' CreateCluster (Maybe Text) Source

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

ccMasterUserPassword :: Lens' CreateCluster Text Source

The password associated with the master user account for the cluster that is being created.

Constraints:

Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), , /, @, or space.

ccMasterUsername :: Lens' CreateCluster Text Source

The user name associated with the master user account for the cluster that is being created.

Constraints:

Must be 1 - 128 alphanumeric characters. First character must be a letter. Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

ccNodeType :: Lens' CreateCluster Text Source

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster ManagementGuide.

Valid Values: 'dw1.xlarge' | 'dw1.8xlarge' | 'dw2.large' | 'dw2.8xlarge'.

ccNumberOfNodes :: Lens' CreateCluster (Maybe Int) Source

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as 'multi-node'.

For information about determining how many nodes you need, go to Workingwith Clusters in the Amazon Redshift Cluster Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: '1'

Constraints: Value must be at least 1 and no more than 100.

ccPort :: Lens' CreateCluster (Maybe Int) Source

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: '5439'

Valid Values: '1150-65535'

ccPreferredMaintenanceWindow :: Lens' CreateCluster (Maybe Text) Source

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: 'ddd:hh24:mi-ddd:hh24:mi'

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

ccPubliclyAccessible :: Lens' CreateCluster (Maybe Bool) Source

If true, the cluster can be accessed from a public network.

ccTags :: Lens' CreateCluster [Tag] Source

A list of tag instances.

ccVpcSecurityGroupIds :: Lens' CreateCluster [Text] Source

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Response

data CreateClusterResponse Source

Instances

Response constructor

createClusterResponse :: CreateClusterResponse Source

CreateClusterResponse constructor.

The fields accessible through corresponding lenses are:

Response lenses

ccrCluster :: Lens' CreateClusterResponse (Maybe Cluster) Source