AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CreateClusterInput

import "github.com/aws/aws-sdk-go/service/redshift"

type CreateClusterInput struct { AdditionalInfo *string `type:"string"` AllowVersionUpgrade *bool `type:"boolean"` AutomatedSnapshotRetentionPeriod *int64 `type:"integer"` AvailabilityZone *string `type:"string"` ClusterIdentifier *string `type:"string" required:"true"` ClusterParameterGroupName *string `type:"string"` ClusterSecurityGroups []*string `locationNameList:"ClusterSecurityGroupName" type:"list"` ClusterSubnetGroupName *string `type:"string"` ClusterType *string `type:"string"` ClusterVersion *string `type:"string"` DBName *string `type:"string"` ElasticIp *string `type:"string"` Encrypted *bool `type:"boolean"` EnhancedVpcRouting *bool `type:"boolean"` HsmClientCertificateIdentifier *string `type:"string"` HsmConfigurationIdentifier *string `type:"string"` IamRoles []*string `locationNameList:"IamRoleArn" type:"list"` KmsKeyId *string `type:"string"` MaintenanceTrackName *string `type:"string"` ManualSnapshotRetentionPeriod *int64 `type:"integer"` MasterUserPassword *string `type:"string" required:"true"` MasterUsername *string `type:"string" required:"true"` NodeType *string `type:"string" required:"true"` NumberOfNodes *int64 `type:"integer"` Port *int64 `type:"integer"` PreferredMaintenanceWindow *string `type:"string"` PubliclyAccessible *bool `type:"boolean"` SnapshotScheduleIdentifier *string `type:"string"` Tags []*Tag `locationNameList:"Tag" type:"list"` VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"` }

AdditionalInfo

Type: *string

Reserved.

AllowVersionUpgrade

Type: *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

Type: *int64

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

Type: *string

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.

ClusterIdentifier

Type: *string

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

ClusterIdentifier is a required field

ClusterParameterGroupName

Type: *string

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 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html)

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

Type: []*string

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

Default: The default cluster security group for Amazon Redshift.

ClusterSubnetGroupName

Type: *string

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

Type: *string

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

Type: *string

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

Type: *string

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 (https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html) in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must contain only lowercase letters.

ElasticIp

Type: *string

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 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) in the Amazon Redshift Cluster Management Guide.

Encrypted

Type: *bool

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

Default: false

EnhancedVpcRouting

Type: *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 (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in the Amazon Redshift Cluster Management Guide.

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

Default: false

HsmClientCertificateIdentifier

Type: *string

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

HsmConfigurationIdentifier

Type: *string

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

Type: []*string

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

A cluster can have up to 10 IAM roles associated with it at any time.

KmsKeyId

Type: *string

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

MaintenanceTrackName

Type: *string

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

Type: *int64

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.

MasterUserPassword

Type: *string

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.

MasterUserPassword is a required field

MasterUsername

Type: *string

The user name associated with the master 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.

MasterUsername is a required field

NodeType

Type: *string

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) in the Amazon Redshift Cluster Management Guide.

Valid Values: ds2.xlarge | ds2.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge

NodeType is a required field

NumberOfNodes

Type: *int64

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 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) 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

Type: *int64

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

Type: *string

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 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows) in Amazon Redshift Cluster Management Guide.

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

Constraints: Minimum 30-minute window.

PubliclyAccessible

Type: *bool

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

SnapshotScheduleIdentifier

Type: *string

A unique identifier for the snapshot schedule.

Tags

A tag consisting of a name/value pair for a resource.

VpcSecurityGroupIds

Type: []*string

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.

Method

GoString

func (s CreateClusterInput) GoString() string

GoString returns the string representation

SetAdditionalInfo

func (s *CreateClusterInput) SetAdditionalInfo(v string) *CreateClusterInput

SetAdditionalInfo sets the AdditionalInfo field's value.

SetAllowVersionUpgrade

func (s *CreateClusterInput) SetAllowVersionUpgrade(v bool) *CreateClusterInput

SetAllowVersionUpgrade sets the AllowVersionUpgrade field's value.

SetAutomatedSnapshotRetentionPeriod

func (s *CreateClusterInput) SetAutomatedSnapshotRetentionPeriod(v int64) *CreateClusterInput

SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.

SetAvailabilityZone

func (s *CreateClusterInput) SetAvailabilityZone(v string) *CreateClusterInput

SetAvailabilityZone sets the AvailabilityZone field's value.

SetClusterIdentifier

func (s *CreateClusterInput) SetClusterIdentifier(v string) *CreateClusterInput

