Class: AWSCDK::EFS::CfnAccessPoint::RootDirectoryProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::EFS::CfnAccessPoint::RootDirectoryProperty

Defined in:

efs/cfn_access_point.rb

Overview

Specifies the directory on the Amazon EFS file system that the access point provides access to.

The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's RootDirectory and its subdirectories.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-rootdirectory.html

Instance Attribute Summary

• #creation_info ⇒ AWSCDK::IResolvable, ... readonly

  (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory .

• #path ⇒ String^? readonly

  Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(creation_info: nil, path: nil) ⇒ RootDirectoryProperty constructor

  A new instance of RootDirectoryProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(creation_info: nil, path: nil) ⇒ RootDirectoryProperty

Returns a new instance of RootDirectoryProperty.

Parameters:

• creation_info (AWSCDK::IResolvable, AWSCDK::EFS::CfnAccessPoint::CreationInfoProperty, nil) (defaults to: nil) —

  (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory .

• path (String, nil) (defaults to: nil) —

  Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system.

# File 'efs/cfn_access_point.rb', line 775

def initialize(creation_info: nil, path: nil)
  @creation_info = creation_info.is_a?(Hash) ? ::AWSCDK::EFS::CfnAccessPoint::CreationInfoProperty.new(**creation_info.transform_keys(&:to_sym)) : creation_info
  Jsii::Type.check_type(@creation_info, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lZnMuQ2ZuQWNjZXNzUG9pbnQuQ3JlYXRpb25JbmZvUHJvcGVydHkifV19fQ==")), "creationInfo") unless @creation_info.nil?
  @path = path
  Jsii::Type.check_type(@path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") unless @path.nil?
end

Instance Attribute Details

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

(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory .

If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo , you must provide values for all properties.

If you do not provide CreationInfo and the specified RootDirectory > Path does not exist, attempts to mount the file system using the access point will fail.

Returns:

• (AWSCDK::IResolvable, AWSCDK::EFS::CfnAccessPoint::CreationInfoProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-rootdirectory.html#cfn-efs-accesspoint-rootdirectory-creationinfo

# File 'efs/cfn_access_point.rb', line 790

def creation_info
  @creation_info
end

#path ⇒ String^? (readonly)

Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system.

A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-accesspoint-rootdirectory.html#cfn-efs-accesspoint-rootdirectory-path

# File 'efs/cfn_access_point.rb', line 797

def path
  @path
end

Class Method Details

.jsii_properties ⇒ Object

# File 'efs/cfn_access_point.rb', line 799

def self.jsii_properties
  {
    :creation_info => "creationInfo",
    :path => "path",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'efs/cfn_access_point.rb', line 806

def to_jsii
  result = {}
  result.merge!({
    "creationInfo" => @creation_info,
    "path" => @path,
  })
  result.compact
end