Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Redshift.CreateCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new cluster with the specified parameters.

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Synopsis

data CreateCluster = CreateCluster' {
- additionalInfo :: Maybe Text
- allowVersionUpgrade :: Maybe Bool
- aquaConfigurationStatus :: Maybe AquaConfigurationStatus
- automatedSnapshotRetentionPeriod :: Maybe Int
- availabilityZone :: Maybe Text
- availabilityZoneRelocation :: Maybe Bool
- clusterParameterGroupName :: Maybe Text
- clusterSecurityGroups :: Maybe [Text]
- clusterSubnetGroupName :: Maybe Text
- clusterType :: Maybe Text
- clusterVersion :: Maybe Text
- dbName :: Maybe Text
- defaultIamRoleArn :: Maybe Text
- elasticIp :: Maybe Text
- encrypted :: Maybe Bool
- enhancedVpcRouting :: Maybe Bool
- hsmClientCertificateIdentifier :: Maybe Text
- hsmConfigurationIdentifier :: Maybe Text
- iamRoles :: Maybe [Text]
- kmsKeyId :: Maybe Text
- loadSampleData :: Maybe Text
- maintenanceTrackName :: Maybe Text
- manualSnapshotRetentionPeriod :: Maybe Int
- numberOfNodes :: Maybe Int
- port :: Maybe Int
- preferredMaintenanceWindow :: Maybe Text
- publiclyAccessible :: Maybe Bool
- snapshotScheduleIdentifier :: Maybe Text
- tags :: Maybe [Tag]
- vpcSecurityGroupIds :: Maybe [Text]
- clusterIdentifier :: Text
- nodeType :: Text
- masterUsername :: Text
- masterUserPassword :: Text
}
newCreateCluster :: Text -> Text -> Text -> Text -> CreateCluster
createCluster_additionalInfo :: Lens' CreateCluster (Maybe Text)
createCluster_allowVersionUpgrade :: Lens' CreateCluster (Maybe Bool)
createCluster_aquaConfigurationStatus :: Lens' CreateCluster (Maybe AquaConfigurationStatus)
createCluster_automatedSnapshotRetentionPeriod :: Lens' CreateCluster (Maybe Int)
createCluster_availabilityZone :: Lens' CreateCluster (Maybe Text)
createCluster_availabilityZoneRelocation :: Lens' CreateCluster (Maybe Bool)
createCluster_clusterParameterGroupName :: Lens' CreateCluster (Maybe Text)
createCluster_clusterSecurityGroups :: Lens' CreateCluster (Maybe [Text])
createCluster_clusterSubnetGroupName :: Lens' CreateCluster (Maybe Text)
createCluster_clusterType :: Lens' CreateCluster (Maybe Text)
createCluster_clusterVersion :: Lens' CreateCluster (Maybe Text)
createCluster_dbName :: Lens' CreateCluster (Maybe Text)
createCluster_defaultIamRoleArn :: Lens' CreateCluster (Maybe Text)
createCluster_elasticIp :: Lens' CreateCluster (Maybe Text)
createCluster_encrypted :: Lens' CreateCluster (Maybe Bool)
createCluster_enhancedVpcRouting :: Lens' CreateCluster (Maybe Bool)
createCluster_hsmClientCertificateIdentifier :: Lens' CreateCluster (Maybe Text)
createCluster_hsmConfigurationIdentifier :: Lens' CreateCluster (Maybe Text)
createCluster_iamRoles :: Lens' CreateCluster (Maybe [Text])
createCluster_kmsKeyId :: Lens' CreateCluster (Maybe Text)
createCluster_loadSampleData :: Lens' CreateCluster (Maybe Text)
createCluster_maintenanceTrackName :: Lens' CreateCluster (Maybe Text)
createCluster_manualSnapshotRetentionPeriod :: Lens' CreateCluster (Maybe Int)
createCluster_numberOfNodes :: Lens' CreateCluster (Maybe Int)
createCluster_port :: Lens' CreateCluster (Maybe Int)
createCluster_preferredMaintenanceWindow :: Lens' CreateCluster (Maybe Text)
createCluster_publiclyAccessible :: Lens' CreateCluster (Maybe Bool)
createCluster_snapshotScheduleIdentifier :: Lens' CreateCluster (Maybe Text)
createCluster_tags :: Lens' CreateCluster (Maybe [Tag])
createCluster_vpcSecurityGroupIds :: Lens' CreateCluster (Maybe [Text])
createCluster_clusterIdentifier :: Lens' CreateCluster Text
createCluster_nodeType :: Lens' CreateCluster Text
createCluster_masterUsername :: Lens' CreateCluster Text
createCluster_masterUserPassword :: Lens' CreateCluster Text
data CreateClusterResponse = CreateClusterResponse' {
- cluster :: Maybe Cluster
- httpStatus :: Int
}
newCreateClusterResponse :: Int -> CreateClusterResponse
createClusterResponse_cluster :: Lens' CreateClusterResponse (Maybe Cluster)
createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int

Creating a Request

data CreateCluster Source #

See: newCreateCluster smart constructor.

Constructors

CreateCluster'

Fields

additionalInfo :: Maybe Text
Reserved.
allowVersionUpgrade :: Maybe Bool
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
aquaConfigurationStatus :: Maybe AquaConfigurationStatus
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
automatedSnapshotRetentionPeriod :: Maybe Int
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: 1
Constraints: Must be a value from 0 to 35.
availabilityZone :: Maybe Text
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-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
availabilityZoneRelocation :: Maybe Bool
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
clusterParameterGroupName :: Maybe Text
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 Amazon Redshift 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.
clusterSecurityGroups :: Maybe [Text]
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
clusterSubnetGroupName :: Maybe Text
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).
clusterType :: Maybe Text
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
clusterVersion :: Maybe Text
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
dbName :: Maybe Text
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.
defaultIamRoleArn :: Maybe Text
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
elasticIp :: Maybe Text
The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
encrypted :: Maybe Bool
If true, the data in the cluster is encrypted at rest.
Default: false
enhancedVpcRouting :: Maybe Bool
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
hsmClientCertificateIdentifier :: Maybe Text
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
hsmConfigurationIdentifier :: Maybe Text
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.
iamRoles :: Maybe [Text]
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
kmsKeyId :: Maybe Text
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
loadSampleData :: Maybe Text
A flag that specifies whether to load sample data once the cluster is created.
maintenanceTrackName :: Maybe Text
An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.
manualSnapshotRetentionPeriod :: Maybe Int
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
numberOfNodes :: Maybe Int
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 Working with 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.
port :: Maybe Int
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
preferredMaintenanceWindow :: Maybe Text
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.
publiclyAccessible :: Maybe Bool
If true, the cluster can be accessed from a public network.
snapshotScheduleIdentifier :: Maybe Text
A unique identifier for the snapshot schedule.
tags :: Maybe [Tag]
A list of tag instances.
vpcSecurityGroupIds :: Maybe [Text]
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.
clusterIdentifier :: Text
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 Amazon Web Services account.
Example: myexamplecluster
nodeType :: Text
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
masterUsername :: Text
The user name associated with the admin user account for the cluster that is being created.
Constraints:
- Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.
- 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.
masterUserPassword :: Text
The password associated with the admin 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-126) except ' (single quote), " (double quote), \, /, or @.

Instances

Instances details

ToHeaders CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods toHeaders :: CreateCluster -> [Header] #
ToPath CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods toPath :: CreateCluster -> ByteString #
ToQuery CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods toQuery :: CreateCluster -> QueryString #
AWSRequest CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Associated Types type AWSResponse CreateCluster # Methods request :: (Service -> Service) -> CreateCluster -> Request CreateCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCluster))) #
Generic CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Associated Types type Rep CreateCluster :: Type -> Type # Methods from :: CreateCluster -> Rep CreateCluster x # to :: Rep CreateCluster x -> CreateCluster #
Read CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods readsPrec :: Int -> ReadS CreateCluster # readList :: ReadS [CreateCluster] # readPrec :: ReadPrec CreateCluster # readListPrec :: ReadPrec [CreateCluster] #
Show CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods showsPrec :: Int -> CreateCluster -> ShowS # show :: CreateCluster -> String # showList :: [CreateCluster] -> ShowS #
NFData CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods rnf :: CreateCluster -> () #
Eq CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods (==) :: CreateCluster -> CreateCluster -> Bool # (/=) :: CreateCluster -> CreateCluster -> Bool #
Hashable CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods hashWithSalt :: Int -> CreateCluster -> Int # hash :: CreateCluster -> Int #
type AWSResponse CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster type AWSResponse CreateCluster = CreateClusterResponse
type Rep CreateCluster Source #
Instance details Defined in Amazonka.Redshift.CreateCluster type Rep CreateCluster = D1 ('MetaData "CreateCluster" "Amazonka.Redshift.CreateCluster" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "CreateCluster'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "additionalInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "allowVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "aquaConfigurationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AquaConfigurationStatus)) :: S1 ('MetaSel ('Just "automatedSnapshotRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "availabilityZoneRelocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "clusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clusterSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: (((S1 ('MetaSel ('Just "clusterSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clusterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "clusterVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "defaultIamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "elasticIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "encrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "enhancedVpcRouting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "hsmClientCertificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))) :: ((((S1 ('MetaSel ('Just "hsmConfigurationIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "iamRoles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "loadSampleData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "maintenanceTrackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "manualSnapshotRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "numberOfNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: (((S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "snapshotScheduleIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: ((S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "nodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))))

newCreateCluster Source #

Arguments

:: Text	`CreateCluster`
-> Text	`CreateCluster`
-> Text	`CreateCluster`
-> Text	`CreateCluster`
-> CreateCluster

Create a value of CreateCluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalInfo:CreateCluster', createCluster_additionalInfo - Reserved.

CreateCluster, createCluster_allowVersionUpgrade - 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

CreateCluster, createCluster_aquaConfigurationStatus - This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

CreateCluster, createCluster_automatedSnapshotRetentionPeriod - 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.

You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

Default: 1

Constraints: Must be a value from 0 to 35.

CreateCluster, createCluster_availabilityZone - 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-2d

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

$sel:availabilityZoneRelocation:CreateCluster', createCluster_availabilityZoneRelocation - The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

$sel:clusterParameterGroupName:CreateCluster', createCluster_clusterParameterGroupName - 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 Amazon Redshift 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.

CreateCluster, createCluster_clusterSecurityGroups - A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

CreateCluster, createCluster_clusterSubnetGroupName - 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).

CreateCluster, createCluster_clusterType - 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

CreateCluster, createCluster_clusterVersion - 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

CreateCluster, createCluster_dbName - 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.

CreateCluster, createCluster_defaultIamRoleArn - The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

CreateCluster, createCluster_elasticIp - The Elastic IP (EIP) address for the cluster.

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

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

Default: false

CreateCluster, createCluster_enhancedVpcRouting - An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

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

CreateCluster, createCluster_hsmConfigurationIdentifier - 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.

CreateCluster, createCluster_iamRoles - A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

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

$sel:loadSampleData:CreateCluster', createCluster_loadSampleData - A flag that specifies whether to load sample data once the cluster is created.

CreateCluster, createCluster_maintenanceTrackName - An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

CreateCluster, createCluster_manualSnapshotRetentionPeriod - The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

The value must be either -1 or an integer between 1 and 3,653.

CreateCluster, createCluster_numberOfNodes - 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 Working with 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.

CreateCluster, createCluster_port - 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

CreateCluster, createCluster_preferredMaintenanceWindow - 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.

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

CreateCluster, createCluster_snapshotScheduleIdentifier - A unique identifier for the snapshot schedule.

CreateCluster, createCluster_tags - A list of tag instances.

$sel:vpcSecurityGroupIds:CreateCluster', createCluster_vpcSecurityGroupIds - 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.

CreateCluster, createCluster_clusterIdentifier - 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 Amazon Web Services account.

Example: myexamplecluster

CreateCluster, createCluster_nodeType - The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

CreateCluster, createCluster_masterUsername - The user name associated with the admin user account for the cluster that is being created.

Constraints:

Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.
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.

CreateCluster, createCluster_masterUserPassword - The password associated with the admin 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-126) except ' (single quote), " (double quote), \, /, or @.

Request Lenses

createCluster_additionalInfo :: Lens' CreateCluster (Maybe Text) Source #

Reserved.

createCluster_allowVersionUpgrade :: 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

createCluster_aquaConfigurationStatus :: Lens' CreateCluster (Maybe AquaConfigurationStatus) Source #

This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

createCluster_automatedSnapshotRetentionPeriod :: 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.

You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

Default: 1

Constraints: Must be a value from 0 to 35.

createCluster_availabilityZone :: 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-2d

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

createCluster_availabilityZoneRelocation :: Lens' CreateCluster (Maybe Bool) Source #

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

createCluster_clusterParameterGroupName :: 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 Amazon Redshift 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.

createCluster_clusterSecurityGroups :: Lens' CreateCluster (Maybe [Text]) Source #

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

Default: The default cluster security group for Amazon Redshift.

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

createCluster_clusterType :: 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

createCluster_clusterVersion :: 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

createCluster_dbName :: 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.

createCluster_defaultIamRoleArn :: Lens' CreateCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

createCluster_elasticIp :: 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. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

createCluster_encrypted :: Lens' CreateCluster (Maybe Bool) Source #

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

Default: false

createCluster_enhancedVpcRouting :: Lens' CreateCluster (Maybe Bool) Source #

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

createCluster_hsmClientCertificateIdentifier :: 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.

createCluster_hsmConfigurationIdentifier :: 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.

createCluster_iamRoles :: Lens' CreateCluster (Maybe [Text]) Source #

A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

createCluster_kmsKeyId :: Lens' CreateCluster (Maybe Text) Source #

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

createCluster_loadSampleData :: Lens' CreateCluster (Maybe Text) Source #

A flag that specifies whether to load sample data once the cluster is created.

createCluster_maintenanceTrackName :: Lens' CreateCluster (Maybe Text) Source #

An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

createCluster_manualSnapshotRetentionPeriod :: Lens' CreateCluster (Maybe Int) Source #

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

The value must be either -1 or an integer between 1 and 3,653.

createCluster_numberOfNodes :: 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 Working with 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.

createCluster_port :: 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

createCluster_preferredMaintenanceWindow :: 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.

createCluster_publiclyAccessible :: Lens' CreateCluster (Maybe Bool) Source #

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

createCluster_snapshotScheduleIdentifier :: Lens' CreateCluster (Maybe Text) Source #

A unique identifier for the snapshot schedule.

createCluster_tags :: Lens' CreateCluster (Maybe [Tag]) Source #

A list of tag instances.

createCluster_vpcSecurityGroupIds :: Lens' CreateCluster (Maybe [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.

createCluster_clusterIdentifier :: 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 Amazon Web Services account.

Example: myexamplecluster

createCluster_nodeType :: 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 Management Guide.

createCluster_masterUsername :: Lens' CreateCluster Text Source #

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

Constraints:

Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.
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.

createCluster_masterUserPassword :: Lens' CreateCluster Text Source #

The password associated with the admin 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-126) except ' (single quote), " (double quote), \, /, or @.

Destructuring the Response

data CreateClusterResponse Source #

See: newCreateClusterResponse smart constructor.

Constructors

CreateClusterResponse'
Fields cluster :: Maybe Cluster httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateClusterResponse Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Associated Types type Rep CreateClusterResponse :: Type -> Type # Methods from :: CreateClusterResponse -> Rep CreateClusterResponse x # to :: Rep CreateClusterResponse x -> CreateClusterResponse #
Read CreateClusterResponse Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods readsPrec :: Int -> ReadS CreateClusterResponse # readList :: ReadS [CreateClusterResponse] # readPrec :: ReadPrec CreateClusterResponse # readListPrec :: ReadPrec [CreateClusterResponse] #
Show CreateClusterResponse Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods showsPrec :: Int -> CreateClusterResponse -> ShowS # show :: CreateClusterResponse -> String # showList :: [CreateClusterResponse] -> ShowS #
NFData CreateClusterResponse Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods rnf :: CreateClusterResponse -> () #
Eq CreateClusterResponse Source #
Instance details Defined in Amazonka.Redshift.CreateCluster Methods (==) :: CreateClusterResponse -> CreateClusterResponse -> Bool # (/=) :: CreateClusterResponse -> CreateClusterResponse -> Bool #
type Rep CreateClusterResponse Source #
Instance details Defined in Amazonka.Redshift.CreateCluster type Rep CreateClusterResponse = D1 ('MetaData "CreateClusterResponse" "Amazonka.Redshift.CreateCluster" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "CreateClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateClusterResponse'`
-> CreateClusterResponse

Create a value of CreateClusterResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cluster:CreateClusterResponse', createClusterResponse_cluster - Undocumented member.

$sel:httpStatus:CreateClusterResponse', createClusterResponse_httpStatus - The response's http status code.

Response Lenses

createClusterResponse_cluster :: Lens' CreateClusterResponse (Maybe Cluster) Source #

Undocumented member.

createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int Source #

The response's http status code.