Class: Aws::FSx::Types::CreateFileSystemWindowsConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-fsx/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_directory_id ⇒ String

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:

  • (String) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

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

#aliases ⇒ Array<String>

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.

[1]: docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html [2]: docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html

Returns:

  • (Array<String>) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

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

#audit_log_configuration ⇒ Types::WindowsAuditLogCreateConfiguration

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:



2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

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

#automatic_backup_retention_days ⇒ Integer

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:

  • (Integer) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

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

#copy_tags_to_backups ⇒ Boolean

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:

  • (Boolean) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

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

#daily_automatic_backup_start_time ⇒ String

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

Returns:

  • (String) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

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

#deployment_type ⇒ String

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

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

Returns:

  • (String) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

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

#disk_iops_configuration ⇒ Types::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:



2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

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

#preferred_subnet_id ⇒ String

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:

  • (String) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

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

#self_managed_active_directory_configuration ⇒ Types::SelfManagedActiveDirectoryConfiguration

The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see [ Using Amazon FSx for Windows with your self-managed Microsoft Active Directory] or [Managing FSx for ONTAP SVMs].

[1]: docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html [2]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html

Returns:



2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

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

#throughput_capacity ⇒ Integer

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

Returns:

  • (Integer) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

class CreateFileSystemWindowsConfiguration < Struct.new(
  :active_directory_id,
  :self_managed_active_directory_configuration,
  :deployment_type,
  :preferred_subnet_id,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :aliases,
  :audit_log_configuration,
  :disk_iops_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, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

Returns:

  • (String) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-fsx/types.rb', line 2779

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