Class: AWSCDK::EFS::CfnAccessPoint::CreationInfoProperty

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

Overview

Required if the RootDirectory > Path specified does not exist.

Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory > Path . If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying CreationInfo , you must include values for all properties.

Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(owner_gid:, owner_uid:, permissions:) ⇒ CreationInfoProperty

Returns a new instance of CreationInfoProperty.

Parameters:

  • owner_gid (String) —

    Specifies the POSIX group ID to apply to the RootDirectory .

  • owner_uid (String) —

    Specifies the POSIX user ID to apply to the RootDirectory .

  • permissions (String) —

    Specifies the POSIX permissions to apply to the RootDirectory , in the format of an octal number representing the file's mode bits.



664
665
666
667
668
669
670
671
 
# File 'efs/cfn_access_point.rb', line 664

def initialize(owner_gid:, owner_uid:, permissions:)
  @owner_gid = owner_gid
  Jsii::Type.check_type(@owner_gid, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ownerGid")
  @owner_uid = owner_uid
  Jsii::Type.check_type(@owner_uid, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ownerUid")
  @permissions = permissions
  Jsii::Type.check_type(@permissions, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "permissions")
end

Instance Attribute Details

#owner_gid ⇒ String (readonly)

Specifies the POSIX group ID to apply to the RootDirectory .

Accepts values from 0 to 2^32 (4294967295).

Returns:

  • (String)

See Also:



679
680
681
 
# File 'efs/cfn_access_point.rb', line 679

def owner_gid
  @owner_gid
end

#owner_uid ⇒ String (readonly)

Specifies the POSIX user ID to apply to the RootDirectory .

Accepts values from 0 to 2^32 (4294967295).

Returns:

  • (String)

See Also:



686
687
688
 
# File 'efs/cfn_access_point.rb', line 686

def owner_uid
  @owner_uid
end

#permissions ⇒ String (readonly)

Specifies the POSIX permissions to apply to the RootDirectory , in the format of an octal number representing the file's mode bits.

Returns:

  • (String)

See Also:



691
692
693
 
# File 'efs/cfn_access_point.rb', line 691

def permissions
  @permissions
end

Class Method Details

.jsii_properties ⇒ Object 



693
694
695
696
697
698
699
 
# File 'efs/cfn_access_point.rb', line 693

def self.jsii_properties
  {
    :owner_gid => "ownerGid",
    :owner_uid => "ownerUid",
    :permissions => "permissions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



701
702
703
704
705
706
707
708
709
 
# File 'efs/cfn_access_point.rb', line 701

def to_jsii
  result = {}
  result.merge!({
    "ownerGid" => @owner_gid,
    "ownerUid" => @owner_uid,
    "permissions" => @permissions,
  })
  result.compact
end