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.

ModifyClusterInput

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

type ModifyClusterInput struct { AllowVersionUpgrade *bool `type:"boolean"` AutomatedSnapshotRetentionPeriod *int64 `type:"integer"` ClusterIdentifier *string `type:"string" required:"true"` ClusterParameterGroupName *string `type:"string"` ClusterSecurityGroups []*string `locationNameList:"ClusterSecurityGroupName" type:"list"` ClusterType *string `type:"string"` ClusterVersion *string `type:"string"` ElasticIp *string `type:"string"` Encrypted *bool `type:"boolean"` EnhancedVpcRouting *bool `type:"boolean"` HsmClientCertificateIdentifier *string `type:"string"` HsmConfigurationIdentifier *string `type:"string"` KmsKeyId *string `type:"string"` MaintenanceTrackName *string `type:"string"` ManualSnapshotRetentionPeriod *int64 `type:"integer"` MasterUserPassword *string `type:"string"` NewClusterIdentifier *string `type:"string"` NodeType *string `type:"string"` NumberOfNodes *int64 `type:"integer"` PreferredMaintenanceWindow *string `type:"string"` PubliclyAccessible *bool `type:"boolean"` VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"` }

AllowVersionUpgrade

Type: *bool

If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

Default: false

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.

If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

ClusterIdentifier

Type: *string

The unique identifier of the cluster to be modified.

Example: examplecluster

ClusterIdentifier is a required field

ClusterParameterGroupName

Type: *string

The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

Default: Uses existing setting.

Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

ClusterSecurityGroups

Type: []*string

A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.

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

ClusterType

Type: *string

The new cluster type.

When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

Valid Values: multi-node | single-node

ClusterVersion

Type: *string

The new version number of the Amazon Redshift engine to upgrade to.

For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) in the Amazon Redshift Cluster Management Guide.

Example: 1.0

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

Indicates whether the cluster is encrypted. If the cluster is encrypted and you provide a value for the KmsKeyId parameter, we will encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we will encrypt with the default key. In the China region we will use legacy encryption if you specify that the cluster is encrypted.

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.

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

The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.

ManualSnapshotRetentionPeriod

Type: *int64

The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.

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

The default value is -1.

MasterUserPassword

Type: *string

The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.

Default: Uses existing setting.

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

Type: *string

The new identifier for the cluster.

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

NodeType

Type: *string

The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

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

NumberOfNodes

Type: *int64

The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

Valid Values: Integer greater than 0.

PreferredMaintenanceWindow

Type: *string

The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

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

Constraints: Must be at least 30 minutes.

PubliclyAccessible

Type: *bool

If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

VpcSecurityGroupIds

Type: []*string

A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.

Method

GoString

func (s ModifyClusterInput) GoString() string

GoString returns the string representation

SetAllowVersionUpgrade

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

SetAllowVersionUpgrade sets the AllowVersionUpgrade field's value.

SetAutomatedSnapshotRetentionPeriod

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

SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.

SetClusterIdentifier

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

SetClusterIdentifier sets the ClusterIdentifier field's value.

SetClusterParameterGroupName

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

SetClusterParameterGroupName sets the ClusterParameterGroupName field's value.

SetClusterSecurityGroups

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

SetClusterSecurityGroups sets the ClusterSecurityGroups field's value.

SetClusterType

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

SetClusterType sets the ClusterType field's value.

SetClusterVersion

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

SetClusterVersion sets the ClusterVersion field's value.

SetElasticIp

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

SetElasticIp sets the ElasticIp field's value.

SetEncrypted

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

SetEncrypted sets the Encrypted field's value.

SetEnhancedVpcRouting

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

SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.

SetHsmClientCertificateIdentifier

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

SetHsmClientCertificateIdentifier sets the HsmClientCertificateIdentifier field's value.

SetHsmConfigurationIdentifier

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

SetHsmConfigurationIdentifier sets the HsmConfigurationIdentifier field's value.

SetKmsKeyId

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

SetKmsKeyId sets the KmsKeyId field's value.

SetMaintenanceTrackName

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

SetMaintenanceTrackName sets the MaintenanceTrackName field's value.

SetManualSnapshotRetentionPeriod

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

SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.

SetMasterUserPassword

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

SetMasterUserPassword sets the MasterUserPassword field's value.

SetNewClusterIdentifier

func (s *ModifyClusterInput) SetNewClusterIdentifier(v string) *ModifyClusterInput

SetNewClusterIdentifier sets the NewClusterIdentifier field's value.

SetNodeType

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

SetNodeType sets the NodeType field's value.

SetNumberOfNodes

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

SetNumberOfNodes sets the NumberOfNodes field's value.

SetPreferredMaintenanceWindow

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetPubliclyAccessible

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

SetVpcSecurityGroupIds

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

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

String

func (s ModifyClusterInput) String() string

String returns the string representation

Validate

func (s *ModifyClusterInput) Validate() error

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

On this page: