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

Inherits:

Struct

Object
Struct
Aws::EFS::Types::FileSystemDescription

show all

Defined in:: gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb

Overview

A description of the file system.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#availability_zone_id ⇒ String
The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist.
#availability_zone_name ⇒ String
Describes the AWS Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes.
#creation_time ⇒ Time
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
#creation_token ⇒ String
The opaque string specified in the request.
#encrypted ⇒ Boolean
A Boolean value that, if true, indicates that the file system is encrypted.
#file_system_arn ⇒ String
The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id.
#file_system_id ⇒ String
The ID of the file system, assigned by Amazon EFS.
#kms_key_id ⇒ String
The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
#life_cycle_state ⇒ String
The lifecycle phase of the file system.
#name ⇒ String
You can add tags to a file system, including a Name tag.
#number_of_mount_targets ⇒ Integer
The current number of mount targets that the file system has.
#owner_id ⇒ String
The AWS account that created the file system.
#performance_mode ⇒ String
The performance mode of the file system.
#provisioned_throughput_in_mibps ⇒ Float
The amount of provisioned throughput, measured in MiB/s, for the file system.
#size_in_bytes ⇒ Types::FileSystemSize
The 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.
#tags ⇒ Array<Types::Tag>
The tags associated with the file system, presented as an array of Tag objects.
#throughput_mode ⇒ String
Displays the file system's throughput mode.

Instance Attribute Details

#availability_zone_id ⇒ `String`

The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. For example, use1-az1 is an Availability Zone ID for the us-east-1 AWS Region, and it has the same location in every AWS account.

Returns:

(String)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_name ⇒ `String`

Describes the AWS Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide.

Returns:

(String)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_token ⇒ `String`

The opaque string specified in the request.

Returns:

(String)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_arn ⇒ `String`

The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id. Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

Returns:

(String)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_id ⇒ `String`

The ID of the file system, assigned by Amazon EFS.

Returns:

(String)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

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)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#life_cycle_state ⇒ `String`

The lifecycle phase of the file system.

Returns:

(String)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_mount_targets ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ `String`

The 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)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#performance_mode ⇒ `String`

The performance mode of the file system.

Returns:

(String)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_throughput_in_mibps ⇒ `Float`

The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned.

Returns:

(Float)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#size_in_bytes ⇒ `Types::FileSystemSize`

The 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.

Returns:

(Types::FileSystemSize)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

The tags associated with the file system, presented as an array of Tag objects.

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#throughput_mode ⇒ `String`

Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.

Returns:

(String)

# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 1226

class FileSystemDescription < Struct.new(
  :owner_id,
  :creation_token,
  :file_system_id,
  :file_system_arn,
  :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,
  :availability_zone_name,
  :availability_zone_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone_id ⇒ String

#availability_zone_name ⇒ String

#creation_time ⇒ Time

#creation_token ⇒ String

#encrypted ⇒ Boolean

#file_system_arn ⇒ String

#file_system_id ⇒ String

#kms_key_id ⇒ String

#life_cycle_state ⇒ String

#name ⇒ String

#number_of_mount_targets ⇒ Integer

#owner_id ⇒ String

#performance_mode ⇒ String

#provisioned_throughput_in_mibps ⇒ Float

#size_in_bytes ⇒ Types::FileSystemSize

#tags ⇒ Array<Types::Tag>

#throughput_mode ⇒ String

#availability_zone_id ⇒ `String`

#availability_zone_name ⇒ `String`

#creation_time ⇒ `Time`

#creation_token ⇒ `String`

#encrypted ⇒ `Boolean`

#file_system_arn ⇒ `String`

#file_system_id ⇒ `String`

#kms_key_id ⇒ `String`

#life_cycle_state ⇒ `String`

#name ⇒ `String`

#number_of_mount_targets ⇒ `Integer`

#owner_id ⇒ `String`

#performance_mode ⇒ `String`

#provisioned_throughput_in_mibps ⇒ `Float`

#size_in_bytes ⇒ `Types::FileSystemSize`

#tags ⇒ `Array<Types::Tag>`

#throughput_mode ⇒ `String`