1. Packages
  2. AWS Classic
  3. API Docs
  4. fsx
  5. WindowsFileSystem

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi

aws.fsx.WindowsFileSystem

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi

    Manages a FSx Windows File System. See the FSx Windows Guide for more information.

    NOTE: Either the active_directory_id argument or self_managed_active_directory configuration block must be specified.

    Example Usage

    Using AWS Directory Service

    Additional information for using AWS Directory Service with Windows File Systems can be found in the FSx Windows Guide.

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.fsx.WindowsFileSystem("example", {
        activeDirectoryId: exampleAwsDirectoryServiceDirectory.id,
        kmsKeyId: exampleAwsKmsKey.arn,
        storageCapacity: 300,
        subnetIds: [exampleAwsSubnet.id],
        throughputCapacity: 1024,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.fsx.WindowsFileSystem("example",
        active_directory_id=example_aws_directory_service_directory["id"],
        kms_key_id=example_aws_kms_key["arn"],
        storage_capacity=300,
        subnet_ids=[example_aws_subnet["id"]],
        throughput_capacity=1024)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := fsx.NewWindowsFileSystem(ctx, "example", &fsx.WindowsFileSystemArgs{
    			ActiveDirectoryId: pulumi.Any(exampleAwsDirectoryServiceDirectory.Id),
    			KmsKeyId:          pulumi.Any(exampleAwsKmsKey.Arn),
    			StorageCapacity:   pulumi.Int(300),
    			SubnetIds: pulumi.StringArray{
    				exampleAwsSubnet.Id,
    			},
    			ThroughputCapacity: pulumi.Int(1024),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Fsx.WindowsFileSystem("example", new()
        {
            ActiveDirectoryId = exampleAwsDirectoryServiceDirectory.Id,
            KmsKeyId = exampleAwsKmsKey.Arn,
            StorageCapacity = 300,
            SubnetIds = new[]
            {
                exampleAwsSubnet.Id,
            },
            ThroughputCapacity = 1024,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.fsx.WindowsFileSystem;
    import com.pulumi.aws.fsx.WindowsFileSystemArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new WindowsFileSystem("example", WindowsFileSystemArgs.builder()        
                .activeDirectoryId(exampleAwsDirectoryServiceDirectory.id())
                .kmsKeyId(exampleAwsKmsKey.arn())
                .storageCapacity(300)
                .subnetIds(exampleAwsSubnet.id())
                .throughputCapacity(1024)
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:fsx:WindowsFileSystem
        properties:
          activeDirectoryId: ${exampleAwsDirectoryServiceDirectory.id}
          kmsKeyId: ${exampleAwsKmsKey.arn}
          storageCapacity: 300
          subnetIds:
            - ${exampleAwsSubnet.id}
          throughputCapacity: 1024
    

    Using a Self-Managed Microsoft Active Directory

    Additional information for using AWS Directory Service with Windows File Systems can be found in the FSx Windows Guide.

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.fsx.WindowsFileSystem("example", {
        kmsKeyId: exampleAwsKmsKey.arn,
        storageCapacity: 300,
        subnetIds: [exampleAwsSubnet.id],
        throughputCapacity: 1024,
        selfManagedActiveDirectory: {
            dnsIps: [
                "10.0.0.111",
                "10.0.0.222",
            ],
            domainName: "corp.example.com",
            password: "avoid-plaintext-passwords",
            username: "Admin",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.fsx.WindowsFileSystem("example",
        kms_key_id=example_aws_kms_key["arn"],
        storage_capacity=300,
        subnet_ids=[example_aws_subnet["id"]],
        throughput_capacity=1024,
        self_managed_active_directory=aws.fsx.WindowsFileSystemSelfManagedActiveDirectoryArgs(
            dns_ips=[
                "10.0.0.111",
                "10.0.0.222",
            ],
            domain_name="corp.example.com",
            password="avoid-plaintext-passwords",
            username="Admin",
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := fsx.NewWindowsFileSystem(ctx, "example", &fsx.WindowsFileSystemArgs{
    			KmsKeyId:        pulumi.Any(exampleAwsKmsKey.Arn),
    			StorageCapacity: pulumi.Int(300),
    			SubnetIds: pulumi.StringArray{
    				exampleAwsSubnet.Id,
    			},
    			ThroughputCapacity: pulumi.Int(1024),
    			SelfManagedActiveDirectory: &fsx.WindowsFileSystemSelfManagedActiveDirectoryArgs{
    				DnsIps: pulumi.StringArray{
    					pulumi.String("10.0.0.111"),
    					pulumi.String("10.0.0.222"),
    				},
    				DomainName: pulumi.String("corp.example.com"),
    				Password:   pulumi.String("avoid-plaintext-passwords"),
    				Username:   pulumi.String("Admin"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Fsx.WindowsFileSystem("example", new()
        {
            KmsKeyId = exampleAwsKmsKey.Arn,
            StorageCapacity = 300,
            SubnetIds = new[]
            {
                exampleAwsSubnet.Id,
            },
            ThroughputCapacity = 1024,
            SelfManagedActiveDirectory = new Aws.Fsx.Inputs.WindowsFileSystemSelfManagedActiveDirectoryArgs
            {
                DnsIps = new[]
                {
                    "10.0.0.111",
                    "10.0.0.222",
                },
                DomainName = "corp.example.com",
                Password = "avoid-plaintext-passwords",
                Username = "Admin",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.fsx.WindowsFileSystem;
    import com.pulumi.aws.fsx.WindowsFileSystemArgs;
    import com.pulumi.aws.fsx.inputs.WindowsFileSystemSelfManagedActiveDirectoryArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new WindowsFileSystem("example", WindowsFileSystemArgs.builder()        
                .kmsKeyId(exampleAwsKmsKey.arn())
                .storageCapacity(300)
                .subnetIds(exampleAwsSubnet.id())
                .throughputCapacity(1024)
                .selfManagedActiveDirectory(WindowsFileSystemSelfManagedActiveDirectoryArgs.builder()
                    .dnsIps(                
                        "10.0.0.111",
                        "10.0.0.222")
                    .domainName("corp.example.com")
                    .password("avoid-plaintext-passwords")
                    .username("Admin")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:fsx:WindowsFileSystem
        properties:
          kmsKeyId: ${exampleAwsKmsKey.arn}
          storageCapacity: 300
          subnetIds:
            - ${exampleAwsSubnet.id}
          throughputCapacity: 1024
          selfManagedActiveDirectory:
            dnsIps:
              - 10.0.0.111
              - 10.0.0.222
            domainName: corp.example.com
            password: avoid-plaintext-passwords
            username: Admin
    

    Create WindowsFileSystem Resource

    new WindowsFileSystem(name: string, args: WindowsFileSystemArgs, opts?: CustomResourceOptions);
    @overload
    def WindowsFileSystem(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          active_directory_id: Optional[str] = None,
                          aliases: Optional[Sequence[str]] = None,
                          audit_log_configuration: Optional[WindowsFileSystemAuditLogConfigurationArgs] = None,
                          automatic_backup_retention_days: Optional[int] = None,
                          backup_id: Optional[str] = None,
                          copy_tags_to_backups: Optional[bool] = None,
                          daily_automatic_backup_start_time: Optional[str] = None,
                          deployment_type: Optional[str] = None,
                          disk_iops_configuration: Optional[WindowsFileSystemDiskIopsConfigurationArgs] = None,
                          kms_key_id: Optional[str] = None,
                          preferred_subnet_id: Optional[str] = None,
                          security_group_ids: Optional[Sequence[str]] = None,
                          self_managed_active_directory: Optional[WindowsFileSystemSelfManagedActiveDirectoryArgs] = None,
                          skip_final_backup: Optional[bool] = None,
                          storage_capacity: Optional[int] = None,
                          storage_type: Optional[str] = None,
                          subnet_ids: Optional[Sequence[str]] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          throughput_capacity: Optional[int] = None,
                          weekly_maintenance_start_time: Optional[str] = None)
    @overload
    def WindowsFileSystem(resource_name: str,
                          args: WindowsFileSystemArgs,
                          opts: Optional[ResourceOptions] = None)
    func NewWindowsFileSystem(ctx *Context, name string, args WindowsFileSystemArgs, opts ...ResourceOption) (*WindowsFileSystem, error)
    public WindowsFileSystem(string name, WindowsFileSystemArgs args, CustomResourceOptions? opts = null)
    public WindowsFileSystem(String name, WindowsFileSystemArgs args)
    public WindowsFileSystem(String name, WindowsFileSystemArgs args, CustomResourceOptions options)
    
    type: aws:fsx:WindowsFileSystem
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args WindowsFileSystemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WindowsFileSystemArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WindowsFileSystemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WindowsFileSystemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WindowsFileSystemArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    WindowsFileSystem Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The WindowsFileSystem resource accepts the following input properties:

    SubnetIds List<string>
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    ThroughputCapacity int

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    ActiveDirectoryId string
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    Aliases List<string>
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    AuditLogConfiguration Pulumi.Aws.Fsx.Inputs.WindowsFileSystemAuditLogConfiguration
    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. See Audit Log Configuration below.
    AutomaticBackupRetentionDays int
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    BackupId string
    The ID of the source backup to create the filesystem from.
    CopyTagsToBackups bool
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    DailyAutomaticBackupStartTime string
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    DeploymentType string
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    DiskIopsConfiguration Pulumi.Aws.Fsx.Inputs.WindowsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    KmsKeyId string
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    PreferredSubnetId string
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    SecurityGroupIds List<string>
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    SelfManagedActiveDirectory Pulumi.Aws.Fsx.Inputs.WindowsFileSystemSelfManagedActiveDirectory
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    SkipFinalBackup bool
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    StorageCapacity int
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    StorageType string
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    Tags Dictionary<string, string>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    WeeklyMaintenanceStartTime string
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
    SubnetIds []string
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    ThroughputCapacity int

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    ActiveDirectoryId string
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    Aliases []string
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    AuditLogConfiguration WindowsFileSystemAuditLogConfigurationArgs
    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. See Audit Log Configuration below.
    AutomaticBackupRetentionDays int
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    BackupId string
    The ID of the source backup to create the filesystem from.
    CopyTagsToBackups bool
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    DailyAutomaticBackupStartTime string
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    DeploymentType string
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    DiskIopsConfiguration WindowsFileSystemDiskIopsConfigurationArgs
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    KmsKeyId string
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    PreferredSubnetId string
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    SecurityGroupIds []string
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    SelfManagedActiveDirectory WindowsFileSystemSelfManagedActiveDirectoryArgs
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    SkipFinalBackup bool
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    StorageCapacity int
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    StorageType string
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    Tags map[string]string
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    WeeklyMaintenanceStartTime string
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
    subnetIds List<String>
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    throughputCapacity Integer

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    activeDirectoryId String
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    aliases List<String>
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    auditLogConfiguration WindowsFileSystemAuditLogConfiguration
    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. See Audit Log Configuration below.
    automaticBackupRetentionDays Integer
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    backupId String
    The ID of the source backup to create the filesystem from.
    copyTagsToBackups Boolean
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    dailyAutomaticBackupStartTime String
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    deploymentType String
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    diskIopsConfiguration WindowsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    kmsKeyId String
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    preferredSubnetId String
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    securityGroupIds List<String>
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    selfManagedActiveDirectory WindowsFileSystemSelfManagedActiveDirectory
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    skipFinalBackup Boolean
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    storageCapacity Integer
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    storageType String
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    tags Map<String,String>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    weeklyMaintenanceStartTime String
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
    subnetIds string[]
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    throughputCapacity number

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    activeDirectoryId string
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    aliases string[]
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    auditLogConfiguration WindowsFileSystemAuditLogConfiguration
    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. See Audit Log Configuration below.
    automaticBackupRetentionDays number
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    backupId string
    The ID of the source backup to create the filesystem from.
    copyTagsToBackups boolean
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    dailyAutomaticBackupStartTime string
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    deploymentType string
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    diskIopsConfiguration WindowsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    kmsKeyId string
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    preferredSubnetId string
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    securityGroupIds string[]
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    selfManagedActiveDirectory WindowsFileSystemSelfManagedActiveDirectory
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    skipFinalBackup boolean
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    storageCapacity number
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    storageType string
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    tags {[key: string]: string}
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    weeklyMaintenanceStartTime string
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
    subnet_ids Sequence[str]
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    throughput_capacity int

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    active_directory_id str
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    aliases Sequence[str]
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    audit_log_configuration WindowsFileSystemAuditLogConfigurationArgs
    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. See Audit Log Configuration below.
    automatic_backup_retention_days int
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    backup_id str
    The ID of the source backup to create the filesystem from.
    copy_tags_to_backups bool
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    daily_automatic_backup_start_time str
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    deployment_type str
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    disk_iops_configuration WindowsFileSystemDiskIopsConfigurationArgs
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    kms_key_id str
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    preferred_subnet_id str
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    security_group_ids Sequence[str]
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    self_managed_active_directory WindowsFileSystemSelfManagedActiveDirectoryArgs
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    skip_final_backup bool
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    storage_capacity int
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    storage_type str
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    tags Mapping[str, str]
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    weekly_maintenance_start_time str
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
    subnetIds List<String>
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    throughputCapacity Number

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    activeDirectoryId String
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    aliases List<String>
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    auditLogConfiguration Property Map
    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. See Audit Log Configuration below.
    automaticBackupRetentionDays Number
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    backupId String
    The ID of the source backup to create the filesystem from.
    copyTagsToBackups Boolean
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    dailyAutomaticBackupStartTime String
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    deploymentType String
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    diskIopsConfiguration Property Map
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    kmsKeyId String
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    preferredSubnetId String
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    securityGroupIds List<String>
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    selfManagedActiveDirectory Property Map
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    skipFinalBackup Boolean
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    storageCapacity Number
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    storageType String
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    tags Map<String>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    weeklyMaintenanceStartTime String
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WindowsFileSystem resource produces the following output properties:

    Arn string
    Amazon Resource Name of the file system.
    DnsName string
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkInterfaceIds List<string>
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    OwnerId string
    AWS account identifier that created the file system.
    PreferredFileServerIp string
    The IP address of the primary, or preferred, file server.
    RemoteAdministrationEndpoint 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 deployment types, this is the DNS name of the file system.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    VpcId string
    Identifier of the Virtual Private Cloud for the file system.
    Arn string
    Amazon Resource Name of the file system.
    DnsName string
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkInterfaceIds []string
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    OwnerId string
    AWS account identifier that created the file system.
    PreferredFileServerIp string
    The IP address of the primary, or preferred, file server.
    RemoteAdministrationEndpoint 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 deployment types, this is the DNS name of the file system.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    VpcId string
    Identifier of the Virtual Private Cloud for the file system.
    arn String
    Amazon Resource Name of the file system.
    dnsName String
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    id String
    The provider-assigned unique ID for this managed resource.
    networkInterfaceIds List<String>
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    ownerId String
    AWS account identifier that created the file system.
    preferredFileServerIp String
    The IP address of the primary, or preferred, file server.
    remoteAdministrationEndpoint 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 deployment types, this is the DNS name of the file system.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    vpcId String
    Identifier of the Virtual Private Cloud for the file system.
    arn string
    Amazon Resource Name of the file system.
    dnsName string
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    id string
    The provider-assigned unique ID for this managed resource.
    networkInterfaceIds string[]
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    ownerId string
    AWS account identifier that created the file system.
    preferredFileServerIp string
    The IP address of the primary, or preferred, file server.
    remoteAdministrationEndpoint 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 deployment types, this is the DNS name of the file system.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    vpcId string
    Identifier of the Virtual Private Cloud for the file system.
    arn str
    Amazon Resource Name of the file system.
    dns_name str
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    id str
    The provider-assigned unique ID for this managed resource.
    network_interface_ids Sequence[str]
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    owner_id str
    AWS account identifier that created the file system.
    preferred_file_server_ip str
    The IP address of the primary, or preferred, file server.
    remote_administration_endpoint str
    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 deployment types, this is the DNS name of the file system.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    vpc_id str
    Identifier of the Virtual Private Cloud for the file system.
    arn String
    Amazon Resource Name of the file system.
    dnsName String
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    id String
    The provider-assigned unique ID for this managed resource.
    networkInterfaceIds List<String>
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    ownerId String
    AWS account identifier that created the file system.
    preferredFileServerIp String
    The IP address of the primary, or preferred, file server.
    remoteAdministrationEndpoint 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 deployment types, this is the DNS name of the file system.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    vpcId String
    Identifier of the Virtual Private Cloud for the file system.

    Look up Existing WindowsFileSystem Resource

    Get an existing WindowsFileSystem resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WindowsFileSystemState, opts?: CustomResourceOptions): WindowsFileSystem
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            active_directory_id: Optional[str] = None,
            aliases: Optional[Sequence[str]] = None,
            arn: Optional[str] = None,
            audit_log_configuration: Optional[WindowsFileSystemAuditLogConfigurationArgs] = None,
            automatic_backup_retention_days: Optional[int] = None,
            backup_id: Optional[str] = None,
            copy_tags_to_backups: Optional[bool] = None,
            daily_automatic_backup_start_time: Optional[str] = None,
            deployment_type: Optional[str] = None,
            disk_iops_configuration: Optional[WindowsFileSystemDiskIopsConfigurationArgs] = None,
            dns_name: Optional[str] = None,
            kms_key_id: Optional[str] = None,
            network_interface_ids: Optional[Sequence[str]] = None,
            owner_id: Optional[str] = None,
            preferred_file_server_ip: Optional[str] = None,
            preferred_subnet_id: Optional[str] = None,
            remote_administration_endpoint: Optional[str] = None,
            security_group_ids: Optional[Sequence[str]] = None,
            self_managed_active_directory: Optional[WindowsFileSystemSelfManagedActiveDirectoryArgs] = None,
            skip_final_backup: Optional[bool] = None,
            storage_capacity: Optional[int] = None,
            storage_type: Optional[str] = None,
            subnet_ids: Optional[Sequence[str]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            throughput_capacity: Optional[int] = None,
            vpc_id: Optional[str] = None,
            weekly_maintenance_start_time: Optional[str] = None) -> WindowsFileSystem
    func GetWindowsFileSystem(ctx *Context, name string, id IDInput, state *WindowsFileSystemState, opts ...ResourceOption) (*WindowsFileSystem, error)
    public static WindowsFileSystem Get(string name, Input<string> id, WindowsFileSystemState? state, CustomResourceOptions? opts = null)
    public static WindowsFileSystem get(String name, Output<String> id, WindowsFileSystemState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ActiveDirectoryId string
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    Aliases List<string>
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    Arn string
    Amazon Resource Name of the file system.
    AuditLogConfiguration Pulumi.Aws.Fsx.Inputs.WindowsFileSystemAuditLogConfiguration
    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. See Audit Log Configuration below.
    AutomaticBackupRetentionDays int
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    BackupId string
    The ID of the source backup to create the filesystem from.
    CopyTagsToBackups bool
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    DailyAutomaticBackupStartTime string
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    DeploymentType string
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    DiskIopsConfiguration Pulumi.Aws.Fsx.Inputs.WindowsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    DnsName string
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    KmsKeyId string
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    NetworkInterfaceIds List<string>
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    OwnerId string
    AWS account identifier that created the file system.
    PreferredFileServerIp string
    The IP address of the primary, or preferred, file server.
    PreferredSubnetId string
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    RemoteAdministrationEndpoint 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 deployment types, this is the DNS name of the file system.
    SecurityGroupIds List<string>
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    SelfManagedActiveDirectory Pulumi.Aws.Fsx.Inputs.WindowsFileSystemSelfManagedActiveDirectory
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    SkipFinalBackup bool
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    StorageCapacity int
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    StorageType string
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    SubnetIds List<string>
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    Tags Dictionary<string, string>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    ThroughputCapacity int

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    VpcId string
    Identifier of the Virtual Private Cloud for the file system.
    WeeklyMaintenanceStartTime string
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
    ActiveDirectoryId string
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    Aliases []string
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    Arn string
    Amazon Resource Name of the file system.
    AuditLogConfiguration WindowsFileSystemAuditLogConfigurationArgs
    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. See Audit Log Configuration below.
    AutomaticBackupRetentionDays int
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    BackupId string
    The ID of the source backup to create the filesystem from.
    CopyTagsToBackups bool
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    DailyAutomaticBackupStartTime string
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    DeploymentType string
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    DiskIopsConfiguration WindowsFileSystemDiskIopsConfigurationArgs
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    DnsName string
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    KmsKeyId string
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    NetworkInterfaceIds []string
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    OwnerId string
    AWS account identifier that created the file system.
    PreferredFileServerIp string
    The IP address of the primary, or preferred, file server.
    PreferredSubnetId string
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    RemoteAdministrationEndpoint 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 deployment types, this is the DNS name of the file system.
    SecurityGroupIds []string
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    SelfManagedActiveDirectory WindowsFileSystemSelfManagedActiveDirectoryArgs
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    SkipFinalBackup bool
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    StorageCapacity int
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    StorageType string
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    SubnetIds []string
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    Tags map[string]string
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    ThroughputCapacity int

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    VpcId string
    Identifier of the Virtual Private Cloud for the file system.
    WeeklyMaintenanceStartTime string
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
    activeDirectoryId String
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    aliases List<String>
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    arn String
    Amazon Resource Name of the file system.
    auditLogConfiguration WindowsFileSystemAuditLogConfiguration
    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. See Audit Log Configuration below.
    automaticBackupRetentionDays Integer
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    backupId String
    The ID of the source backup to create the filesystem from.
    copyTagsToBackups Boolean
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    dailyAutomaticBackupStartTime String
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    deploymentType String
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    diskIopsConfiguration WindowsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    dnsName String
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    kmsKeyId String
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    networkInterfaceIds List<String>
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    ownerId String
    AWS account identifier that created the file system.
    preferredFileServerIp String
    The IP address of the primary, or preferred, file server.
    preferredSubnetId String
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    remoteAdministrationEndpoint 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 deployment types, this is the DNS name of the file system.
    securityGroupIds List<String>
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    selfManagedActiveDirectory WindowsFileSystemSelfManagedActiveDirectory
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    skipFinalBackup Boolean
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    storageCapacity Integer
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    storageType String
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    subnetIds List<String>
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    tags Map<String,String>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    throughputCapacity Integer

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    vpcId String
    Identifier of the Virtual Private Cloud for the file system.
    weeklyMaintenanceStartTime String
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
    activeDirectoryId string
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    aliases string[]
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    arn string
    Amazon Resource Name of the file system.
    auditLogConfiguration WindowsFileSystemAuditLogConfiguration
    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. See Audit Log Configuration below.
    automaticBackupRetentionDays number
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    backupId string
    The ID of the source backup to create the filesystem from.
    copyTagsToBackups boolean
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    dailyAutomaticBackupStartTime string
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    deploymentType string
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    diskIopsConfiguration WindowsFileSystemDiskIopsConfiguration
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    dnsName string
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    kmsKeyId string
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    networkInterfaceIds string[]
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    ownerId string
    AWS account identifier that created the file system.
    preferredFileServerIp string
    The IP address of the primary, or preferred, file server.
    preferredSubnetId string
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    remoteAdministrationEndpoint 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 deployment types, this is the DNS name of the file system.
    securityGroupIds string[]
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    selfManagedActiveDirectory WindowsFileSystemSelfManagedActiveDirectory
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    skipFinalBackup boolean
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    storageCapacity number
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    storageType string
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    subnetIds string[]
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    tags {[key: string]: string}
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    throughputCapacity number

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    vpcId string
    Identifier of the Virtual Private Cloud for the file system.
    weeklyMaintenanceStartTime string
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
    active_directory_id str
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    aliases Sequence[str]
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    arn str
    Amazon Resource Name of the file system.
    audit_log_configuration WindowsFileSystemAuditLogConfigurationArgs
    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. See Audit Log Configuration below.
    automatic_backup_retention_days int
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    backup_id str
    The ID of the source backup to create the filesystem from.
    copy_tags_to_backups bool
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    daily_automatic_backup_start_time str
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    deployment_type str
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    disk_iops_configuration WindowsFileSystemDiskIopsConfigurationArgs
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    dns_name str
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    kms_key_id str
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    network_interface_ids Sequence[str]
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    owner_id str
    AWS account identifier that created the file system.
    preferred_file_server_ip str
    The IP address of the primary, or preferred, file server.
    preferred_subnet_id str
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    remote_administration_endpoint str
    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 deployment types, this is the DNS name of the file system.
    security_group_ids Sequence[str]
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    self_managed_active_directory WindowsFileSystemSelfManagedActiveDirectoryArgs
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    skip_final_backup bool
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    storage_capacity int
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    storage_type str
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    subnet_ids Sequence[str]
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    tags Mapping[str, str]
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    throughput_capacity int

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    vpc_id str
    Identifier of the Virtual Private Cloud for the file system.
    weekly_maintenance_start_time str
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
    activeDirectoryId String
    The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with self_managed_active_directory.
    aliases List<String>
    An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
    arn String
    Amazon Resource Name of the file system.
    auditLogConfiguration Property Map
    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. See Audit Log Configuration below.
    automaticBackupRetentionDays Number
    The number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
    backupId String
    The ID of the source backup to create the filesystem from.
    copyTagsToBackups Boolean
    A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
    dailyAutomaticBackupStartTime String
    The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
    deploymentType String
    Specifies the file system deployment type, valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
    diskIopsConfiguration Property Map
    The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See Disk Iops Configuration below.
    dnsName String
    DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
    kmsKeyId String
    ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
    networkInterfaceIds List<String>
    Set of Elastic Network Interface identifiers from which the file system is accessible.
    ownerId String
    AWS account identifier that created the file system.
    preferredFileServerIp String
    The IP address of the primary, or preferred, file server.
    preferredSubnetId String
    Specifies the subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
    remoteAdministrationEndpoint 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 deployment types, this is the DNS name of the file system.
    securityGroupIds List<String>
    A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
    selfManagedActiveDirectory Property Map
    Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. See Self-Managed Active Directory below.
    skipFinalBackup Boolean
    When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
    storageCapacity Number
    Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
    storageType String
    Specifies the storage type, Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
    subnetIds List<String>
    A list of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deployment_type to MULTI_AZ_1.
    tags Map<String>
    A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    throughputCapacity Number

    Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

    The following arguments are optional:

    vpcId String
    Identifier of the Virtual Private Cloud for the file system.
    weeklyMaintenanceStartTime String
    The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

    Supporting Types

    WindowsFileSystemAuditLogConfiguration, WindowsFileSystemAuditLogConfigurationArgs

    AuditLogDestination string
    The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN. Can be specified when file_access_audit_log_level and file_share_access_audit_log_level are not set to DISABLED. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix. If you do not provide a destination in audit_log_destionation, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.
    FileAccessAuditLogLevel string
    Sets which attempt type is logged by Amazon FSx for file and folder accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.
    FileShareAccessAuditLogLevel string
    Sets which attempt type is logged by Amazon FSx for file share accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.
    AuditLogDestination string
    The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN. Can be specified when file_access_audit_log_level and file_share_access_audit_log_level are not set to DISABLED. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix. If you do not provide a destination in audit_log_destionation, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.
    FileAccessAuditLogLevel string
    Sets which attempt type is logged by Amazon FSx for file and folder accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.
    FileShareAccessAuditLogLevel string
    Sets which attempt type is logged by Amazon FSx for file share accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.
    auditLogDestination String
    The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN. Can be specified when file_access_audit_log_level and file_share_access_audit_log_level are not set to DISABLED. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix. If you do not provide a destination in audit_log_destionation, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.
    fileAccessAuditLogLevel String
    Sets which attempt type is logged by Amazon FSx for file and folder accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.
    fileShareAccessAuditLogLevel String
    Sets which attempt type is logged by Amazon FSx for file share accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.
    auditLogDestination string
    The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN. Can be specified when file_access_audit_log_level and file_share_access_audit_log_level are not set to DISABLED. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix. If you do not provide a destination in audit_log_destionation, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.
    fileAccessAuditLogLevel string
    Sets which attempt type is logged by Amazon FSx for file and folder accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.
    fileShareAccessAuditLogLevel string
    Sets which attempt type is logged by Amazon FSx for file share accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.
    audit_log_destination str
    The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN. Can be specified when file_access_audit_log_level and file_share_access_audit_log_level are not set to DISABLED. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix. If you do not provide a destination in audit_log_destionation, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.
    file_access_audit_log_level str
    Sets which attempt type is logged by Amazon FSx for file and folder accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.
    file_share_access_audit_log_level str
    Sets which attempt type is logged by Amazon FSx for file share accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.
    auditLogDestination String
    The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN. Can be specified when file_access_audit_log_level and file_share_access_audit_log_level are not set to DISABLED. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix. If you do not provide a destination in audit_log_destionation, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.
    fileAccessAuditLogLevel String
    Sets which attempt type is logged by Amazon FSx for file and folder accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.
    fileShareAccessAuditLogLevel String
    Sets which attempt type is logged by Amazon FSx for file share accesses. Valid values are SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE, and DISABLED. Default value is DISABLED.

    WindowsFileSystemDiskIopsConfiguration, WindowsFileSystemDiskIopsConfigurationArgs

    Iops int
    The total number of SSD IOPS provisioned for the file system.
    Mode string
    Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.
    Iops int
    The total number of SSD IOPS provisioned for the file system.
    Mode string
    Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.
    iops Integer
    The total number of SSD IOPS provisioned for the file system.
    mode String
    Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.
    iops number
    The total number of SSD IOPS provisioned for the file system.
    mode string
    Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.
    iops int
    The total number of SSD IOPS provisioned for the file system.
    mode str
    Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.
    iops Number
    The total number of SSD IOPS provisioned for the file system.
    mode String
    Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.

    WindowsFileSystemSelfManagedActiveDirectory, WindowsFileSystemSelfManagedActiveDirectoryArgs

    DnsIps List<string>
    A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the file system or in the private IP version 4 (IPv4) address ranges as specified in RFC 1918.
    DomainName string
    The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
    Password string
    The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    Username string
    The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    FileSystemAdministratorsGroup string
    The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, and setting audit controls (audit ACLs) on files and folders. The group that you specify must already exist in your domain. Defaults to Domain Admins.
    OrganizationalUnitDistinguishedName string
    The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the file system. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.
    DnsIps []string
    A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the file system or in the private IP version 4 (IPv4) address ranges as specified in RFC 1918.
    DomainName string
    The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
    Password string
    The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    Username string
    The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    FileSystemAdministratorsGroup string
    The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, and setting audit controls (audit ACLs) on files and folders. The group that you specify must already exist in your domain. Defaults to Domain Admins.
    OrganizationalUnitDistinguishedName string
    The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the file system. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.
    dnsIps List<String>
    A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the file system or in the private IP version 4 (IPv4) address ranges as specified in RFC 1918.
    domainName String
    The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
    password String
    The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    username String
    The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    fileSystemAdministratorsGroup String
    The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, and setting audit controls (audit ACLs) on files and folders. The group that you specify must already exist in your domain. Defaults to Domain Admins.
    organizationalUnitDistinguishedName String
    The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the file system. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.
    dnsIps string[]
    A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the file system or in the private IP version 4 (IPv4) address ranges as specified in RFC 1918.
    domainName string
    The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
    password string
    The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    username string
    The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    fileSystemAdministratorsGroup string
    The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, and setting audit controls (audit ACLs) on files and folders. The group that you specify must already exist in your domain. Defaults to Domain Admins.
    organizationalUnitDistinguishedName string
    The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the file system. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.
    dns_ips Sequence[str]
    A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the file system or in the private IP version 4 (IPv4) address ranges as specified in RFC 1918.
    domain_name str
    The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
    password str
    The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    username str
    The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    file_system_administrators_group str
    The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, and setting audit controls (audit ACLs) on files and folders. The group that you specify must already exist in your domain. Defaults to Domain Admins.
    organizational_unit_distinguished_name str
    The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the file system. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.
    dnsIps List<String>
    A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the file system or in the private IP version 4 (IPv4) address ranges as specified in RFC 1918.
    domainName String
    The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
    password String
    The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    username String
    The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
    fileSystemAdministratorsGroup String
    The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, and setting audit controls (audit ACLs) on files and folders. The group that you specify must already exist in your domain. Defaults to Domain Admins.
    organizationalUnitDistinguishedName String
    The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. For example, OU=FSx,DC=yourdomain,DC=corp,DC=com. Only accepts OU as the direct parent of the file system. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. To learn more, see RFC 2253.

    Import

    Using pulumi import, import FSx File Systems using the id. For example:

    $ pulumi import aws:fsx/windowsFileSystem:WindowsFileSystem example fs-543ab12b1ca672f33
    

    Certain resource arguments, like security_group_ids and the self_managed_active_directory configuation block password, do not have a FSx API method for reading the information after creation. If these arguments are set in the Pulumi program on an imported resource, Pulumi will always show a difference. To workaround this behavior, either omit the argument from the Pulumi program or use ignore_changes to hide the difference. For example:

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi