Class: MintPress::Aws::EFS::FileSystem

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb

Properties (Read/Write)

  • #creation_token ⇒ [String]
    'Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.'
    Property Attributes
    • create_file_system_prop ⇒ 'creation_token'
    • read_only ⇒ false
    • source ⇒ "describe_file_systems"
    • describe_file_systems_prop ⇒ 'creation_token'
    

25
26
27
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 25

property :creation_token, create_file_system_prop: 'creation_token', type: [String], read_only: false, source: "describe_file_systems", description: 'Restricts the list to the file system with this creation
token (String). You specify a creation token when you create an Amazon
EFS file system.', describe_file_systems_prop: 'creation_token'
  • #performance_mode ⇒ [String]
    'The performance mode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can"t be changed after the file system has been created.'
    Property Attributes
    • create_file_system_prop ⇒ 'performance_mode'
    • read_only ⇒ false
    • source ⇒ "create_file_system"
    

28
29
30
31
32
33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 28

property :performance_mode, create_file_system_prop: 'performance_mode', type: [String], read_only: false, source: "create_file_system", description: 'The performance mode of the file system. We recommend generalPurpose
performance mode for most file systems. File systems using the maxIO
performance mode can scale to higher levels of aggregate throughput
and operations per second with a tradeoff of slightly higher latencies
for most file operations. The performance mode can"t be changed after
the file system has been created.'
  • #encrypted ⇒ [TrueClass,FalseClass]
    'A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don"t specify a CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.'
    Property Attributes
    • create_file_system_prop ⇒ 'encrypted'
    • read_only ⇒ false
    • source ⇒ "create_file_system"
    

34
35
36
37
38
39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 34

property :encrypted, create_file_system_prop: 'encrypted', type: [TrueClass,FalseClass], read_only: false, source: "create_file_system", description: 'A Boolean value that, if true, creates an encrypted file system. When
creating an encrypted file system, you have the option of specifying
CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management
Service (AWS KMS) customer master key (CMK). If you don"t specify a
CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem, is
used to protect the encrypted file system.'
  • #throughput_mode ⇒ [String]
    'The throughput mode that you want your file system to use. If you"re not updating your throughput mode, you don"t need to provide this value in your request. If you are changing the ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps.'
    Property Attributes
    • create_file_system_prop ⇒ 'throughput_mode'
    • read_only ⇒ false
    • source ⇒ "update_file_system"
    • update_file_system_prop ⇒ 'throughput_mode'
    

40
41
42
43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 40

property :throughput_mode, create_file_system_prop: 'throughput_mode', type: [String], read_only: false, source: "update_file_system", description: 'The throughput mode that you want your file system to use.
If you"re not updating your throughput mode, you don"t need to
provide this value in your request. If you are changing the
ThroughputMode to provisioned, you must also set a value for
ProvisionedThroughputInMibps.', update_file_system_prop: 'throughput_mode'
  • #provisioned_throughput_in_mibps ⇒ [Float]
    'The amount of throughput, in MiB/s, that you want to provision for your file system. Valid values are 1-1024. Required if ThroughputMode is changed to provisioned on update. If you"re not updating the amount of provisioned throughput for your file system, you don"t need to provide this value in your request.'
    Property Attributes
    • create_file_system_prop ⇒ 'provisioned_throughput_in_mibps'
    • read_only ⇒ false
    • source ⇒ "update_file_system"
    • update_file_system_prop ⇒ 'provisioned_throughput_in_mibps'
    

45
46
47
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 45

property :provisioned_throughput_in_mibps, create_file_system_prop: 'provisioned_throughput_in_mibps', type: [Float], read_only: false, source: "update_file_system", description: 'The amount of throughput, in MiB/s, that you want to
provision for your file system. Valid values are 1-1024. Required if
ThroughputMode is changed to provisioned on update. If you"re not
updating the amount of provisioned throughput for your file system,
you don"t need to provide this value in your request.', update_file_system_prop: 'provisioned_throughput_in_mibps'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EFS::Tag]
    'A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"\{value\}" key-value pair.'
    Property Attributes
    • create_file_system_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_file_system"
    

50
51
52
53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 50

property :tags, create_file_system_prop: 'tags', type: [MintPress::Aws::EFS::Tag], array: false, read_only: false, source: "create_file_system", description: 'A value that specifies to create one or more tags associated with the
file system. Each tag is a user-defined key-value pair. Name your file
system on creation by including a "Key":"Name","Value":"\{value\}"
key-value pair.', hash: true
  • #max_items ⇒ [Integer]
    'Specifies the maximum number of file systems to return in the response (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems.'
    Property Attributes
    • describe_file_systems_prop ⇒ 'max_items'
    • source ⇒ "describe_file_systems"
    

54
55
56
57
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 54

property :max_items, describe_file_systems_prop: 'max_items', type: [Integer], source: "describe_file_systems", description: 'Specifies the maximum number of file systems to return in
the response (integer). This number is automatically set to 100. The
response is paginated at 100 per page if you have more than 100 file
systems.'
  • #creation_time ⇒ [Time]
    'The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::FileSystemDescription"
    • orig_name ⇒ 'creation_time'
    

58
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 58

property :creation_time, disposition: :attribute, description: 'The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).', source: "Types::FileSystemDescription", orig_name: 'creation_time', type: [Time]
  • #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.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::FileSystemDescription"
    • orig_name ⇒ 'file_system_arn'
    

59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 59

property :file_system_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id.', source: "Types::FileSystemDescription", orig_name: 'file_system_arn', type: [String]
  • #life_cycle_state ⇒ [String]
    'The lifecycle phase of the file system.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::FileSystemDescription"
    • orig_name ⇒ 'life_cycle_state'
    

60
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 60

property :life_cycle_state, disposition: :attribute, description: 'The lifecycle phase of the file system.', source: "Types::FileSystemDescription", orig_name: 'life_cycle_state', type: [String]
  • #name ⇒ [String]
    'You can add tags to a file system, including a Name tag.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::FileSystemDescription"
    • orig_name ⇒ 'name'
    

61
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 61

property :name, disposition: :attribute, description: 'You can add tags to a file system, including a Name tag.', source: "Types::FileSystemDescription", orig_name: 'name', type: [String]
  • #number_of_mount_targets ⇒ [Integer]
    'The current number of mount targets that the file system has.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::FileSystemDescription"
    • orig_name ⇒ 'number_of_mount_targets'
    

62
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 62

property :number_of_mount_targets, disposition: :attribute, description: 'The current number of mount targets that the file system has.', source: "Types::FileSystemDescription", orig_name: 'number_of_mount_targets', type: [Integer]
  • #size_in_bytes ⇒ [MintPress::Aws::EFS::FileSystemSize] (Default Value: MintPress::Aws::EFS::FileSystemSize.new)
    '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.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::FileSystemDescription"
    • orig_name ⇒ 'size_in_bytes'
    • default ⇒ MintPress::Aws::EFS::FileSystemSize.new
    

63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 63

property :size_in_bytes, disposition: :attribute, description: '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.', source: "Types::FileSystemDescription", orig_name: 'size_in_bytes', type: [MintPress::Aws::EFS::FileSystemSize], default: MintPress::Aws::EFS::FileSystemSize.new
  • #kms_key ⇒ [String]
    'The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats: Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab. ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. Key alias - A previously created display name for a key, for example alias/projectKey1. Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1. If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true. EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file systems.'
    Property Attributes
    • create_file_system_prop ⇒ 'kms_key_id'
    • read_only ⇒ false
    • source ⇒ "create_file_system"
    

64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 64

property :kms_key, create_file_system_prop: 'kms_key_id', type: [String], read_only: false, source: "create_file_system", description: 'The ID of the AWS KMS CMK to be used to protect the encrypted file
system. This parameter is only required if you want to use a
nondefault CMK. If this parameter is not specified, the default CMK
for Amazon EFS is used. This ID can be in one of the following
formats:


Key ID - A unique identifier of the key, for example
1234abcd-12ab-34cd-56ef-1234567890ab.
ARN - An Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias - A previously created display name for a key, for example
alias/projectKey1.
Key alias ARN - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1.



If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted
parameter must be set to true.

EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with
EFS file systems.'
  • #id ⇒ [String]
    'The ID of the file system that you want to update.'
    Property Attributes
    • delete_file_system_prop ⇒ 'file_system_id'
    • read_only ⇒ false
    • source ⇒ "update_file_system"
    • describe_file_systems_prop ⇒ 'file_system_id'
    • update_file_system_prop ⇒ 'file_system_id'
    

87
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 87

property :id, delete_file_system_prop: 'file_system_id', type: [String], read_only: false, source: "update_file_system", description: 'The ID of the file system that you want to update.', describe_file_systems_prop: 'file_system_id', update_file_system_prop: 'file_system_id', array: false, hash: false
  • #owner ⇒ [String]
    'The AWS account that created the file system.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "Types::FileSystemDescription"
    • orig_name ⇒ 'owner_id'
    

88
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 88

property :owner, disposition: :attribute, description: 'The AWS account that created the file system.', source: "Types::FileSystemDescription", orig_name: 'owner_id', type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

92
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 92

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

95
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/file_system.rb', line 95

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ FileSystem

Returns a new instance of FileSystem.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#update ⇒ Object