Class: AWSCDK::CodeBuild::CfnProject::ProjectFileSystemLocationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
code_build/cfn_project.rb

Overview

Information about a file system created by Amazon Elastic File System (EFS).

For more information, see What Is Amazon Elastic File System?

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identifier:, location:, mount_point:, type:, mount_options: nil) ⇒ ProjectFileSystemLocationProperty

Returns a new instance of ProjectFileSystemLocationProperty.

Parameters:

  • identifier (String) —

    The name used to access a file system created by Amazon EFS.

  • location (String) —

    A string that specifies the location of the file system created by Amazon EFS.

  • mount_point (String) —

    The location in the container where you mount the file system.

  • type (String) —

    The type of the file system.

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

    The mount options for a file system created by Amazon EFS.



1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
 
# File 'code_build/cfn_project.rb', line 1729

def initialize(identifier:, location:, mount_point:, type:, mount_options: nil)
  @identifier = identifier
  Jsii::Type.check_type(@identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identifier")
  @location = location
  Jsii::Type.check_type(@location, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "location")
  @mount_point = mount_point
  Jsii::Type.check_type(@mount_point, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mountPoint")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @mount_options = mount_options
  Jsii::Type.check_type(@mount_options, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mountOptions") unless @mount_options.nil?
end

Instance Attribute Details

#identifier ⇒ String (readonly)

The name used to access a file system created by Amazon EFS.

CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_ . For example, if you specify my_efs for identifier , a new environment variable is create named CODEBUILD_MY_EFS .

The identifier is used to mount your file system.

Returns:

  • (String)

See Also:



1750
1751
1752
 
# File 'code_build/cfn_project.rb', line 1750

def identifier
  @identifier
end

#location ⇒ String (readonly)

A string that specifies the location of the file system created by Amazon EFS.

Its format is efs-dns-name:/directory-path . You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com , and its mount directory is my-efs-mount-directory , then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory .

The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.

Returns:

  • (String)

See Also:



1759
1760
1761
 
# File 'code_build/cfn_project.rb', line 1759

def location
  @location
end

#mount_options ⇒ String? (readonly)

The mount options for a file system created by Amazon EFS.

The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2 . For more information, see Recommended NFS Mount Options .

Returns:

  • (String, nil)

See Also:



1778
1779
1780
 
# File 'code_build/cfn_project.rb', line 1778

def mount_options
  @mount_options
end

#mount_point ⇒ String (readonly)

The location in the container where you mount the file system.

Returns:

  • (String)

See Also:



1764
1765
1766
 
# File 'code_build/cfn_project.rb', line 1764

def mount_point
  @mount_point
end

#type ⇒ String (readonly)

The type of the file system.

The one supported type is EFS .

Returns:

  • (String)

See Also:



1771
1772
1773
 
# File 'code_build/cfn_project.rb', line 1771

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



1780
1781
1782
1783
1784
1785
1786
1787
1788
 
# File 'code_build/cfn_project.rb', line 1780

def self.jsii_properties
  {
    :identifier => "identifier",
    :location => "location",
    :mount_point => "mountPoint",
    :type => "type",
    :mount_options => "mountOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
 
# File 'code_build/cfn_project.rb', line 1790

def to_jsii
  result = {}
  result.merge!({
    "identifier" => @identifier,
    "location" => @location,
    "mountPoint" => @mount_point,
    "type" => @type,
    "mountOptions" => @mount_options,
  })
  result.compact
end