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.

Cluster

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

type Cluster struct { AllowVersionUpgrade *bool `type:"boolean"` AutomatedSnapshotRetentionPeriod *int64 `type:"integer"` AvailabilityZone *string `type:"string"` ClusterCreateTime *time.Time `type:"timestamp"` ClusterIdentifier *string `type:"string"` ClusterNodes []*ClusterNode `type:"list"` ClusterParameterGroups []*ClusterParameterGroupStatus `locationNameList:"ClusterParameterGroup" type:"list"` ClusterPublicKey *string `type:"string"` ClusterRevisionNumber *string `type:"string"` ClusterSecurityGroups []*ClusterSecurityGroupMembership `locationNameList:"ClusterSecurityGroup" type:"list"` ClusterSnapshotCopyStatus *ClusterSnapshotCopyStatus `type:"structure"` ClusterStatus *string `type:"string"` ClusterSubnetGroupName *string `type:"string"` ClusterVersion *string `type:"string"` DBName *string `type:"string"` DataTransferProgress *DataTransferProgress `type:"structure"` DeferredMaintenanceWindows []*DeferredMaintenanceWindow `locationNameList:"DeferredMaintenanceWindow" type:"list"` ElasticIpStatus *ElasticIpStatus `type:"structure"` ElasticResizeNumberOfNodeOptions *string `type:"string"` Encrypted *bool `type:"boolean"` Endpoint *Endpoint `type:"structure"` EnhancedVpcRouting *bool `type:"boolean"` HsmStatus *HsmStatus `type:"structure"` IamRoles []*ClusterIamRole `locationNameList:"ClusterIamRole" type:"list"` KmsKeyId *string `type:"string"` MaintenanceTrackName *string `type:"string"` ManualSnapshotRetentionPeriod *int64 `type:"integer"` MasterUsername *string `type:"string"` ModifyStatus *string `type:"string"` NodeType *string `type:"string"` NumberOfNodes *int64 `type:"integer"` PendingActions []*string `type:"list"` PendingModifiedValues *PendingModifiedValues `type:"structure"` PreferredMaintenanceWindow *string `type:"string"` PubliclyAccessible *bool `type:"boolean"` ResizeInfo *ResizeInfo `type:"structure"` RestoreStatus *RestoreStatus `type:"structure"` SnapshotScheduleIdentifier *string `type:"string"` SnapshotScheduleState *string `type:"string" enum:"ScheduleState"` Tags []*Tag `locationNameList:"Tag" type:"list"` VpcId *string `type:"string"` VpcSecurityGroups []*VpcSecurityGroupMembership `locationNameList:"VpcSecurityGroup" type:"list"` }

Describes a cluster.

AllowVersionUpgrade

Type: *bool

A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

AutomatedSnapshotRetentionPeriod

Type: *int64

The number of days that automatic cluster snapshots are retained.

AvailabilityZone

Type: *string

The name of the Availability Zone in which the cluster is located.

ClusterCreateTime

Type: *time.Time

The date and time that the cluster was created.

ClusterIdentifier

Type: *string

The unique identifier of the cluster.

ClusterNodes

The identifier of a node in a cluster.

ClusterParameterGroups

Describes the status of a parameter group.

ClusterPublicKey

Type: *string

The public key for the cluster.

ClusterRevisionNumber

Type: *string

The specific revision number of the database in the cluster.

ClusterSecurityGroups

Describes a cluster security group.

ClusterSnapshotCopyStatus

Returns the destination region and retention period that are configured for cross-region snapshot copy.

ClusterStatus

Type: *string

The current state of the cluster. Possible values are the following:

  • available

  • available, prep-for-resize

  • available, resize-cleanup

  • cancelling-resize

  • creating

  • deleting

  • final-snapshot

  • hardware-failure

  • incompatible-hsm

  • incompatible-network

  • incompatible-parameters

  • incompatible-restore

  • modifying

  • rebooting

  • renaming

  • resizing

  • rotating-keys

  • storage-full

  • updating-hsm

ClusterSubnetGroupName

Type: *string

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

ClusterVersion

Type: *string

The version ID of the Amazon Redshift engine that is running on the cluster.

DBName

Type: *string

The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

DataTransferProgress

Describes the status of a cluster while it is in the process of resizing with an incremental resize.

DeferredMaintenanceWindows

Describes a deferred maintenance window

ElasticIpStatus

Describes the status of the elastic IP (EIP) address.

ElasticResizeNumberOfNodeOptions

Type: *string

The number of nodes that you can resize the cluster to with the elastic resize method.

Encrypted

Type: *bool

A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

Endpoint

Describes a connection endpoint.

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

HsmStatus

Describes the status of changes to HSM settings.

IamRoles

An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS services.

KmsKeyId

Type: *string

The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.

MaintenanceTrackName

Type: *string

The name of the maintenance track for the cluster.

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.

MasterUsername

Type: *string

The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

ModifyStatus

Type: *string

The status of a modify operation, if any, initiated for the cluster.

NodeType

Type: *string

The node type for the nodes in the cluster.

NumberOfNodes

Type: *int64

The number of compute nodes in the cluster.

PendingActions

Type: []*string

Cluster operations that are waiting to be started.

PendingModifiedValues

Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied.

PreferredMaintenanceWindow

Type: *string

The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

PubliclyAccessible

Type: *bool

A boolean value that, if true, indicates that the cluster can be accessed from a public network.

ResizeInfo

Describes a resize operation.

RestoreStatus

Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

SnapshotScheduleIdentifier

Type: *string

A unique identifier for the cluster snapshot schedule.

SnapshotScheduleState

Type: *string

The current state of the cluster snapshot schedule.

Tags

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

VpcId

Type: *string

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

VpcSecurityGroups

Describes the members of a VPC security group.

Method

GoString

func (s Cluster) GoString() string

GoString returns the string representation

SetAllowVersionUpgrade

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

SetAllowVersionUpgrade sets the AllowVersionUpgrade field's value.

SetAutomatedSnapshotRetentionPeriod

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

SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.

SetAvailabilityZone

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

SetAvailabilityZone sets the AvailabilityZone field's value.

SetClusterCreateTime

func (s *Cluster) SetClusterCreateTime(v time.Time) *Cluster

SetClusterCreateTime sets the ClusterCreateTime field's value.

SetClusterIdentifier

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

SetClusterIdentifier sets the ClusterIdentifier field's value.

SetClusterNodes

func (s *Cluster) SetClusterNodes(v []*ClusterNode) *Cluster

SetClusterNodes sets the ClusterNodes field's value.

SetClusterParameterGroups

func (s *Cluster) SetClusterParameterGroups(v []*ClusterParameterGroupStatus) *Cluster

SetClusterParameterGroups sets the ClusterParameterGroups field's value.

SetClusterPublicKey

func (s *Cluster) SetClusterPublicKey(v string) *Cluster

SetClusterPublicKey sets the ClusterPublicKey field's value.

SetClusterRevisionNumber

func (s *Cluster) SetClusterRevisionNumber(v string) *Cluster

SetClusterRevisionNumber sets the ClusterRevisionNumber field's value.

SetClusterSecurityGroups

func (s *Cluster) SetClusterSecurityGroups(v []*ClusterSecurityGroupMembership) *Cluster

SetClusterSecurityGroups sets the ClusterSecurityGroups field's value.

SetClusterSnapshotCopyStatus

func (s *Cluster) SetClusterSnapshotCopyStatus(v *ClusterSnapshotCopyStatus) *Cluster

SetClusterSnapshotCopyStatus sets the ClusterSnapshotCopyStatus field's value.

SetClusterStatus

func (s *Cluster) SetClusterStatus(v string) *Cluster

SetClusterStatus sets the ClusterStatus field's value.

SetClusterSubnetGroupName

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

SetClusterSubnetGroupName sets the ClusterSubnetGroupName field's value.

SetClusterVersion

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

SetClusterVersion sets the ClusterVersion field's value.

SetDBName

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

SetDBName sets the DBName field's value.

SetDataTransferProgress

func (s *Cluster) SetDataTransferProgress(v *DataTransferProgress) *Cluster

SetDataTransferProgress sets the DataTransferProgress field's value.

SetDeferredMaintenanceWindows

func (s *Cluster) SetDeferredMaintenanceWindows(v []*DeferredMaintenanceWindow) *Cluster

SetDeferredMaintenanceWindows sets the DeferredMaintenanceWindows field's value.

SetElasticIpStatus

func (s *Cluster) SetElasticIpStatus(v *ElasticIpStatus) *Cluster

SetElasticIpStatus sets the ElasticIpStatus field's value.

SetElasticResizeNumberOfNodeOptions

func (s *Cluster) SetElasticResizeNumberOfNodeOptions(v string) *Cluster

SetElasticResizeNumberOfNodeOptions sets the ElasticResizeNumberOfNodeOptions field's value.

SetEncrypted

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

SetEncrypted sets the Encrypted field's value.

SetEndpoint

func (s *Cluster) SetEndpoint(v *Endpoint) *Cluster

SetEndpoint sets the Endpoint field's value.

SetEnhancedVpcRouting

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

SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.

SetHsmStatus

func (s *Cluster) SetHsmStatus(v *HsmStatus) *Cluster

SetHsmStatus sets the HsmStatus field's value.

SetIamRoles

func (s *Cluster) SetIamRoles(v []*ClusterIamRole) *Cluster

SetIamRoles sets the IamRoles field's value.

SetKmsKeyId

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

SetKmsKeyId sets the KmsKeyId field's value.

SetMaintenanceTrackName

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

SetMaintenanceTrackName sets the MaintenanceTrackName field's value.

SetManualSnapshotRetentionPeriod

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

SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.

SetMasterUsername

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

SetMasterUsername sets the MasterUsername field's value.

SetModifyStatus

func (s *Cluster) SetModifyStatus(v string) *Cluster

SetModifyStatus sets the ModifyStatus field's value.

SetNodeType

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

SetNodeType sets the NodeType field's value.

SetNumberOfNodes

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

SetNumberOfNodes sets the NumberOfNodes field's value.

SetPendingActions

func (s *Cluster) SetPendingActions(v []*string) *Cluster

SetPendingActions sets the PendingActions field's value.

SetPendingModifiedValues

func (s *Cluster) SetPendingModifiedValues(v *PendingModifiedValues) *Cluster

SetPendingModifiedValues sets the PendingModifiedValues field's value.

SetPreferredMaintenanceWindow

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetPubliclyAccessible

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

SetResizeInfo

func (s *Cluster) SetResizeInfo(v *ResizeInfo) *Cluster

SetResizeInfo sets the ResizeInfo field's value.

SetRestoreStatus

func (s *Cluster) SetRestoreStatus(v *RestoreStatus) *Cluster

SetRestoreStatus sets the RestoreStatus field's value.

SetSnapshotScheduleIdentifier

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

SetSnapshotScheduleIdentifier sets the SnapshotScheduleIdentifier field's value.

SetSnapshotScheduleState

func (s *Cluster) SetSnapshotScheduleState(v string) *Cluster

SetSnapshotScheduleState sets the SnapshotScheduleState field's value.

SetTags

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

SetTags sets the Tags field's value.

SetVpcId

func (s *Cluster) SetVpcId(v string) *Cluster

SetVpcId sets the VpcId field's value.

SetVpcSecurityGroups

func (s *Cluster) SetVpcSecurityGroups(v []*VpcSecurityGroupMembership) *Cluster

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

String

func (s Cluster) String() string

String returns the string representation

On this page: