Package software.amazon.awssdk.services.efs.model

Interface FileSystemDescription.Builder

    • Method Detail

      • ownerId

        FileSystemDescription.Builder ownerId​(String ownerId)

        The Amazon Web Services account that created the file system.

        Parameters:
        ownerId - The Amazon Web Services account that created the file system.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationToken

        FileSystemDescription.Builder creationToken​(String creationToken)

        The opaque string specified in the request.

        Parameters:
        creationToken - The opaque string specified in the request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fileSystemId

        FileSystemDescription.Builder fileSystemId​(String fileSystemId)

        The ID of the file system, assigned by Amazon EFS.

        Parameters:
        fileSystemId - The ID of the file system, assigned by Amazon EFS.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fileSystemArn

        FileSystemDescription.Builder fileSystemArn​(String fileSystemArn)

        The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

        Parameters:
        fileSystemArn - The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTime

        FileSystemDescription.Builder creationTime​(Instant creationTime)

        The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

        Parameters:
        creationTime - The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lifeCycleState

        FileSystemDescription.Builder lifeCycleState​(String lifeCycleState)

        The lifecycle phase of the file system.

        Parameters:
        lifeCycleState - The lifecycle phase of the file system.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LifeCycleState, LifeCycleState

      • name

        FileSystemDescription.Builder name​(String name)

        You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this field.

        Parameters:
        name - You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • numberOfMountTargets

        FileSystemDescription.Builder numberOfMountTargets​(Integer numberOfMountTargets)

        The current number of mount targets that the file system has. For more information, see CreateMountTarget.

        Parameters:
        numberOfMountTargets - The current number of mount targets that the file system has. For more information, see CreateMountTarget.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sizeInBytes

        FileSystemDescription.Builder sizeInBytes​(FileSystemSize sizeInBytes)

        The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.

        Parameters:
        sizeInBytes - The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sizeInBytes

        default FileSystemDescription.Builder sizeInBytes​(Consumer<FileSystemSize.Builder> sizeInBytes)

        The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.

        This is a convenience method that creates an instance of the FileSystemSize.Builder avoiding the need to create one manually via FileSystemSize.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sizeInBytes(FileSystemSize).

        Parameters:
        sizeInBytes - a consumer that will call methods on FileSystemSize.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        sizeInBytes(FileSystemSize)

      • performanceMode

        FileSystemDescription.Builder performanceMode​(String performanceMode)

        The performance mode of the file system.

        Parameters:
        performanceMode - The performance mode of the file system.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PerformanceMode, PerformanceMode

      • encrypted

        FileSystemDescription.Builder encrypted​(Boolean encrypted)

        A Boolean value that, if true, indicates that the file system is encrypted.

        Parameters:
        encrypted - A Boolean value that, if true, indicates that the file system is encrypted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        FileSystemDescription.Builder kmsKeyId​(String kmsKeyId)

        The ID of an KMS key used to protect the encrypted file system.

        Parameters:
        kmsKeyId - The ID of an KMS key used to protect the encrypted file system.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • throughputMode

        FileSystemDescription.Builder throughputMode​(String throughputMode)

        Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.

        Parameters:
        throughputMode - Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ThroughputMode, ThroughputMode

      • provisionedThroughputInMibps

        FileSystemDescription.Builder provisionedThroughputInMibps​(Double provisionedThroughputInMibps)

        The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using ThroughputMode set to provisioned.

        Parameters:
        provisionedThroughputInMibps - The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using ThroughputMode set to provisioned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZoneName

        FileSystemDescription.Builder availabilityZoneName​(String availabilityZoneName)

        Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.

        Parameters:
        availabilityZoneName - Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZoneId

        FileSystemDescription.Builder availabilityZoneId​(String availabilityZoneId)

        The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.

        Parameters:
        availabilityZoneId - The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        FileSystemDescription.Builder tags​(Collection<Tag> tags)

        The tags associated with the file system, presented as an array of Tag objects.

        Parameters:
        tags - The tags associated with the file system, presented as an array of Tag objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        FileSystemDescription.Builder tags​(Tag... tags)

        The tags associated with the file system, presented as an array of Tag objects.

        Parameters:
        tags - The tags associated with the file system, presented as an array of Tag objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        FileSystemDescription.Builder tags​(Consumer<Tag.Builder>... tags)

        The tags associated with the file system, presented as an array of Tag objects.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • fileSystemProtection

        FileSystemDescription.Builder fileSystemProtection​(FileSystemProtectionDescription fileSystemProtection)

        Describes the protection on the file system.

        Parameters:
        fileSystemProtection - Describes the protection on the file system.
        Returns:
        Returns a reference to this object so that method calls can be chained together.