Class: Aws::EC2::Types::Snapshot

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Describes a snapshot.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_encryption_key_id ⇒ String

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.

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the snapshot.

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ Boolean

Indicates whether the snapshot is encrypted.

Returns:

  • (Boolean) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arn ⇒ String

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.

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#owner_alias ⇒ String

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.

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ String

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

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#progress ⇒ String

The progress of the snapshot, as a percentage.

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#restore_expiry_time ⇒ Time

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

Returns:

  • (Time) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_id ⇒ String

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

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#sse_type ⇒ String

Reserved for future use.

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The time stamp when the snapshot was initiated.

Returns:

  • (Time) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The snapshot state.

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#state_message ⇒ String

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (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.

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_tier ⇒ String

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.

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the snapshot.

Returns:



61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#volume_id ⇒ String

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.

Returns:

  • (String) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end

#volume_size ⇒ Integer

The size of the volume, in GiB.

Returns:

  • (Integer) 


61067
61068
61069
61070
61071
61072
61073
61074
61075
61076
61077
61078
61079
61080
61081
61082
61083
61084
61085
61086
61087
61088
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 61067

class Snapshot < Struct.new(
  :data_encryption_key_id,
  :description,
  :encrypted,
  :kms_key_id,
  :owner_id,
  :progress,
  :snapshot_id,
  :start_time,
  :state,
  :state_message,
  :volume_id,
  :volume_size,
  :owner_alias,
  :outpost_arn,
  :tags,
  :storage_tier,
  :restore_expiry_time,
  :sse_type)
  SENSITIVE = []
  include Aws::Structure
end