Snapshot - Amazon FSx
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Snapshot

A snapshot of an Amazon FSx for OpenZFS volume.

Contents

AdministrativeActions

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.

Type: Array of AdministrativeAction objects

Array Members: Maximum number of 50 items.

Required: No

CreationTime

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

Type: Timestamp

Required: No

Lifecycle

The lifecycle status of the snapshot.

  • PENDING - Amazon FSx hasn't started creating the snapshot.

  • CREATING - Amazon FSx is creating the snapshot.

  • DELETING - Amazon FSx is deleting the snapshot.

  • AVAILABLE - The snapshot is fully available.

Type: String

Valid Values: PENDING | CREATING | DELETING | AVAILABLE

Required: No

LifecycleTransitionReason

Describes why a resource lifecycle state changed.

Type: LifecycleTransitionReason object

Required: No

Name

The name of the snapshot.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 203.

Pattern: ^[a-zA-Z0-9_:.-]{1,203}$

Required: No

ResourceARN

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon. For more information, see Amazon Resource Names (ARNs) in the Amazon General Reference.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 512.

Pattern: ^arn:(?=[^:]+:fsx:[^:]+:\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\d{1,3}(\.\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\.)(?![^:]*\.-)[a-z0-9].*(?<!-)):){4}(?!/).{0,1024}$

Required: No

SnapshotId

The ID of the snapshot.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 28.

Pattern: ^((fs)?volsnap-[0-9a-f]{8,})$

Required: No

Tags

A list of Tag values, with a maximum of 50 elements.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

VolumeId

The ID of the volume that the snapshot is of.

Type: String

Length Constraints: Fixed length of 23.

Pattern: ^(fsvol-[0-9a-f]{17,})$

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: