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)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#creation_tokenString

Opaque string specified in the request.

Returns:

  • (String)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#encryptedBoolean

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

Returns:

  • (Boolean)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#file_system_idString

ID of the file system, assigned by Amazon EFS.

Returns:

  • (String)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  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)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#life_cycle_stateString

Lifecycle phase of the file system.

Returns:

  • (String)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  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)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  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)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  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)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#performance_modeString

The PerformanceMode of the file system.

Returns:

  • (String)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#provisioned_throughput_in_mibpsFloat

The throughput, measured in MiB/s, that you want to provision for a file system. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.

Returns:

  • (Float)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#size_in_bytesTypes::FileSystemSize

Latest known metered size (in bytes) of data stored in the file system, 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. The SizeInBytes value doesn't 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, SizeInBytes represents 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 that the file system was at any point in time.



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end

#throughput_modeString

The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.

Returns:

  • (String)


542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 542

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,
  :throughput_mode,
  :provisioned_throughput_in_mibps)
  include Aws::Structure
end