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.

Snapshot

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

type Snapshot struct { AccountsWithRestoreAccess []*AccountWithRestoreAccess `locationNameList:"AccountWithRestoreAccess" type:"list"` ActualIncrementalBackupSizeInMegaBytes *float64 `type:"double"` AvailabilityZone *string `type:"string"` BackupProgressInMegaBytes *float64 `type:"double"` ClusterCreateTime *time.Time `type:"timestamp"` ClusterIdentifier *string `type:"string"` ClusterVersion *string `type:"string"` CurrentBackupRateInMegaBytesPerSecond *float64 `type:"double"` DBName *string `type:"string"` ElapsedTimeInSeconds *int64 `type:"long"` Encrypted *bool `type:"boolean"` EncryptedWithHSM *bool `type:"boolean"` EnhancedVpcRouting *bool `type:"boolean"` EstimatedSecondsToCompletion *int64 `type:"long"` KmsKeyId *string `type:"string"` MaintenanceTrackName *string `type:"string"` ManualSnapshotRemainingDays *int64 `type:"integer"` ManualSnapshotRetentionPeriod *int64 `type:"integer"` MasterUsername *string `type:"string"` NodeType *string `type:"string"` NumberOfNodes *int64 `type:"integer"` OwnerAccount *string `type:"string"` Port *int64 `type:"integer"` RestorableNodeTypes []*string `locationNameList:"NodeType" type:"list"` SnapshotCreateTime *time.Time `type:"timestamp"` SnapshotIdentifier *string `type:"string"` SnapshotRetentionStartTime *time.Time `type:"timestamp"` SnapshotType *string `type:"string"` SourceRegion *string `type:"string"` Status *string `type:"string"` Tags []*Tag `locationNameList:"Tag" type:"list"` TotalBackupSizeInMegaBytes *float64 `type:"double"` VpcId *string `type:"string"` }

Describes a snapshot.

AccountsWithRestoreAccess

Describes an AWS customer account authorized to restore a snapshot.

ActualIncrementalBackupSizeInMegaBytes

Type: *float64

The size of the incremental backup.

AvailabilityZone

Type: *string

The Availability Zone in which the cluster was created.

BackupProgressInMegaBytes

Type: *float64

The number of megabytes that have been transferred to the snapshot backup.

ClusterCreateTime

Type: *time.Time

The time (UTC) when the cluster was originally created.

ClusterIdentifier

Type: *string

The identifier of the cluster for which the snapshot was taken.

ClusterVersion

Type: *string

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

CurrentBackupRateInMegaBytesPerSecond

Type: *float64

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

DBName

Type: *string

The name of the database that was created when the cluster was created.

ElapsedTimeInSeconds

Type: *int64

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Encrypted

Type: *bool

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

EncryptedWithHSM

Type: *bool

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

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

EstimatedSecondsToCompletion

Type: *int64

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

KmsKeyId

Type: *string

The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

MaintenanceTrackName

Type: *string

The name of the maintenance track for the snapshot.

ManualSnapshotRemainingDays

Type: *int64

The number of days until a manual snapshot will pass its retention period.

ManualSnapshotRetentionPeriod

Type: *int64

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

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

MasterUsername

Type: *string

The master user name for the cluster.

NodeType

Type: *string

The node type of the nodes in the cluster.

NumberOfNodes

Type: *int64

The number of nodes in the cluster.

OwnerAccount

Type: *string

For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Port

Type: *int64

The port that the cluster is listening on.

RestorableNodeTypes

Type: []*string

The list of node types that this cluster snapshot is able to restore into.

SnapshotCreateTime

Type: *time.Time

The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

SnapshotIdentifier

Type: *string

The snapshot identifier that is provided in the request.

SnapshotRetentionStartTime

Type: *time.Time

A timestamp representing the start of the retention period for the snapshot.

SnapshotType

Type: *string

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

SourceRegion

Type: *string

The source region from which the snapshot was copied.

Status

Type: *string

The snapshot status. The value of the status depends on the API operation used:

  • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

  • DescribeClusterSnapshots returns status as "creating", "available",

"final snapshot", or "failed".
  • DeleteClusterSnapshot returns status as "deleted".

Tags

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

TotalBackupSizeInMegaBytes

Type: *float64

The size of the complete set of backup data that would be used to restore the cluster.

VpcId

Type: *string

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Method

GoString

func (s Snapshot) GoString() string

GoString returns the string representation

SetAccountsWithRestoreAccess

func (s *Snapshot) SetAccountsWithRestoreAccess(v []*AccountWithRestoreAccess) *Snapshot

SetAccountsWithRestoreAccess sets the AccountsWithRestoreAccess field's value.

SetActualIncrementalBackupSizeInMegaBytes

func (s *Snapshot) SetActualIncrementalBackupSizeInMegaBytes(v float64) *Snapshot

SetActualIncrementalBackupSizeInMegaBytes sets the ActualIncrementalBackupSizeInMegaBytes field's value.

SetAvailabilityZone

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

SetAvailabilityZone sets the AvailabilityZone field's value.

SetBackupProgressInMegaBytes

func (s *Snapshot) SetBackupProgressInMegaBytes(v float64) *Snapshot

SetBackupProgressInMegaBytes sets the BackupProgressInMegaBytes field's value.

SetClusterCreateTime

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

SetClusterCreateTime sets the ClusterCreateTime field's value.

SetClusterIdentifier

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

SetClusterIdentifier sets the ClusterIdentifier field's value.

SetClusterVersion

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

SetClusterVersion sets the ClusterVersion field's value.

SetCurrentBackupRateInMegaBytesPerSecond

func (s *Snapshot) SetCurrentBackupRateInMegaBytesPerSecond(v float64) *Snapshot

SetCurrentBackupRateInMegaBytesPerSecond sets the CurrentBackupRateInMegaBytesPerSecond field's value.

SetDBName

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

SetDBName sets the DBName field's value.

SetElapsedTimeInSeconds

func (s *Snapshot) SetElapsedTimeInSeconds(v int64) *Snapshot

SetElapsedTimeInSeconds sets the ElapsedTimeInSeconds field's value.

SetEncrypted

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

SetEncrypted sets the Encrypted field's value.

SetEncryptedWithHSM

func (s *Snapshot) SetEncryptedWithHSM(v bool) *Snapshot

SetEncryptedWithHSM sets the EncryptedWithHSM field's value.

SetEnhancedVpcRouting

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

SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.

SetEstimatedSecondsToCompletion

func (s *Snapshot) SetEstimatedSecondsToCompletion(v int64) *Snapshot

SetEstimatedSecondsToCompletion sets the EstimatedSecondsToCompletion field's value.

SetKmsKeyId

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

SetKmsKeyId sets the KmsKeyId field's value.

SetMaintenanceTrackName

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

SetMaintenanceTrackName sets the MaintenanceTrackName field's value.

SetManualSnapshotRemainingDays

func (s *Snapshot) SetManualSnapshotRemainingDays(v int64) *Snapshot

SetManualSnapshotRemainingDays sets the ManualSnapshotRemainingDays field's value.

SetManualSnapshotRetentionPeriod

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

SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.

SetMasterUsername

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

SetMasterUsername sets the MasterUsername field's value.

SetNodeType

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

SetNodeType sets the NodeType field's value.

SetNumberOfNodes

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

SetNumberOfNodes sets the NumberOfNodes field's value.

SetOwnerAccount

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

SetOwnerAccount sets the OwnerAccount field's value.

SetPort

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

SetPort sets the Port field's value.

SetRestorableNodeTypes

func (s *Snapshot) SetRestorableNodeTypes(v []*string) *Snapshot

SetRestorableNodeTypes sets the RestorableNodeTypes field's value.

SetSnapshotCreateTime

func (s *Snapshot) SetSnapshotCreateTime(v time.Time) *Snapshot

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

SetSnapshotIdentifier

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

SetSnapshotIdentifier sets the SnapshotIdentifier field's value.

SetSnapshotRetentionStartTime

func (s *Snapshot) SetSnapshotRetentionStartTime(v time.Time) *Snapshot

SetSnapshotRetentionStartTime sets the SnapshotRetentionStartTime field's value.

SetSnapshotType

func (s *Snapshot) SetSnapshotType(v string) *Snapshot

SetSnapshotType sets the SnapshotType field's value.

SetSourceRegion

func (s *Snapshot) SetSourceRegion(v string) *Snapshot

SetSourceRegion sets the SourceRegion field's value.

SetStatus

func (s *Snapshot) SetStatus(v string) *Snapshot

SetStatus sets the Status field's value.

SetTags

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

SetTags sets the Tags field's value.

SetTotalBackupSizeInMegaBytes

func (s *Snapshot) SetTotalBackupSizeInMegaBytes(v float64) *Snapshot

SetTotalBackupSizeInMegaBytes sets the TotalBackupSizeInMegaBytes field's value.

SetVpcId

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

SetVpcId sets the VpcId field's value.

String

func (s Snapshot) String() string

String returns the string representation

On this page: