Class: AWSCDK::EFS::CfnAccessPointProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
efs/cfn_access_point_props.rb

Overview

Properties for defining a CfnAccessPoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file_system_id:, access_point_tags: nil, client_token: nil, posix_user: nil, root_directory: nil) ⇒ CfnAccessPointProps

Returns a new instance of CfnAccessPointProps.

Parameters:



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'efs/cfn_access_point_props.rb', line 14

def initialize(file_system_id:, access_point_tags: nil, client_token: nil, posix_user: nil, root_directory: nil)
  @file_system_id = file_system_id
  Jsii::Type.check_type(@file_system_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lZnMuSUZpbGVTeXN0ZW1SZWYifV19fQ==")), "fileSystemId")
  @access_point_tags = access_point_tags.is_a?(Array) ? access_point_tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::EFS::CfnAccessPoint::AccessPointTagProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : access_point_tags
  Jsii::Type.check_type(@access_point_tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lZnMuQ2ZuQWNjZXNzUG9pbnQuQWNjZXNzUG9pbnRUYWdQcm9wZXJ0eSJ9LCJraW5kIjoiYXJyYXkifX0=")), "accessPointTags") unless @access_point_tags.nil?
  @client_token = client_token
  Jsii::Type.check_type(@client_token, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientToken") unless @client_token.nil?
  @posix_user = posix_user.is_a?(Hash) ? ::AWSCDK::EFS::CfnAccessPoint::PosixUserProperty.new(**posix_user.transform_keys(&:to_sym)) : posix_user
  Jsii::Type.check_type(@posix_user, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lZnMuQ2ZuQWNjZXNzUG9pbnQuUG9zaXhVc2VyUHJvcGVydHkifV19fQ==")), "posixUser") unless @posix_user.nil?
  @root_directory = root_directory.is_a?(Hash) ? ::AWSCDK::EFS::CfnAccessPoint::RootDirectoryProperty.new(**root_directory.transform_keys(&:to_sym)) : root_directory
  Jsii::Type.check_type(@root_directory, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lZnMuQ2ZuQWNjZXNzUG9pbnQuUm9vdERpcmVjdG9yeVByb3BlcnR5In1dfX0=")), "rootDirectory") unless @root_directory.nil?
end

Instance Attribute Details

#access_point_tags ⇒ Array<AWSCDK::EFS::CfnAccessPoint::AccessPointTagProperty>? (readonly)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Returns:

See Also:



40
41
42
 
# File 'efs/cfn_access_point_props.rb', line 40

def access_point_tags
  @access_point_tags
end

#client_token ⇒ String? (readonly)

The opaque string specified in the request to ensure idempotent creation.

Returns:

  • (String, nil)

See Also:



45
46
47
 
# File 'efs/cfn_access_point_props.rb', line 45

def client_token
  @client_token
end

#file_system_id ⇒ String, AWSCDK::Interfaces::AWSEFS::IFileSystemRef (readonly)

The ID of the EFS file system that the access point applies to.

Accepts only the ID format for input when specifying a file system, for example fs-0123456789abcedf2 .

Returns:

See Also:



33
34
35
 
# File 'efs/cfn_access_point_props.rb', line 33

def file_system_id
  @file_system_id
end

#posix_user ⇒ AWSCDK::IResolvable, ... (readonly)

The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

Returns:

See Also:



50
51
52
 
# File 'efs/cfn_access_point_props.rb', line 50

def posix_user
  @posix_user
end

#root_directory ⇒ AWSCDK::IResolvable, ... (readonly)

The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.

Returns:

See Also:



55
56
57
 
# File 'efs/cfn_access_point_props.rb', line 55

def root_directory
  @root_directory
end

Class Method Details

.jsii_properties ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'efs/cfn_access_point_props.rb', line 57

def self.jsii_properties
  {
    :file_system_id => "fileSystemId",
    :access_point_tags => "accessPointTags",
    :client_token => "clientToken",
    :posix_user => "posixUser",
    :root_directory => "rootDirectory",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
 
# File 'efs/cfn_access_point_props.rb', line 67

def to_jsii
  result = {}
  result.merge!({
    "fileSystemId" => @file_system_id,
    "accessPointTags" => @access_point_tags,
    "clientToken" => @client_token,
    "posixUser" => @posix_user,
    "rootDirectory" => @root_directory,
  })
  result.compact
end