You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EFS::Types::FileSystemDescription

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

Overview

Description of the file system.

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

Returns:

  • (Time)


496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 496

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :creation_time,
  :life_cycle_state,
  :name,
  :number_of_mount_targets,
  :size_in_bytes,
  :performance_mode,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#creation_tokenString

Opaque string specified in the request.

Returns:

  • (String)


496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 496

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :creation_time,
  :life_cycle_state,
  :name,
  :number_of_mount_targets,
  :size_in_bytes,
  :performance_mode,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#encryptedBoolean

A boolean value that, if true, indicates that the file system is encrypted.

Returns:

  • (Boolean)


496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 496

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :creation_time,
  :life_cycle_state,
  :name,
  :number_of_mount_targets,
  :size_in_bytes,
  :performance_mode,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#file_system_idString

ID of the file system, assigned by Amazon EFS.

Returns:

  • (String)


496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 496

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :creation_time,
  :life_cycle_state,
  :name,
  :number_of_mount_targets,
  :size_in_bytes,
  :performance_mode,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#kms_key_idString

The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.

Returns:

  • (String)


496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 496

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :creation_time,
  :life_cycle_state,
  :name,
  :number_of_mount_targets,
  :size_in_bytes,
  :performance_mode,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#life_cycle_stateString

Lifecycle phase of the file system.

Returns:

  • (String)


496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 496

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :creation_time,
  :life_cycle_state,
  :name,
  :number_of_mount_targets,
  :size_in_bytes,
  :performance_mode,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#nameString

You can add tags to a file system, including a Name tag. For more information, see CreateTags. If the file system has a Name tag, Amazon EFS returns the value in this field.

Returns:

  • (String)


496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 496

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :creation_time,
  :life_cycle_state,
  :name,
  :number_of_mount_targets,
  :size_in_bytes,
  :performance_mode,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#number_of_mount_targetsInteger

Current number of mount targets that the file system has. For more information, see CreateMountTarget.

Returns:

  • (Integer)


496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 496

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :creation_time,
  :life_cycle_state,
  :name,
  :number_of_mount_targets,
  :size_in_bytes,
  :performance_mode,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#owner_idString

AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.

Returns:

  • (String)


496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 496

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :creation_time,
  :life_cycle_state,
  :name,
  :number_of_mount_targets,
  :size_in_bytes,
  :performance_mode,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#performance_modeString

The PerformanceMode of the file system.

Returns:

  • (String)


496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 496

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :creation_time,
  :life_cycle_state,
  :name,
  :number_of_mount_targets,
  :size_in_bytes,
  :performance_mode,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end

#size_in_bytesTypes::FileSystemSize

Latest known metered size (in bytes) of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.



496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 496

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :creation_time,
  :life_cycle_state,
  :name,
  :number_of_mount_targets,
  :size_in_bytes,
  :performance_mode,
  :encrypted,
  :kms_key_id)
  include Aws::Structure
end