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

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

Overview

Note:

When making an API call, you may pass CreateFileSystemWindowsConfiguration data as a hash:

{
  active_directory_id: "DirectoryId",
  self_managed_active_directory_configuration: {
    domain_name: "ActiveDirectoryFullyQualifiedName", # required
    organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
    file_system_administrators_group: "FileSystemAdministratorsGroupName",
    user_name: "DirectoryUserName", # required
    password: "DirectoryPassword", # required
    dns_ips: ["IpAddress"], # required
  },
  deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2
  preferred_subnet_id: "SubnetId",
  throughput_capacity: 1, # required
  weekly_maintenance_start_time: "WeeklyTime",
  daily_automatic_backup_start_time: "DailyTime",
  automatic_backup_retention_days: 1,
  copy_tags_to_backups: false,
  aliases: ["AlternateDNSName"],
  audit_log_configuration: {
    file_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
    file_share_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
    audit_log_destination: "GeneralARN",
  },
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_directory_idString

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)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2428

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)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (Array<String>)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2428

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)
  SENSITIVE = []
  include Aws::Structure
end

#audit_log_configurationTypes::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.



2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2428

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)
  SENSITIVE = []
  include Aws::Structure
end

#automatic_backup_retention_daysInteger

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:

  • (Integer)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2428

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)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_backupsBoolean

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)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2428

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)
  SENSITIVE = []
  include Aws::Structure
end

#daily_automatic_backup_start_timeString

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

Returns:

  • (String)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2428

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)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_typeString

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.

Returns:

  • (String)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2428

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)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_subnet_idString

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)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2428

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)
  SENSITIVE = []
  include Aws::Structure
end

#self_managed_active_directory_configurationTypes::SelfManagedActiveDirectoryConfiguration

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



2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2428

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)
  SENSITIVE = []
  include Aws::Structure
end

#throughput_capacityInteger

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

Returns:

  • (Integer)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2428

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)
  SENSITIVE = []
  include Aws::Structure
end

#weekly_maintenance_start_timeString

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)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2428

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)
  SENSITIVE = []
  include Aws::Structure
end