software.amazon.awssdk.services.fsx.model

Class CreateFileSystemWindowsConfiguration

java.lang.Object

software.amazon.awssdk.services.fsx.model.CreateFileSystemWindowsConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CreateFileSystemWindowsConfiguration.Builder,CreateFileSystemWindowsConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFileSystemWindowsConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CreateFileSystemWindowsConfiguration.Builder,CreateFileSystemWindowsConfiguration>

The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFileSystemWindowsConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
String	activeDirectoryId() The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
List<String>	aliases() An array of one or more DNS alias names that you want to associate with the Amazon FSx file system.
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.
Integer	automaticBackupRetentionDays() The number of days to retain automatic backups.
static CreateFileSystemWindowsConfiguration.Builder	builder()
Boolean	copyTagsToBackups() A boolean flag indicating whether tags for the file system should be copied to backups.
String	dailyAutomaticBackupStartTime() The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.
WindowsDeploymentType	deploymentType() Specifies the file system deployment type, valid values are the following:
String	deploymentTypeAsString() Specifies the file system deployment type, valid values are the following:
DiskIopsConfiguration	diskIopsConfiguration() The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAliases() For responses, this returns true if the service returned a value for the Aliases property.
int	hashCode()
String	preferredSubnetId() Required when DeploymentType is set to MULTI_AZ_1.
List<SdkField<?>>	sdkFields()
SelfManagedActiveDirectoryConfiguration	selfManagedActiveDirectoryConfiguration() Returns the value of the SelfManagedActiveDirectoryConfiguration property for this object.
static Class<? extends CreateFileSystemWindowsConfiguration.Builder>	serializableBuilderClass()
Integer	throughputCapacity() Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
CreateFileSystemWindowsConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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 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

activeDirectoryId

public final String activeDirectoryId()

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

Returns:

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

selfManagedActiveDirectoryConfiguration

public final SelfManagedActiveDirectoryConfiguration selfManagedActiveDirectoryConfiguration()

Returns the value of the SelfManagedActiveDirectoryConfiguration property for this object.

Returns:

The value of the SelfManagedActiveDirectoryConfiguration property for this object.

deploymentType

public final 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 Amazon Web Services 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.

If the service returns an enum value that is not available in the current SDK version, deploymentType will return WindowsDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

Returns:

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 Amazon Web Services 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.

See Also:

WindowsDeploymentType

deploymentTypeAsString

public final String deploymentTypeAsString()

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 Amazon Web Services 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.

If the service returns an enum value that is not available in the current SDK version, deploymentType will return WindowsDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

Returns:

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 Amazon Web Services 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.

See Also:

WindowsDeploymentType

preferredSubnetId

public final 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-Amazon Web Services 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:

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-Amazon Web Services 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.

throughputCapacity

public final Integer throughputCapacity()

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

Returns:

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

weeklyMaintenanceStartTime

public final 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.

Returns:

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.

dailyAutomaticBackupStartTime

public final String dailyAutomaticBackupStartTime()

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

Returns:

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

automaticBackupRetentionDays

public final Integer automaticBackupRetentionDays()

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

Returns:

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

copyTagsToBackups

public final 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.

Returns:

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.

hasAliases

public final boolean hasAliases()

For responses, this returns true if the service returned a value for the Aliases property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

aliases

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAliases() method.

Returns:

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.

auditLogConfiguration

public final 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.

Returns:

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.

diskIopsConfiguration

public final 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.

Returns:

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.

toBuilder

public CreateFileSystemWindowsConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFileSystemWindowsConfiguration.Builder,CreateFileSystemWindowsConfiguration>

builder

public static CreateFileSystemWindowsConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFileSystemWindowsConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo