Interface WindowsFileSystemConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WindowsFileSystemConfiguration.Builder,WindowsFileSystemConfiguration>, SdkBuilder<WindowsFileSystemConfiguration.Builder,WindowsFileSystemConfiguration>, SdkPojo
Enclosing class:
WindowsFileSystemConfiguration

public static interface WindowsFileSystemConfiguration.Builder extends SdkPojo, CopyableBuilder<WindowsFileSystemConfiguration.Builder,WindowsFileSystemConfiguration>
  • Method Details

    • activeDirectoryId

      WindowsFileSystemConfiguration.Builder activeDirectoryId(String activeDirectoryId)

      The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

      Parameters:
      activeDirectoryId - The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • selfManagedActiveDirectoryConfiguration

      WindowsFileSystemConfiguration.Builder selfManagedActiveDirectoryConfiguration(SelfManagedActiveDirectoryAttributes selfManagedActiveDirectoryConfiguration)
      Sets the value of the SelfManagedActiveDirectoryConfiguration property for this object.
      Parameters:
      selfManagedActiveDirectoryConfiguration - The new value for the SelfManagedActiveDirectoryConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • selfManagedActiveDirectoryConfiguration

      default WindowsFileSystemConfiguration.Builder selfManagedActiveDirectoryConfiguration(Consumer<SelfManagedActiveDirectoryAttributes.Builder> selfManagedActiveDirectoryConfiguration)
      Sets the value of the SelfManagedActiveDirectoryConfiguration property for this object. This is a convenience method that creates an instance of the SelfManagedActiveDirectoryAttributes.Builder avoiding the need to create one manually via SelfManagedActiveDirectoryAttributes.builder().

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

      Parameters:
      selfManagedActiveDirectoryConfiguration - a consumer that will call methods on SelfManagedActiveDirectoryAttributes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • deploymentType

      WindowsFileSystemConfiguration.Builder deploymentType(String deploymentType)

      Specifies the file system deployment type, valid values are the following:

      • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

      • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

      • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

      For more information, see Single-AZ and Multi-AZ File Systems.

      Parameters:
      deploymentType - Specifies the file system deployment type, valid values are the following:

      • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

      • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

      • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

      For more information, see Single-AZ and Multi-AZ File Systems.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • deploymentType

      Specifies the file system deployment type, valid values are the following:

      • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

      • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

      • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

      For more information, see Single-AZ and Multi-AZ File Systems.

      Parameters:
      deploymentType - Specifies the file system deployment type, valid values are the following:

      • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

      • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

      • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

      For more information, see Single-AZ and Multi-AZ File Systems.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • remoteAdministrationEndpoint

      WindowsFileSystemConfiguration.Builder remoteAdministrationEndpoint(String remoteAdministrationEndpoint)

      For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

      For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

      This endpoint is temporarily unavailable when the file system is undergoing maintenance.

      Parameters:
      remoteAdministrationEndpoint - For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

      For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

      This endpoint is temporarily unavailable when the file system is undergoing maintenance.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • preferredSubnetId

      WindowsFileSystemConfiguration.Builder preferredSubnetId(String preferredSubnetId)

      For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

      For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

      Parameters:
      preferredSubnetId - For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

      For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • preferredFileServerIp

      WindowsFileSystemConfiguration.Builder preferredFileServerIp(String preferredFileServerIp)

      For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

      Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

      Parameters:
      preferredFileServerIp - For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

      Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • throughputCapacity

      WindowsFileSystemConfiguration.Builder throughputCapacity(Integer throughputCapacity)

      The throughput of the Amazon FSx file system, measured in megabytes per second.

      Parameters:
      throughputCapacity - The throughput of the Amazon FSx file system, measured in megabytes per second.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maintenanceOperationsInProgressWithStrings

      WindowsFileSystemConfiguration.Builder maintenanceOperationsInProgressWithStrings(Collection<String> maintenanceOperationsInProgress)

      The list of maintenance operations in progress for this file system.

      Parameters:
      maintenanceOperationsInProgress - The list of maintenance operations in progress for this file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maintenanceOperationsInProgressWithStrings

      WindowsFileSystemConfiguration.Builder maintenanceOperationsInProgressWithStrings(String... maintenanceOperationsInProgress)

      The list of maintenance operations in progress for this file system.

      Parameters:
      maintenanceOperationsInProgress - The list of maintenance operations in progress for this file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maintenanceOperationsInProgress

      WindowsFileSystemConfiguration.Builder maintenanceOperationsInProgress(Collection<FileSystemMaintenanceOperation> maintenanceOperationsInProgress)

      The list of maintenance operations in progress for this file system.

      Parameters:
      maintenanceOperationsInProgress - The list of maintenance operations in progress for this file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maintenanceOperationsInProgress

      WindowsFileSystemConfiguration.Builder maintenanceOperationsInProgress(FileSystemMaintenanceOperation... maintenanceOperationsInProgress)

      The list of maintenance operations in progress for this file system.

      Parameters:
      maintenanceOperationsInProgress - The list of maintenance operations in progress for this file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • weeklyMaintenanceStartTime

      WindowsFileSystemConfiguration.Builder weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)

      The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

      Parameters:
      weeklyMaintenanceStartTime - The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dailyAutomaticBackupStartTime

      WindowsFileSystemConfiguration.Builder dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)

      The preferred time to take daily automatic backups, in the UTC time zone.

      Parameters:
      dailyAutomaticBackupStartTime - The preferred time to take daily automatic backups, in the UTC time zone.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • automaticBackupRetentionDays

      WindowsFileSystemConfiguration.Builder automaticBackupRetentionDays(Integer automaticBackupRetentionDays)

      The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

      Parameters:
      automaticBackupRetentionDays - The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • copyTagsToBackups

      WindowsFileSystemConfiguration.Builder copyTagsToBackups(Boolean copyTagsToBackups)

      A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

      Parameters:
      copyTagsToBackups - A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • aliases

      Sets the value of the Aliases property for this object.
      Parameters:
      aliases - The new value for the Aliases property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • aliases

      Sets the value of the Aliases property for this object.
      Parameters:
      aliases - The new value for the Aliases property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • aliases

      Sets the value of the Aliases property for this object. This is a convenience method that creates an instance of the Alias.Builder avoiding the need to create one manually via Alias.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to aliases(List<Alias>).

      Parameters:
      aliases - a consumer that will call methods on Alias.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • auditLogConfiguration

      WindowsFileSystemConfiguration.Builder auditLogConfiguration(WindowsAuditLogConfiguration auditLogConfiguration)

      The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

      Parameters:
      auditLogConfiguration - The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • auditLogConfiguration

      default WindowsFileSystemConfiguration.Builder auditLogConfiguration(Consumer<WindowsAuditLogConfiguration.Builder> auditLogConfiguration)

      The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

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

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

      Parameters:
      auditLogConfiguration - a consumer that will call methods on WindowsAuditLogConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • diskIopsConfiguration

      WindowsFileSystemConfiguration.Builder diskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration)

      The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

      Parameters:
      diskIopsConfiguration - The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • diskIopsConfiguration

      default WindowsFileSystemConfiguration.Builder diskIopsConfiguration(Consumer<DiskIopsConfiguration.Builder> diskIopsConfiguration)

      The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

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

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

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