Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Paws::RedShift::CreateUsertContributed Perl DoPaws::RedShift::CreateCluster(3)

NAME
       Paws::RedShift::CreateCluster - Arguments for method CreateCluster on
       Paws::RedShift

DESCRIPTION
       This class represents the parameters used for calling the method
       CreateCluster on	the Amazon Redshift service. Use the attributes	of
       this class as arguments to method CreateCluster.

       You shouln't make instances of this class. Each attribute should	be
       used as a named argument	in the call to CreateCluster.

       As an example:

	 $service_obj->CreateCluster(Att1 => $value1, Att2 => $value2, ...);

       Values for attributes that are native types (Int, String, Float,	etc)
       can passed as-is	(scalar	values). Values	for complex Types (objects)
       can be passed as	a HashRef. The keys and	values of the hashref will be
       used to instance	the underlying object.

ATTRIBUTES
   AllowVersionUpgrade => 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"

   AutomatedSnapshotRetentionPeriod => 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.

       Default:	1

       Constraints: Must be a value from 0 to 35.

   AvailabilityZone => Str
       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.

   REQUIRED ClusterIdentifier => Str
       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:

       o   Must	contain	from 1 to 63 alphanumeric characters or	hyphens.

       o   Alphabetic characters must be lowercase.

       o   First character must	be a letter.

       o   Cannot end with a hyphen or contain two consecutive hyphens.

       o   Must	be unique for all clusters within an AWS account.

       Example:	"myexamplecluster"

   ClusterParameterGroupName =>	Str
       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:

       o   Must	be 1 to	255 alphanumeric characters or hyphens.

       o   First character must	be a letter.

       o   Cannot end with a hyphen or contain two consecutive hyphens.

   ClusterSecurityGroups => ArrayRef[Str]
       A list of security groups to be associated with this cluster.

       Default:	The default cluster security group for Amazon Redshift.

   ClusterSubnetGroupName => Str
       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 => Str
       The type	of the cluster.	When cluster type is specified as

       o   "single-node", the NumberOfNodes parameter is not required.

       o   "multi-node", the NumberOfNodes parameter is	required.

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

       Default:	"multi-node"

   ClusterVersion => Str
       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 => Str
       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:

       o   Must	contain	1 to 64	alphanumeric characters.

       o   Must	contain	only lowercase letters.

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

   ElasticIp =>	Str
       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
       Your Cluster in the Amazon Redshift Cluster Management Guide.

   Encrypted =>	Bool
       If "true", the data in the cluster is encrypted at rest.

       Default:	false

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

   HsmConfigurationIdentifier => Str
       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.

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

   REQUIRED MasterUsername => Str
       The user	name associated	with the master	user account for the cluster
       that is being created.

       Constraints:

       o   Must	be 1 - 128 alphanumeric	characters.

       o   First character must	be a letter.

       o   Cannot be a reserved	word. A	list of	reserved words can be found in
	   Reserved Words in the Amazon	Redshift Database Developer Guide.

   REQUIRED MasterUserPassword => Str
       The password associated with the	master user account for	the cluster
       that is being created.

       Constraints:

       o   Must	be between 8 and 64 characters in length.

       o   Must	contain	at least one uppercase letter.

       o   Must	contain	at least one lowercase letter.

       o   Must	contain	one number.

       o   Can be any printable	ASCII character	(ASCII code 33 to 126) except
	   ' (single quote), " (double quote), \, /, @,	or space.

   REQUIRED NodeType =>	Str
       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: "ds1.xlarge" | "ds1.8xlarge" | "ds2.xlarge" |
       "ds2.8xlarge" | "dc1.large" | "dc1.8xlarge".

   NumberOfNodes => 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	=> 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 => Str
       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 => Bool
       If "true", the cluster can be accessed from a public network.

   Tags	=> ArrayRef[Paws::RedShift::Tag]
       A list of tag instances.

   VpcSecurityGroupIds => ArrayRef[Str]
       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.

SEE ALSO
       This class forms	part of	Paws, documenting arguments for	method
       CreateCluster in	Paws::RedShift

BUGS and CONTRIBUTIONS
       The source code is located here:	https://github.com/pplu/aws-sdk-perl

       Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

perl v5.24.1			  2015-08-06  Paws::RedShift::CreateCluster(3)

NAME | DESCRIPTION | ATTRIBUTES | SEE ALSO | BUGS and CONTRIBUTIONS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Paws::RedShift::CreateCluster&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help