Snapshot

public struct Snapshot : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

    Declaration

    Swift

    public let accountsWithRestoreAccess: [AccountWithRestoreAccess]?

  • The size of the incremental backup.

    Declaration

    Swift

    public let actualIncrementalBackupSizeInMegaBytes: Double?

  • The Availability Zone in which the cluster was created.

    Declaration

    Swift

    public let availabilityZone: String?

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

    Declaration

    Swift

    public let backupProgressInMegaBytes: Double?

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

    Declaration

    Swift

    public let clusterCreateTime: TimeStamp?

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

    Declaration

    Swift

    public let clusterIdentifier: String?

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

    Declaration

    Swift

    public let clusterVersion: String?

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

    Declaration

    Swift

    public let currentBackupRateInMegaBytesPerSecond: Double?

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

    Declaration

    Swift

    public let dBName: String?

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

    Declaration

    Swift

    public let elapsedTimeInSeconds: Int64?

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

    Declaration

    Swift

    public let encrypted: 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.

    Declaration

    Swift

    public let encryptedWithHSM: 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 in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false

    Declaration

    Swift

    public let enhancedVpcRouting: Bool?

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

    Declaration

    Swift

    public let estimatedSecondsToCompletion: Int64?

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

    Declaration

    Swift

    public let kmsKeyId: String?

  • The name of the maintenance track for the snapshot.

    Declaration

    Swift

    public let maintenanceTrackName: String?

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

    Declaration

    Swift

    public let manualSnapshotRemainingDays: Int?

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

    Declaration

    Swift

    public let manualSnapshotRetentionPeriod: Int?

  • The master user name for the cluster.

    Declaration

    Swift

    public let masterUsername: String?

  • The node type of the nodes in the cluster.

    Declaration

    Swift

    public let nodeType: String?

  • The number of nodes in the cluster.

    Declaration

    Swift

    public let numberOfNodes: Int?

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

    Declaration

    Swift

    public let ownerAccount: String?

  • The port that the cluster is listening on.

    Declaration

    Swift

    public let port: Int?

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

    Declaration

    Swift

    public let restorableNodeTypes: [String]?

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

    Declaration

    Swift

    public let snapshotCreateTime: TimeStamp?

  • The snapshot identifier that is provided in the request.

    Declaration

    Swift

    public let snapshotIdentifier: String?

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

    Declaration

    Swift

    public let snapshotRetentionStartTime: TimeStamp?

  • The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type “manual”.

    Declaration

    Swift

    public let snapshotType: String?

  • The source region from which the snapshot was copied.

    Declaration

    Swift

    public let sourceRegion: 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”.

    Declaration

    Swift

    public let status: String?

  • The list of tags for the cluster snapshot.

    Declaration

    Swift

    public let tags: [Tag]?

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

    Declaration

    Swift

    public let totalBackupSizeInMegaBytes: Double?

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

    Declaration

    Swift

    public let vpcId: String?

  • Undocumented

    Declaration

    Swift

    public init(accountsWithRestoreAccess: [AccountWithRestoreAccess]? = nil, actualIncrementalBackupSizeInMegaBytes: Double? = nil, availabilityZone: String? = nil, backupProgressInMegaBytes: Double? = nil, clusterCreateTime: TimeStamp? = nil, clusterIdentifier: String? = nil, clusterVersion: String? = nil, currentBackupRateInMegaBytesPerSecond: Double? = nil, dBName: String? = nil, elapsedTimeInSeconds: Int64? = nil, encrypted: Bool? = nil, encryptedWithHSM: Bool? = nil, enhancedVpcRouting: Bool? = nil, estimatedSecondsToCompletion: Int64? = nil, kmsKeyId: String? = nil, maintenanceTrackName: String? = nil, manualSnapshotRemainingDays: Int? = nil, manualSnapshotRetentionPeriod: Int? = nil, masterUsername: String? = nil, nodeType: String? = nil, numberOfNodes: Int? = nil, ownerAccount: String? = nil, port: Int? = nil, restorableNodeTypes: [String]? = nil, snapshotCreateTime: TimeStamp? = nil, snapshotIdentifier: String? = nil, snapshotRetentionStartTime: TimeStamp? = nil, snapshotType: String? = nil, sourceRegion: String? = nil, status: String? = nil, tags: [Tag]? = nil, totalBackupSizeInMegaBytes: Double? = nil, vpcId: String? = nil)