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.

RestoreFromClusterSnapshotInput

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

type RestoreFromClusterSnapshotInput 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"` ElasticIp *string `type:"string"` 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"` NodeType *string `type:"string"` OwnerAccount *string `type:"string"` Port *int64 `type:"integer"` PreferredMaintenanceWindow *string `type:"string"` PubliclyAccessible *bool `type:"boolean"` SnapshotClusterIdentifier *string `type:"string"` SnapshotIdentifier *string `type:"string" required:"true"` SnapshotScheduleIdentifier *string `type:"string"` 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.

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: The value selected for the cluster from which the snapshot was taken.

Constraints: Must be a value from 0 to 35.

AvailabilityZone

Type: *string

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-1a

ClusterIdentifier

Type: *string

The identifier of the cluster that will be created from restoring the snapshot.

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.

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.

Cluster security groups only apply to clusters outside of VPCs.

ClusterSubnetGroupName

Type: *string

The name of the subnet group where you want to cluster restored.

A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.

ElasticIp

Type: *string

The elastic IP (EIP) address for the cluster.

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 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 that you restore from a shared snapshot.

MaintenanceTrackName

Type: *string

The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.

ManualSnapshotRetentionPeriod

Type: *int64

NodeType

Type: *string

The node type that the restored cluster will be provisioned with.

Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlareg cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes) in the Amazon Redshift Cluster Management Guide.

OwnerAccount

Type: *string

The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

Port

Type: *int64

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 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: The value selected for the cluster from which the snapshot was taken. 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.

SnapshotClusterIdentifier

Type: *string

The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

SnapshotIdentifier

Type: *string

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

SnapshotIdentifier is a required field

SnapshotScheduleIdentifier

Type: *string

A unique identifier for the snapshot schedule.

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.

VPC security groups only apply to clusters in VPCs.

Method

GoString

func (s RestoreFromClusterSnapshotInput) GoString() string

GoString returns the string representation

SetAdditionalInfo

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

SetAdditionalInfo sets the AdditionalInfo field's value.

SetAllowVersionUpgrade

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

SetAllowVersionUpgrade sets the AllowVersionUpgrade field's value.

SetAutomatedSnapshotRetentionPeriod

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

SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.

SetAvailabilityZone

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

SetAvailabilityZone sets the AvailabilityZone field's value.

SetClusterIdentifier

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

SetClusterIdentifier sets the ClusterIdentifier field's value.

SetClusterParameterGroupName

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

SetClusterParameterGroupName sets the ClusterParameterGroupName field's value.

SetClusterSecurityGroups

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

SetClusterSecurityGroups sets the ClusterSecurityGroups field's value.

SetClusterSubnetGroupName

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

SetClusterSubnetGroupName sets the ClusterSubnetGroupName field's value.

SetElasticIp

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

SetElasticIp sets the ElasticIp field's value.

SetEnhancedVpcRouting

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

SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.

SetHsmClientCertificateIdentifier

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

SetHsmClientCertificateIdentifier sets the HsmClientCertificateIdentifier field's value.

SetHsmConfigurationIdentifier

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

SetHsmConfigurationIdentifier sets the HsmConfigurationIdentifier field's value.

SetIamRoles

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

SetIamRoles sets the IamRoles field's value.

SetKmsKeyId

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

SetKmsKeyId sets the KmsKeyId field's value.

SetMaintenanceTrackName

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

SetMaintenanceTrackName sets the MaintenanceTrackName field's value.

SetManualSnapshotRetentionPeriod

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

SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.

SetNodeType

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

SetNodeType sets the NodeType field's value.

SetOwnerAccount

func (s *RestoreFromClusterSnapshotInput) SetOwnerAccount(v string) *RestoreFromClusterSnapshotInput

SetOwnerAccount sets the OwnerAccount field's value.

SetPort

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

SetPort sets the Port field's value.

SetPreferredMaintenanceWindow

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetPubliclyAccessible

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

SetSnapshotClusterIdentifier

func (s *RestoreFromClusterSnapshotInput) SetSnapshotClusterIdentifier(v string) *RestoreFromClusterSnapshotInput

SetSnapshotClusterIdentifier sets the SnapshotClusterIdentifier field's value.

SetSnapshotIdentifier

func (s *RestoreFromClusterSnapshotInput) SetSnapshotIdentifier(v string) *RestoreFromClusterSnapshotInput

SetSnapshotIdentifier sets the SnapshotIdentifier field's value.

SetSnapshotScheduleIdentifier

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

SetSnapshotScheduleIdentifier sets the SnapshotScheduleIdentifier field's value.

SetVpcSecurityGroupIds

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

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

String

func (s RestoreFromClusterSnapshotInput) String() string

String returns the string representation

Validate

func (s *RestoreFromClusterSnapshotInput) Validate() error

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

On this page: