You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateFileSystemWindowsConfiguration as input to an Aws::Client method, you can use a vanilla 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"],
}

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#active_directory_id ⇒ String

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

Returns:

  • (String) —

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

#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 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>) —

    An array of one or more DNS alias names that you want to associate with the Amazon FSx file system.

#automatic_backup_retention_days ⇒ Integer

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) —

    The number of days to retain automatic backups.

#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) —

    A boolean flag indicating whether tags for the file system should be copied to backups.

#daily_automatic_backup_start_time ⇒ String

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

Returns:

  • (String) —

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

#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 AWS 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) —

    Specifies the file system deployment type, valid values are the following:.

#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-AWS 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) —

    Required when DeploymentType is set to MULTI_AZ_1.

#self_managed_active_directory_configuration ⇒ Types::SelfManagedActiveDirectoryConfiguration

The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.

Returns:

#throughput_capacity ⇒ Integer

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

Returns:

  • (Integer) —

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

#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) —

    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.