Class: MintPress::Aws::EFS::AccessPoint

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

Properties (Read/Write)

  • #client_token ⇒ [String]
    'A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation. A suitable default value is auto-generated. You should normally not need to pass this option.**'
    Property Attributes
    • create_access_point_prop ⇒ 'client_token'
    • read_only ⇒ false
    • source ⇒ "create_access_point"
    [View source]
    
25
26
27
28
29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 25

property :client_token, create_access_point_prop: 'client_token', type: [String], read_only: false, source: "create_access_point", description: 'A string of up to 64 ASCII characters that Amazon EFS uses to ensure
idempotent creation.

A suitable default value is auto-generated. You should normally
not need to pass this option.**'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EFS::Tag]
    'Creates tags associated with the access point. Each tag is a key-value pair.'
    Property Attributes
    • create_access_point_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_access_point"
    [View source]
    
30
31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 30

property :tags, create_access_point_prop: 'tags', type: [MintPress::Aws::EFS::Tag], array: false, read_only: false, source: "create_access_point", description: 'Creates tags associated with the access point. Each tag is a key-value
pair.', hash: true
  • #posix_user ⇒ [MintPress::Aws::EFS::PosixUser] (Default Value: MintPress::Aws::EFS::PosixUser.new)
    'The operating system user and group applied to all file system requests made using the access point.'
    Property Attributes
    • create_access_point_prop ⇒ 'posix_user'
    • default ⇒ MintPress::Aws::EFS::PosixUser.new
    • read_only ⇒ false
    • source ⇒ "create_access_point"
    [View source]
    
32
33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 32

property :posix_user, create_access_point_prop: 'posix_user', type: [MintPress::Aws::EFS::PosixUser], default: MintPress::Aws::EFS::PosixUser.new, read_only: false, source: "create_access_point", description: 'The operating system user and group applied to all file system
requests made using the access point.'
  • #root_directory ⇒ [MintPress::Aws::EFS::RootDirectory] (Default Value: MintPress::Aws::EFS::RootDirectory.new)
    'Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory > Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional.'
    Property Attributes
    • create_access_point_prop ⇒ 'root_directory'
    • default ⇒ MintPress::Aws::EFS::RootDirectory.new
    • read_only ⇒ false
    • source ⇒ "create_access_point"
    [View source]
    
34
35
36
37
38
39
40
41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 34

property :root_directory, create_access_point_prop: 'root_directory', type: [MintPress::Aws::EFS::RootDirectory], default: MintPress::Aws::EFS::RootDirectory.new, read_only: false, source: "create_access_point", description: 'Specifies the directory on the Amazon EFS file system that the access
point exposes as the root directory of your file system to NFS clients
using the access point. The clients using the access point can only
access the root directory and below. If the RootDirectory >
Path specified does not exist, EFS creates it and applies the
CreationInfo settings when a client connects to an access point.
When specifying a RootDirectory, you need to provide the Path, and
the CreationInfo is optional.'
  • #max_results ⇒ [Integer]
    'When retrieving all access points for a file system, you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. The default value is 100.'
    Property Attributes
    • describe_access_points_prop ⇒ 'max_results'
    • source ⇒ "describe_access_points"
    [View source]
    
42
43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 42

property :max_results, describe_access_points_prop: 'max_results', type: [Integer], source: "describe_access_points", description: 'When retrieving all access points for a file system, you
can optionally specify the MaxItems parameter to limit the number of
objects returned in a response. The default value is 100.'
  • #access_point_arn ⇒ [String]
    'The unique Amazon Resource Name (ARN) associated with the access point.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EFS::AccessPointDescription"
    • orig_name ⇒ 'access_point_arn'
    [View source]
    
45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 45

property :access_point_arn, disposition: :attribute, description: 'The unique Amazon Resource Name (ARN) associated with the access point.', source: "MintPress::Aws::EFS::AccessPointDescription", orig_name: 'access_point_arn', type: [String]
  • #life_cycle_state ⇒ [String]
    'Identifies the lifecycle phase of the access point.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EFS::AccessPointDescription"
    • orig_name ⇒ 'life_cycle_state'
    [View source]
    
46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 46

property :life_cycle_state, disposition: :attribute, description: 'Identifies the lifecycle phase of the access point.', source: "MintPress::Aws::EFS::AccessPointDescription", orig_name: 'life_cycle_state', type: [String]
  • #name ⇒ [String]
    'The name of the access point.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EFS::AccessPointDescription"
    • orig_name ⇒ 'name'
    [View source]
    
47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 47

property :name, disposition: :attribute, description: 'The name of the access point.', source: "MintPress::Aws::EFS::AccessPointDescription", orig_name: 'name', type: [String]
  • #file_system ⇒ [MintPress::Aws::EFS::FileSystem]
    'If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.'
    Property Attributes
    • create_access_point_prop ⇒ 'file_system_id'
    • read_only ⇒ false
    • source ⇒ "describe_access_points"
    • describe_access_points_prop ⇒ 'file_system_id'
    • from ⇒ String
    [View source]
    
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 48

property :file_system, create_access_point_prop: 'file_system_id', type: [MintPress::Aws::EFS::FileSystem], read_only: false, source: "describe_access_points", description: 'If you provide a FileSystemId, EFS returns all access
points for that file system; mutually exclusive with AccessPointId.', describe_access_points_prop: 'file_system_id', from: String
  • #id ⇒ [String]
    'Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.'
    Property Attributes
    • delete_access_point_prop ⇒ 'access_point_id'
    • read_only ⇒ false
    • source ⇒ "describe_access_points"
    • describe_access_points_prop ⇒ 'access_point_id'
    [View source]
    
50
51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 50

property :id, delete_access_point_prop: 'access_point_id', type: [String], read_only: false, source: "describe_access_points", description: 'Specifies an EFS access point to describe in the response;
mutually exclusive with FileSystemId.', describe_access_points_prop: 'access_point_id', array: false, hash: false
  • #owner ⇒ [String]
    'Identified the AWS account that owns the access point resource.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EFS::AccessPointDescription"
    • orig_name ⇒ 'owner_id'
    [View source]
    
52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 52

property :owner, disposition: :attribute, description: 'Identified the AWS account that owns the access point resource.', source: "MintPress::Aws::EFS::AccessPointDescription", 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
    [View source]
    
56
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 56

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
    [View source]
    
59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/efs/access_point.rb', line 59

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 = {}) ⇒ AccessPoint

Returns a new instance of AccessPoint.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object