Class: Aws::FSx::Types::Volume

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::Volume

Includes:

Structure

Defined in:

lib/aws-sdk-fsx/types.rb

Overview

Describes an Amazon FSx volume.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #administrative_actions ⇒ Array<Types::AdministrativeAction>

  A list of administrative actions for the volume that are in process or waiting to be processed.

• #creation_time ⇒ Time

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

• #file_system_id ⇒ String

  The globally unique ID of the file system, assigned by Amazon FSx.

• #lifecycle ⇒ String

  The lifecycle status of the volume.

• #lifecycle_transition_reason ⇒ Types::LifecycleTransitionReason

  The reason why the volume lifecycle status changed.

• #name ⇒ String

  The name of the volume.

• #ontap_configuration ⇒ Types::OntapVolumeConfiguration

  The configuration of an Amazon FSx for NetApp ONTAP volume.

• #open_zfs_configuration ⇒ Types::OpenZFSVolumeConfiguration

  The configuration of an Amazon FSx for OpenZFS volume.

• #resource_arn ⇒ String

  The Amazon Resource Name (ARN) for a given resource.

• #tags ⇒ Array<Types::Tag>

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

• #volume_id ⇒ String

  The system-generated, unique ID of the volume.

• #volume_type ⇒ String

  The type of the volume.

Instance Attribute Details

#administrative_actions ⇒ Array<Types::AdministrativeAction>

A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the ‘UpdateVolume` action.

Returns:

• (Array<Types::AdministrativeAction>)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_id ⇒ String

The globally unique ID of the file system, assigned by Amazon FSx.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle ⇒ String

The lifecycle status of the volume.

• ‘AVAILABLE` - The volume is fully available for use.

• ‘CREATED` - The volume has been created.

• ‘CREATING` - Amazon FSx is creating the new volume.

• ‘DELETING` - Amazon FSx is deleting an existing volume.

• ‘FAILED` - Amazon FSx was unable to create the volume.

• ‘MISCONFIGURED` - The volume is in a failed but recoverable state.

• ‘PENDING` - Amazon FSx hasn’t started creating the volume.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_transition_reason ⇒ Types::LifecycleTransitionReason

The reason why the volume lifecycle status changed.

Returns:

• (Types::LifecycleTransitionReason)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the volume.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ontap_configuration ⇒ Types::OntapVolumeConfiguration

The configuration of an Amazon FSx for NetApp ONTAP volume.

Returns:

• (Types::OntapVolumeConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#open_zfs_configuration ⇒ Types::OpenZFSVolumeConfiguration

The configuration of an Amazon FSx for OpenZFS volume.

Returns:

• (Types::OpenZFSVolumeConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

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

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#volume_id ⇒ String

The system-generated, unique ID of the volume.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#volume_type ⇒ String

The type of the volume.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 9826

class Volume < Struct.new(
  :creation_time,
  :file_system_id,
  :lifecycle,
  :name,
  :ontap_configuration,
  :resource_arn,
  :tags,
  :volume_id,
  :volume_type,
  :lifecycle_transition_reason,
  :administrative_actions,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end