AWSEC2Snapshot

Objective-C

@interface AWSEC2Snapshot

Swift

class AWSEC2Snapshot

Describes a snapshot.

  • The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable dataEncryptionKeyId;

    Swift

    var dataEncryptionKeyId: String? { get set }

  • The description for the snapshot.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable detail;

    Swift

    var detail: String? { get set }

  • Indicates whether the snapshot is encrypted.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable encrypted;

    Swift

    var encrypted: NSNumber? { get set }

  • The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable kmsKeyId;

    Swift

    var kmsKeyId: String? { get set }

  • The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable outpostArn;

    Swift

    var outpostArn: String? { get set }

  • The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable ownerAlias;

    Swift

    var ownerAlias: String? { get set }

  • The ID of the Amazon Web Services account that owns the EBS snapshot.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable ownerId;

    Swift

    var ownerId: String? { get set }

  • The progress of the snapshot, as a percentage.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable progress;

    Swift

    var progress: String? { get set }

  • Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable restoreExpiryTime;

    Swift

    var restoreExpiryTime: Date? { get set }

  • The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable snapshotId;

    Swift

    var snapshotId: String? { get set }

  • Reserved for future use.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2SSEType sseType;

    Swift

    var sseType: AWSEC2SSEType { get set }

  • The time stamp when the snapshot was initiated.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable startTime;

    Swift

    var startTime: Date? { get set }

  • The snapshot state.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2SnapshotState state;

    Swift

    var state: AWSEC2SnapshotState { get set }

  • Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper KMS permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable stateMessage;

    Swift

    var stateMessage: String? { get set }

  • The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2StorageTier storageTier;

    Swift

    var storageTier: AWSEC2StorageTier { get set }

  • Any tags assigned to the snapshot.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2Tag *> *_Nullable tags;

    Swift

    var tags: [AWSEC2Tag]? { get set }

  • The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable volumeId;

    Swift

    var volumeId: String? { get set }

  • The size of the volume, in GiB.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable volumeSize;

    Swift

    var volumeSize: NSNumber? { get set }