software.amazon.awssdk.services.fsx.model

Interface CreateFileSystemWindowsConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CreateFileSystemWindowsConfiguration.Builder,CreateFileSystemWindowsConfiguration>, SdkBuilder<CreateFileSystemWindowsConfiguration.Builder,CreateFileSystemWindowsConfiguration>, SdkPojo

Enclosing class:

CreateFileSystemWindowsConfiguration

public static interface CreateFileSystemWindowsConfiguration.Builder
extends SdkPojo, CopyableBuilder<CreateFileSystemWindowsConfiguration.Builder,CreateFileSystemWindowsConfiguration>

Method Summary

Modifier and Type	Method and Description
CreateFileSystemWindowsConfiguration.Builder	activeDirectoryId(String activeDirectoryId) The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
CreateFileSystemWindowsConfiguration.Builder	aliases(Collection<String> aliases) An array of one or more DNS alias names that you want to associate with the Amazon FSx file system.
CreateFileSystemWindowsConfiguration.Builder	aliases(String... aliases) An array of one or more DNS alias names that you want to associate with the Amazon FSx file system.
default CreateFileSystemWindowsConfiguration.Builder	auditLogConfiguration(Consumer<WindowsAuditLogCreateConfiguration.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.
CreateFileSystemWindowsConfiguration.Builder	auditLogConfiguration(WindowsAuditLogCreateConfiguration 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.
CreateFileSystemWindowsConfiguration.Builder	automaticBackupRetentionDays(Integer automaticBackupRetentionDays) The number of days to retain automatic backups.
CreateFileSystemWindowsConfiguration.Builder	copyTagsToBackups(Boolean copyTagsToBackups) A boolean flag indicating whether tags for the file system should be copied to backups.
CreateFileSystemWindowsConfiguration.Builder	dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime) The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.
CreateFileSystemWindowsConfiguration.Builder	deploymentType(String deploymentType) Specifies the file system deployment type, valid values are the following:
CreateFileSystemWindowsConfiguration.Builder	deploymentType(WindowsDeploymentType deploymentType) Specifies the file system deployment type, valid values are the following:
CreateFileSystemWindowsConfiguration.Builder	preferredSubnetId(String preferredSubnetId) Required when DeploymentType is set to MULTI_AZ_1.
default CreateFileSystemWindowsConfiguration.Builder	selfManagedActiveDirectoryConfiguration(Consumer<SelfManagedActiveDirectoryConfiguration.Builder> selfManagedActiveDirectoryConfiguration) Sets the value of the SelfManagedActiveDirectoryConfiguration property for this object.
CreateFileSystemWindowsConfiguration.Builder	selfManagedActiveDirectoryConfiguration(SelfManagedActiveDirectoryConfiguration selfManagedActiveDirectoryConfiguration) Sets the value of the SelfManagedActiveDirectoryConfiguration property for this object.
CreateFileSystemWindowsConfiguration.Builder	throughputCapacity(Integer throughputCapacity) The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
CreateFileSystemWindowsConfiguration.Builder	weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

activeDirectoryId

CreateFileSystemWindowsConfiguration.Builder activeDirectoryId(String activeDirectoryId)

The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.

Parameters:

activeDirectoryId - The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.

Returns:

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

selfManagedActiveDirectoryConfiguration

CreateFileSystemWindowsConfiguration.Builder selfManagedActiveDirectoryConfiguration(SelfManagedActiveDirectoryConfiguration 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 CreateFileSystemWindowsConfiguration.Builder selfManagedActiveDirectoryConfiguration(Consumer<SelfManagedActiveDirectoryConfiguration.Builder> selfManagedActiveDirectoryConfiguration)

Sets the value of the SelfManagedActiveDirectoryConfiguration property for this object. This is a convenience that creates an instance of the SelfManagedActiveDirectoryConfiguration.Builder avoiding the need to create one manually via SelfManagedActiveDirectoryConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to selfManagedActiveDirectoryConfiguration(SelfManagedActiveDirectoryConfiguration).

Parameters:

selfManagedActiveDirectoryConfiguration - a consumer that will call methods on SelfManagedActiveDirectoryConfiguration.Builder

Returns:

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

See Also:

selfManagedActiveDirectoryConfiguration(SelfManagedActiveDirectoryConfiguration)

deploymentType

CreateFileSystemWindowsConfiguration.Builder deploymentType(String deploymentType)

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

• MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage type

• SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.

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

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

Parameters:

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

• MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage type

• SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.

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

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.

See Also:

WindowsDeploymentType, WindowsDeploymentType

deploymentType

CreateFileSystemWindowsConfiguration.Builder deploymentType(WindowsDeploymentType deploymentType)

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

• MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage type

• SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.

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

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

Parameters:

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

• MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage type

• SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.

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

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.

See Also:

WindowsDeploymentType, WindowsDeploymentType

preferredSubnetId

CreateFileSystemWindowsConfiguration.Builder preferredSubnetId(String preferredSubnetId)

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-AWS applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.

Parameters:

preferredSubnetId - Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-AWS applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.

Returns:

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

throughputCapacity

CreateFileSystemWindowsConfiguration.Builder throughputCapacity(Integer throughputCapacity)

The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).

Parameters:

throughputCapacity - The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).

Returns:

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

weeklyMaintenanceStartTime

CreateFileSystemWindowsConfiguration.Builder weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where 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, where 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

CreateFileSystemWindowsConfiguration.Builder dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)

The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.

Parameters:

dailyAutomaticBackupStartTime - The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.

Returns:

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

automaticBackupRetentionDays

CreateFileSystemWindowsConfiguration.Builder automaticBackupRetentionDays(Integer automaticBackupRetentionDays)

The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 90 days.

Parameters:

automaticBackupRetentionDays - The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 90 days.

Returns:

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

copyTagsToBackups

CreateFileSystemWindowsConfiguration.Builder copyTagsToBackups(Boolean copyTagsToBackups)

A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify 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 for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify 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

CreateFileSystemWindowsConfiguration.Builder aliases(Collection<String> aliases)

An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.

For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

An alias name has to meet the following requirements:

• Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

• Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

• Cannot start or end with a hyphen.

• Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

Parameters:

aliases - An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.

For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

An alias name has to meet the following requirements:

• Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

• Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

• Cannot start or end with a hyphen.

• Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

Returns:

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

aliases

CreateFileSystemWindowsConfiguration.Builder aliases(String... aliases)

An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.

For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

An alias name has to meet the following requirements:

• Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

• Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

• Cannot start or end with a hyphen.

• Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

Parameters:

aliases - An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.

For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

An alias name has to meet the following requirements:

• Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

• Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

• Cannot start or end with a hyphen.

• Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

Returns:

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

auditLogConfiguration

CreateFileSystemWindowsConfiguration.Builder auditLogConfiguration(WindowsAuditLogCreateConfiguration 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 CreateFileSystemWindowsConfiguration.Builder auditLogConfiguration(Consumer<WindowsAuditLogCreateConfiguration.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 that creates an instance of the WindowsAuditLogCreateConfiguration.Builder avoiding the need to create one manually via WindowsAuditLogCreateConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to auditLogConfiguration(WindowsAuditLogCreateConfiguration).

Parameters:

auditLogConfiguration - a consumer that will call methods on WindowsAuditLogCreateConfiguration.Builder

Returns:

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

See Also:

auditLogConfiguration(WindowsAuditLogCreateConfiguration)