software.amazon.awssdk.services.fsx.model

Class WindowsFileSystemConfiguration

java.lang.Object

software.amazon.awssdk.services.fsx.model.WindowsFileSystemConfiguration

All Implemented Interfaces:

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

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

The configuration for this Microsoft Windows file system.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WindowsFileSystemConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
String	activeDirectoryId() The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
List<Alias>	aliases() Returns the value of the Aliases property for this object.
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.
Integer	automaticBackupRetentionDays() The number of days to retain automatic backups.
static WindowsFileSystemConfiguration.Builder	builder()
Boolean	copyTagsToBackups() A boolean flag indicating whether tags on the file system should be copied to backups.
String	dailyAutomaticBackupStartTime() The preferred time to take daily automatic backups, 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()
boolean	hasMaintenanceOperationsInProgress() For responses, this returns true if the service returned a value for the MaintenanceOperationsInProgress property.
List<FileSystemMaintenanceOperation>	maintenanceOperationsInProgress() The list of maintenance operations in progress for this file system.
List<String>	maintenanceOperationsInProgressAsStrings() The list of maintenance operations in progress for this file system.
String	preferredFileServerIp() For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
String	preferredSubnetId() For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located.
String	remoteAdministrationEndpoint() For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
List<SdkField<?>>	sdkFields()
SelfManagedActiveDirectoryAttributes	selfManagedActiveDirectoryConfiguration() Returns the value of the SelfManagedActiveDirectoryConfiguration property for this object.
static Class<? extends WindowsFileSystemConfiguration.Builder>	serializableBuilderClass()
Integer	throughputCapacity() The throughput of the Amazon FSx file system, measured in megabytes per second.
WindowsFileSystemConfiguration.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.

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 instance that the file system is joined to.

Returns:

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

selfManagedActiveDirectoryConfiguration

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

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

See Also:

WindowsDeploymentType

deploymentTypeAsString

public final String deploymentTypeAsString()

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.

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

See Also:

WindowsDeploymentType

remoteAdministrationEndpoint

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

Returns:

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.

preferredSubnetId

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

Returns:

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.

preferredFileServerIp

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

Returns:

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.

throughputCapacity

public final Integer throughputCapacity()

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

Returns:

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

maintenanceOperationsInProgress

public final List<FileSystemMaintenanceOperation> maintenanceOperationsInProgress()

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

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 hasMaintenanceOperationsInProgress() method.

Returns:

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

hasMaintenanceOperationsInProgress

public final boolean hasMaintenanceOperationsInProgress()

For responses, this returns true if the service returned a value for the MaintenanceOperationsInProgress 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.

maintenanceOperationsInProgressAsStrings

public final List<String> maintenanceOperationsInProgressAsStrings()

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

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 hasMaintenanceOperationsInProgress() method.

Returns:

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

weeklyMaintenanceStartTime

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

Returns:

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.

dailyAutomaticBackupStartTime

public final String dailyAutomaticBackupStartTime()

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

Returns:

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

automaticBackupRetentionDays

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

Returns:

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.

copyTagsToBackups

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

Returns:

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.

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<Alias> aliases()

Returns the value of the Aliases property for this object.

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:

The value of the Aliases property for this object.

auditLogConfiguration

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

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 WindowsFileSystemConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WindowsFileSystemConfiguration.Builder,WindowsFileSystemConfiguration>

builder

public static WindowsFileSystemConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends WindowsFileSystemConfiguration.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