1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package redshift
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/redshift/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// 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 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html)
// in the Amazon Redshift Cluster Management Guide.
func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error) {
if params == nil {
params = &CreateClusterInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateCluster", params, optFns, c.addOperationCreateClusterMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateClusterOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateClusterInput struct {
// 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
//
// This member is required.
ClusterIdentifier *string
// The user name associated with the admin user account for the cluster that is
// being created. Constraints:
// - Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be
// PUBLIC .
// - Must contain only lowercase letters, numbers, underscore, plus sign, period
// (dot), at symbol (@), or hyphen.
// - The first character must be a letter.
// - Must not contain a colon (:) or a slash (/).
// - Cannot be a reserved word. A list of reserved words can be found in
// Reserved Words (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html)
// in the Amazon Redshift Database Developer Guide.
//
// This member is required.
MasterUsername *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 | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus |
// ra3.4xlarge | ra3.16xlarge
//
// This member is required.
NodeType *string
// Reserved.
AdditionalInfo *string
// 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
AllowVersionUpgrade *bool
// This parameter is retired. It does not set the AQUA configuration status.
// Amazon Redshift automatically determines whether to use AQUA (Advanced Query
// Accelerator).
AquaConfigurationStatus types.AquaConfigurationStatus
// 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.
AutomatedSnapshotRetentionPeriod *int32
// 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.
AvailabilityZone *string
// The option to enable relocation for an Amazon Redshift cluster between
// Availability Zones after the cluster is created.
AvailabilityZoneRelocation *bool
// 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.
ClusterParameterGroupName *string
// A list of security groups to be associated with this cluster. Default: The
// default cluster security group for Amazon Redshift.
ClusterSecurityGroups []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).
ClusterSubnetGroupName *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
ClusterType *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
ClusterVersion *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.
// - Cannot be a word that is reserved by the service. A list of reserved words
// can be found in Reserved Words (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html)
// in the Amazon Redshift Database Developer Guide.
DBName *string
// The Amazon Resource Name (ARN) for the IAM role that was set as default for the
// cluster when the cluster was created.
DefaultIamRoleArn *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.
// 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 (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms)
// in the Amazon Redshift Cluster Management Guide.
ElasticIp *string
// If true , the data in the cluster is encrypted at rest. Default: false
Encrypted *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
EnhancedVpcRouting *bool
// Specifies the name of the HSM client certificate the Amazon Redshift cluster
// uses to retrieve the data encryption keys stored in an HSM.
HsmClientCertificateIdentifier *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.
HsmConfigurationIdentifier *string
// 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 (https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html)
// in the Amazon Redshift Cluster Management Guide.
IamRoles []string
// The IP address types that the cluster supports. Possible values are ipv4 and
// dualstack .
IpAddressType *string
// The Key Management Service (KMS) key ID of the encryption key that you want to
// use to encrypt data in the cluster.
KmsKeyId *string
// A flag that specifies whether to load sample data once the cluster is created.
LoadSampleData *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.
MaintenanceTrackName *string
// If true , Amazon Redshift uses Secrets Manager to manage this cluster's admin
// credentials. You can't use MasterUserPassword if ManageMasterPassword is true.
// If ManageMasterPassword is false or not set, Amazon Redshift uses
// MasterUserPassword for the admin user account's password.
ManageMasterPassword *bool
// 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.
ManualSnapshotRetentionPeriod *int32
// The ID of the Key Management Service (KMS) key used to encrypt and store the
// cluster's admin credentials secret. You can only use this parameter if
// ManageMasterPassword is true.
MasterPasswordSecretKmsKeyId *string
// The password associated with the admin user account for the cluster that is
// being created. You can't use MasterUserPassword if ManageMasterPassword is true
// . 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 @ .
MasterUserPassword *string
// If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).
MultiAZ *bool
// 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.
NumberOfNodes *int32
// 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
Port *int32
// 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.
PreferredMaintenanceWindow *string
// If true , the cluster can be accessed from a public network.
PubliclyAccessible *bool
// The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center
// application.
RedshiftIdcApplicationArn *string
// A unique identifier for the snapshot schedule.
SnapshotScheduleIdentifier *string
// A list of tag instances.
Tags []types.Tag
// 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.
VpcSecurityGroupIds []string
noSmithyDocumentSerde
}
type CreateClusterOutput struct {
// Describes a cluster.
Cluster *types.Cluster
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateClusterMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsquery_serializeOpCreateCluster{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpCreateCluster{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateCluster"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpCreateClusterValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateCluster(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateCluster(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateCluster",
}
}
|