Class ProjectFileSystemLocation
- java.lang.Object
-
- software.amazon.awssdk.services.codebuild.model.ProjectFileSystemLocation
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ProjectFileSystemLocation.Builder,ProjectFileSystemLocation>
@Generated("software.amazon.awssdk:codegen") public final class ProjectFileSystemLocation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProjectFileSystemLocation.Builder,ProjectFileSystemLocation>
Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceProjectFileSystemLocation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ProjectFileSystemLocation.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringidentifier()The name used to access a file system created by Amazon EFS.Stringlocation()A string that specifies the location of the file system created by Amazon EFS.StringmountOptions()The mount options for a file system created by Amazon EFS.StringmountPoint()The location in the container where you mount the file system.List<SdkField<?>>sdkFields()static Class<? extends ProjectFileSystemLocation.Builder>serializableBuilderClass()ProjectFileSystemLocation.BuildertoBuilder()StringtoString()Returns a string representation of this object.FileSystemTypetype()The type of the file system.StringtypeAsString()The type of the file system.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
type
public final FileSystemType type()
The type of the file system. The one supported type is
EFS.If the service returns an enum value that is not available in the current SDK version,
typewill returnFileSystemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the file system. The one supported type is
EFS. - See Also:
FileSystemType
-
typeAsString
public final String typeAsString()
The type of the file system. The one supported type is
EFS.If the service returns an enum value that is not available in the current SDK version,
typewill returnFileSystemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the file system. The one supported type is
EFS. - See Also:
FileSystemType
-
location
public final String location()
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 isfs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory ismy-efs-mount-directory, then thelocationisfs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.The directory path in the format
efs-dns-name:/directory-pathis optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.- Returns:
- 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 isfs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory ismy-efs-mount-directory, then thelocationisfs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.The directory path in the format
efs-dns-name:/directory-pathis optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.
-
mountPoint
public final String mountPoint()
The location in the container where you mount the file system.
- Returns:
- The location in the container where you mount the file system.
-
identifier
public final String identifier()
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the
identifierin all capital letters toCODEBUILD_. For example, if you specifymy_efsforidentifier, a new environment variable is create namedCODEBUILD_MY_EFS.The
identifieris used to mount your file system.- Returns:
- The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by
appending the
identifierin all capital letters toCODEBUILD_. For example, if you specifymy_efsforidentifier, a new environment variable is create namedCODEBUILD_MY_EFS.The
identifieris used to mount your file system.
-
mountOptions
public final String mountOptions()
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:
- 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.
-
toBuilder
public ProjectFileSystemLocation.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ProjectFileSystemLocation.Builder,ProjectFileSystemLocation>
-
builder
public static ProjectFileSystemLocation.Builder builder()
-
serializableBuilderClass
public static Class<? extends ProjectFileSystemLocation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-