SetClusterIdentifier sets the ClusterIdentifier field's value.

SetClusterParameterGroupName

func (s *CreateClusterInput) SetClusterParameterGroupName(v string) *CreateClusterInput

SetClusterParameterGroupName sets the ClusterParameterGroupName field's value.

SetClusterSecurityGroups

func (s *CreateClusterInput) SetClusterSecurityGroups(v []*string) *CreateClusterInput

SetClusterSecurityGroups sets the ClusterSecurityGroups field's value.

SetClusterSubnetGroupName

func (s *CreateClusterInput) SetClusterSubnetGroupName(v string) *CreateClusterInput

SetClusterSubnetGroupName sets the ClusterSubnetGroupName field's value.

SetClusterType

func (s *CreateClusterInput) SetClusterType(v string) *CreateClusterInput

SetClusterType sets the ClusterType field's value.

SetClusterVersion

func (s *CreateClusterInput) SetClusterVersion(v string) *CreateClusterInput

SetClusterVersion sets the ClusterVersion field's value.

SetDBName

func (s *CreateClusterInput) SetDBName(v string) *CreateClusterInput

SetDBName sets the DBName field's value.

SetElasticIp

func (s *CreateClusterInput) SetElasticIp(v string) *CreateClusterInput

SetElasticIp sets the ElasticIp field's value.

SetEncrypted

func (s *CreateClusterInput) SetEncrypted(v bool) *CreateClusterInput

SetEncrypted sets the Encrypted field's value.

SetEnhancedVpcRouting

func (s *CreateClusterInput) SetEnhancedVpcRouting(v bool) *CreateClusterInput

SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.

SetHsmClientCertificateIdentifier

func (s *CreateClusterInput) SetHsmClientCertificateIdentifier(v string) *CreateClusterInput

SetHsmClientCertificateIdentifier sets the HsmClientCertificateIdentifier field's value.

SetHsmConfigurationIdentifier

func (s *CreateClusterInput) SetHsmConfigurationIdentifier(v string) *CreateClusterInput

SetHsmConfigurationIdentifier sets the HsmConfigurationIdentifier field's value.

SetIamRoles

func (s *CreateClusterInput) SetIamRoles(v []*string) *CreateClusterInput

SetIamRoles sets the IamRoles field's value.

SetKmsKeyId

func (s *CreateClusterInput) SetKmsKeyId(v string) *CreateClusterInput

SetKmsKeyId sets the KmsKeyId field's value.

SetMaintenanceTrackName

func (s *CreateClusterInput) SetMaintenanceTrackName(v string) *CreateClusterInput

SetMaintenanceTrackName sets the MaintenanceTrackName field's value.

SetManualSnapshotRetentionPeriod

func (s *CreateClusterInput) SetManualSnapshotRetentionPeriod(v int64) *CreateClusterInput

SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.

SetMasterUserPassword

func (s *CreateClusterInput) SetMasterUserPassword(v string) *CreateClusterInput

SetMasterUserPassword sets the MasterUserPassword field's value.

SetMasterUsername

func (s *CreateClusterInput) SetMasterUsername(v string) *CreateClusterInput

SetMasterUsername sets the MasterUsername field's value.

SetNodeType

func (s *CreateClusterInput) SetNodeType(v string) *CreateClusterInput

SetNodeType sets the NodeType field's value.

SetNumberOfNodes

func (s *CreateClusterInput) SetNumberOfNodes(v int64) *CreateClusterInput

SetNumberOfNodes sets the NumberOfNodes field's value.

SetPort

func (s *CreateClusterInput) SetPort(v int64) *CreateClusterInput

SetPort sets the Port field's value.

SetPreferredMaintenanceWindow

func (s *CreateClusterInput) SetPreferredMaintenanceWindow(v string) *CreateClusterInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetPubliclyAccessible

func (s *CreateClusterInput) SetPubliclyAccessible(v bool) *CreateClusterInput

SetPubliclyAccessible sets the PubliclyAccessible field's value.

SetSnapshotScheduleIdentifier

func (s *CreateClusterInput) SetSnapshotScheduleIdentifier(v string) *CreateClusterInput

SetSnapshotScheduleIdentifier sets the SnapshotScheduleIdentifier field's value.

SetTags

func (s *CreateClusterInput) SetTags(v []*Tag) *CreateClusterInput

SetTags sets the Tags field's value.

SetVpcSecurityGroupIds

func (s *CreateClusterInput) SetVpcSecurityGroupIds(v []*string) *CreateClusterInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

String

func (s CreateClusterInput) String() string

String returns the string representation

Validate

func (s *CreateClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: