Class: Aws::FSx::Types::WindowsFileSystemConfiguration

Inherits:

Struct

Object
Struct
Aws::FSx::Types::WindowsFileSystemConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-fsx/types.rb

Overview

The configuration for this Microsoft Windows file system.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#active_directory_id ⇒ String

The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
#aliases ⇒ Array<Types::Alias>

An array of one or more DNS aliases that are currently associated with the Amazon FSx file system.
#audit_log_configuration ⇒ Types::WindowsAuditLogConfiguration

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.
#automatic_backup_retention_days ⇒ Integer

The number of days to retain automatic backups.
#copy_tags_to_backups ⇒ Boolean

A boolean flag indicating whether tags on the file system should be copied to backups.
#daily_automatic_backup_start_time ⇒ String

The preferred time to take daily automatic backups, in the UTC time zone.
#deployment_type ⇒ String

Specifies the file system deployment type, valid values are the following:.
#maintenance_operations_in_progress ⇒ Array<String>

The list of maintenance operations in progress for this file system.
#preferred_file_server_ip ⇒ String

For ‘MULTI_AZ_1` deployment types, the IP address of the primary, or preferred, file server.
#preferred_subnet_id ⇒ String

For ‘MULTI_AZ_1` deployment types, it specifies the ID of the subnet where the preferred file server is located.
#remote_administration_endpoint ⇒ String

For ‘MULTI_AZ_1` deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
#self_managed_active_directory_configuration ⇒ Types::SelfManagedActiveDirectoryAttributes

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.
#throughput_capacity ⇒ Integer

The throughput of the Amazon FSx file system, measured in megabytes per second.
#weekly_maintenance_start_time ⇒ String

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone.

Instance Attribute Details

#active_directory_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#aliases ⇒ `Array<Types::Alias>`

An array of one or more DNS aliases that are currently associated 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 [DNS aliases].

[1]: docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html

Returns:

(Array<Types::Alias>)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#audit_log_configuration ⇒ `Types::WindowsAuditLogConfiguration`

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:

(Types::WindowsAuditLogConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#automatic_backup_retention_days ⇒ `Integer`

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:

(Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_backups ⇒ `Boolean`

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:

(Boolean)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#daily_automatic_backup_start_time ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_type ⇒ `String`

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

[1]: docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_operations_in_progress ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_file_server_ip ⇒ `String`

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

[1]: docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_subnet_id ⇒ `String`

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

[1]: docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html#single-multi-az-resources

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#remote_administration_endpoint ⇒ `String`

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:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#self_managed_active_directory_configuration ⇒ `Types::SelfManagedActiveDirectoryAttributes`

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

Returns:

(Types::SelfManagedActiveDirectoryAttributes)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#throughput_capacity ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#weekly_maintenance_start_time ⇒ `String`

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:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 8842

class WindowsFileSystemConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :remote_administration_endpoint,
  :preferred_subnet_id,
  :preferred_file_server_ip,
  :throughput_capacity,
  :maintenance_operations_in_progress,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::FSx::Types::WindowsFileSystemConfiguration

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#active_directory_id ⇒ String

#aliases ⇒ Array<Types::Alias>

#audit_log_configuration ⇒ Types::WindowsAuditLogConfiguration

#automatic_backup_retention_days ⇒ Integer

#copy_tags_to_backups ⇒ Boolean

#daily_automatic_backup_start_time ⇒ String

#deployment_type ⇒ String

#maintenance_operations_in_progress ⇒ Array<String>

#preferred_file_server_ip ⇒ String

#preferred_subnet_id ⇒ String

#remote_administration_endpoint ⇒ String

#self_managed_active_directory_configuration ⇒ Types::SelfManagedActiveDirectoryAttributes

#throughput_capacity ⇒ Integer

#weekly_maintenance_start_time ⇒ String

#active_directory_id ⇒ `String`

#aliases ⇒ `Array<Types::Alias>`

#audit_log_configuration ⇒ `Types::WindowsAuditLogConfiguration`

#automatic_backup_retention_days ⇒ `Integer`

#copy_tags_to_backups ⇒ `Boolean`

#daily_automatic_backup_start_time ⇒ `String`

#deployment_type ⇒ `String`

#maintenance_operations_in_progress ⇒ `Array<String>`

#preferred_file_server_ip ⇒ `String`

#preferred_subnet_id ⇒ `String`

#remote_administration_endpoint ⇒ `String`

#self_managed_active_directory_configuration ⇒ `Types::SelfManagedActiveDirectoryAttributes`

#throughput_capacity ⇒ `Integer`

#weekly_maintenance_start_time ⇒ `String`