AWS v6.73.0, Mar 19 25

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

aws.fsx.WindowsFileSystem

Explore with Pulumi AI

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

pulumi/pulumi-aws

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: 32,
    subnetIds: [exampleAwsSubnet.id],
    throughputCapacity: 32,
});

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=32,
    subnet_ids=[example_aws_subnet["id"]],
    throughput_capacity=32)

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(32),
			SubnetIds: pulumi.StringArray{
				exampleAwsSubnet.Id,
			},
			ThroughputCapacity: pulumi.Int(32),
		})
		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 = 32,
        SubnetIds = new[]
        {
            exampleAwsSubnet.Id,
        },
        ThroughputCapacity = 32,
    });

});

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(32)
            .subnetIds(exampleAwsSubnet.id())
            .throughputCapacity(32)
            .build());

    }
}

resources:
  example:
    type: aws:fsx:WindowsFileSystem
    properties:
      activeDirectoryId: ${exampleAwsDirectoryServiceDirectory.id}
      kmsKeyId: ${exampleAwsKmsKey.arn}
      storageCapacity: 32
      subnetIds:
        - ${exampleAwsSubnet.id}
      throughputCapacity: 32

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: 32,
    subnetIds: [exampleAwsSubnet.id],
    throughputCapacity: 32,
    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=32,
    subnet_ids=[example_aws_subnet["id"]],
    throughput_capacity=32,
    self_managed_active_directory={
        "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(32),
			SubnetIds: pulumi.StringArray{
				exampleAwsSubnet.Id,
			},
			ThroughputCapacity: pulumi.Int(32),
			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 = 32,
        SubnetIds = new[]
        {
            exampleAwsSubnet.Id,
        },
        ThroughputCapacity = 32,
        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(32)
            .subnetIds(exampleAwsSubnet.id())
            .throughputCapacity(32)
            .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: 32
      subnetIds:
        - ${exampleAwsSubnet.id}
      throughputCapacity: 32
      selfManagedActiveDirectory:
        dnsIps:
          - 10.0.0.111
          - 10.0.0.222
        domainName: corp.example.com
        password: avoid-plaintext-passwords
        username: Admin

Create WindowsFileSystem Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WindowsFileSystem(name: string, args: WindowsFileSystemArgs, opts?: CustomResourceOptions);

@overload
def WindowsFileSystem(resource_name: str,
                      args: WindowsFileSystemArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def WindowsFileSystem(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      subnet_ids: Optional[Sequence[str]] = None,
                      throughput_capacity: Optional[int] = None,
                      kms_key_id: Optional[str] = None,
                      preferred_subnet_id: Optional[str] = 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,
                      final_backup_tags: Optional[Mapping[str, str]] = None,
                      active_directory_id: Optional[str] = None,
                      automatic_backup_retention_days: Optional[int] = 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,
                      audit_log_configuration: Optional[WindowsFileSystemAuditLogConfigurationArgs] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      aliases: Optional[Sequence[str]] = None,
                      weekly_maintenance_start_time: Optional[str] = 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.

Parameters

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.

Constructor example

The following reference example uses placeholder values for all input properties.

var windowsFileSystemResource = new Aws.Fsx.WindowsFileSystem("windowsFileSystemResource", new()
{
    SubnetIds = new[]
    {
        "string",
    },
    ThroughputCapacity = 0,
    KmsKeyId = "string",
    PreferredSubnetId = "string",
    BackupId = "string",
    CopyTagsToBackups = false,
    DailyAutomaticBackupStartTime = "string",
    DeploymentType = "string",
    DiskIopsConfiguration = new Aws.Fsx.Inputs.WindowsFileSystemDiskIopsConfigurationArgs
    {
        Iops = 0,
        Mode = "string",
    },
    FinalBackupTags = 
    {
        { "string", "string" },
    },
    ActiveDirectoryId = "string",
    AutomaticBackupRetentionDays = 0,
    SecurityGroupIds = new[]
    {
        "string",
    },
    SelfManagedActiveDirectory = new Aws.Fsx.Inputs.WindowsFileSystemSelfManagedActiveDirectoryArgs
    {
        DnsIps = new[]
        {
            "string",
        },
        DomainName = "string",
        Password = "string",
        Username = "string",
        FileSystemAdministratorsGroup = "string",
        OrganizationalUnitDistinguishedName = "string",
    },
    SkipFinalBackup = false,
    StorageCapacity = 0,
    StorageType = "string",
    AuditLogConfiguration = new Aws.Fsx.Inputs.WindowsFileSystemAuditLogConfigurationArgs
    {
        AuditLogDestination = "string",
        FileAccessAuditLogLevel = "string",
        FileShareAccessAuditLogLevel = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    Aliases = new[]
    {
        "string",
    },
    WeeklyMaintenanceStartTime = "string",
});

example, err := fsx.NewWindowsFileSystem(ctx, "windowsFileSystemResource", &fsx.WindowsFileSystemArgs{
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ThroughputCapacity:            pulumi.Int(0),
	KmsKeyId:                      pulumi.String("string"),
	PreferredSubnetId:             pulumi.String("string"),
	BackupId:                      pulumi.String("string"),
	CopyTagsToBackups:             pulumi.Bool(false),
	DailyAutomaticBackupStartTime: pulumi.String("string"),
	DeploymentType:                pulumi.String("string"),
	DiskIopsConfiguration: &fsx.WindowsFileSystemDiskIopsConfigurationArgs{
		Iops: pulumi.Int(0),
		Mode: pulumi.String("string"),
	},
	FinalBackupTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ActiveDirectoryId:            pulumi.String("string"),
	AutomaticBackupRetentionDays: pulumi.Int(0),
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SelfManagedActiveDirectory: &fsx.WindowsFileSystemSelfManagedActiveDirectoryArgs{
		DnsIps: pulumi.StringArray{
			pulumi.String("string"),
		},
		DomainName:                          pulumi.String("string"),
		Password:                            pulumi.String("string"),
		Username:                            pulumi.String("string"),
		FileSystemAdministratorsGroup:       pulumi.String("string"),
		OrganizationalUnitDistinguishedName: pulumi.String("string"),
	},
	SkipFinalBackup: pulumi.Bool(false),
	StorageCapacity: pulumi.Int(0),
	StorageType:     pulumi.String("string"),
	AuditLogConfiguration: &fsx.WindowsFileSystemAuditLogConfigurationArgs{
		AuditLogDestination:          pulumi.String("string"),
		FileAccessAuditLogLevel:      pulumi.String("string"),
		FileShareAccessAuditLogLevel: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Aliases: pulumi.StringArray{
		pulumi.String("string"),
	},
	WeeklyMaintenanceStartTime: pulumi.String("string"),
})

var windowsFileSystemResource = new WindowsFileSystem("windowsFileSystemResource", WindowsFileSystemArgs.builder()
    .subnetIds("string")
    .throughputCapacity(0)
    .kmsKeyId("string")
    .preferredSubnetId("string")
    .backupId("string")
    .copyTagsToBackups(false)
    .dailyAutomaticBackupStartTime("string")
    .deploymentType("string")
    .diskIopsConfiguration(WindowsFileSystemDiskIopsConfigurationArgs.builder()
        .iops(0)
        .mode("string")
        .build())
    .finalBackupTags(Map.of("string", "string"))
    .activeDirectoryId("string")
    .automaticBackupRetentionDays(0)
    .securityGroupIds("string")
    .selfManagedActiveDirectory(WindowsFileSystemSelfManagedActiveDirectoryArgs.builder()
        .dnsIps("string")
        .domainName("string")
        .password("string")
        .username("string")
        .fileSystemAdministratorsGroup("string")
        .organizationalUnitDistinguishedName("string")
        .build())
    .skipFinalBackup(false)
    .storageCapacity(0)
    .storageType("string")
    .auditLogConfiguration(WindowsFileSystemAuditLogConfigurationArgs.builder()
        .auditLogDestination("string")
        .fileAccessAuditLogLevel("string")
        .fileShareAccessAuditLogLevel("string")
        .build())
    .tags(Map.of("string", "string"))
    .aliases("string")
    .weeklyMaintenanceStartTime("string")
    .build());

windows_file_system_resource = aws.fsx.WindowsFileSystem("windowsFileSystemResource",
    subnet_ids=["string"],
    throughput_capacity=0,
    kms_key_id="string",
    preferred_subnet_id="string",
    backup_id="string",
    copy_tags_to_backups=False,
    daily_automatic_backup_start_time="string",
    deployment_type="string",
    disk_iops_configuration={
        "iops": 0,
        "mode": "string",
    },
    final_backup_tags={
        "string": "string",
    },
    active_directory_id="string",
    automatic_backup_retention_days=0,
    security_group_ids=["string"],
    self_managed_active_directory={
        "dns_ips": ["string"],
        "domain_name": "string",
        "password": "string",
        "username": "string",
        "file_system_administrators_group": "string",
        "organizational_unit_distinguished_name": "string",
    },
    skip_final_backup=False,
    storage_capacity=0,
    storage_type="string",
    audit_log_configuration={
        "audit_log_destination": "string",
        "file_access_audit_log_level": "string",
        "file_share_access_audit_log_level": "string",
    },
    tags={
        "string": "string",
    },
    aliases=["string"],
    weekly_maintenance_start_time="string")

const windowsFileSystemResource = new aws.fsx.WindowsFileSystem("windowsFileSystemResource", {
    subnetIds: ["string"],
    throughputCapacity: 0,
    kmsKeyId: "string",
    preferredSubnetId: "string",
    backupId: "string",
    copyTagsToBackups: false,
    dailyAutomaticBackupStartTime: "string",
    deploymentType: "string",
    diskIopsConfiguration: {
        iops: 0,
        mode: "string",
    },
    finalBackupTags: {
        string: "string",
    },
    activeDirectoryId: "string",
    automaticBackupRetentionDays: 0,
    securityGroupIds: ["string"],
    selfManagedActiveDirectory: {
        dnsIps: ["string"],
        domainName: "string",
        password: "string",
        username: "string",
        fileSystemAdministratorsGroup: "string",
        organizationalUnitDistinguishedName: "string",
    },
    skipFinalBackup: false,
    storageCapacity: 0,
    storageType: "string",
    auditLogConfiguration: {
        auditLogDestination: "string",
        fileAccessAuditLogLevel: "string",
        fileShareAccessAuditLogLevel: "string",
    },
    tags: {
        string: "string",
    },
    aliases: ["string"],
    weeklyMaintenanceStartTime: "string",
});

type: aws:fsx:WindowsFileSystem
properties:
    activeDirectoryId: string
    aliases:
        - string
    auditLogConfiguration:
        auditLogDestination: string
        fileAccessAuditLogLevel: string
        fileShareAccessAuditLogLevel: string
    automaticBackupRetentionDays: 0
    backupId: string
    copyTagsToBackups: false
    dailyAutomaticBackupStartTime: string
    deploymentType: string
    diskIopsConfiguration:
        iops: 0
        mode: string
    finalBackupTags:
        string: string
    kmsKeyId: string
    preferredSubnetId: string
    securityGroupIds:
        - string
    selfManagedActiveDirectory:
        dnsIps:
            - string
        domainName: string
        fileSystemAdministratorsGroup: string
        organizationalUnitDistinguishedName: string
        password: string
        username: string
    skipFinalBackup: false
    storageCapacity: 0
    storageType: string
    subnetIds:
        - string
    tags:
        string: string
    throughputCapacity: 0
    weeklyMaintenanceStartTime: string

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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. For valid values, refer to the AWS documentation.

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 Block for details.

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 WindowsFileSystemDiskIopsConfiguration

The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See disk_iops_configuration Block for details.

FinalBackupTags Dictionary<string, string>

A map of tags to apply to the file system's final backup.

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 Block for details.

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. For valid values, refer to the AWS documentation.

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

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 Block for details.

FinalBackupTags map[string]string

A map of tags to apply to the file system's final backup.

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

SkipFinalBackup bool

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. For valid values, refer to the AWS documentation.

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

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 Block for details.

finalBackupTags Map<String,String>

A map of tags to apply to the file system's final backup.

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

skipFinalBackup Boolean

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. For valid values, refer to the AWS documentation.

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

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 Block for details.

finalBackupTags {[key: string]: string}

A map of tags to apply to the file system's final backup.

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

skipFinalBackup boolean

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. For valid values, refer to the AWS documentation.

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

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 Block for details.

final_backup_tags Mapping[str, str]

A map of tags to apply to the file system's final backup.

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

skip_final_backup bool

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. For valid values, refer to the AWS documentation.

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

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 Block for details.

finalBackupTags Map<String>

A map of tags to apply to the file system's final backup.

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

skipFinalBackup Boolean

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,
        final_backup_tags: Optional[Mapping[str, 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)

resources:  _:    type: aws:fsx:WindowsFileSystem    get:      id: ${id}

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 WindowsFileSystemAuditLogConfiguration

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 WindowsFileSystemDiskIopsConfiguration

The SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See disk_iops_configuration Block for details.

DnsName string

DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)

FinalBackupTags Dictionary<string, string>

A map of tags to apply to the file system's final backup.

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

SkipFinalBackup bool

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. For valid values, refer to the AWS documentation.

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

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 Block for details.

DnsName string

DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)

FinalBackupTags map[string]string

A map of tags to apply to the file system's final backup.

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

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

SkipFinalBackup bool

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. For valid values, refer to the AWS documentation.

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

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 Block for details.

dnsName String

DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)

finalBackupTags Map<String,String>

A map of tags to apply to the file system's final backup.

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

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

skipFinalBackup Boolean

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. For valid values, refer to the AWS documentation.

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

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 Block for details.

dnsName string

DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)

finalBackupTags {[key: string]: string}

A map of tags to apply to the file system's final backup.

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

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

skipFinalBackup boolean

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. For valid values, refer to the AWS documentation.

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

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 Block for details.

dns_name str

DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)

final_backup_tags Mapping[str, str]

A map of tags to apply to the file system's final backup.

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

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

skip_final_backup bool

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. For valid values, refer to the AWS documentation.

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

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 Block for details.

dnsName String

DNS name for the file system, e.g., fs-12345678.corp.example.com (domain name matching the Active Directory domain name)

finalBackupTags Map<String>

A map of tags to apply to the file system's final backup.

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

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

skipFinalBackup Boolean

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. For valid values, refer to the AWS documentation.

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:

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

pulumi/pulumi-aws

aws.fsx.WindowsFileSystem

On this page

On this page

Example Usage

Using AWS Directory Service

Using a Self-Managed Microsoft Active Directory

Create WindowsFileSystem Resource

Constructor syntax

Parameters

Constructor example

WindowsFileSystem Resource Properties

Inputs

Outputs

Look up Existing WindowsFileSystem Resource

Supporting Types

WindowsFileSystemAuditLogConfiguration, WindowsFileSystemAuditLogConfigurationArgs

WindowsFileSystemDiskIopsConfiguration, WindowsFileSystemDiskIopsConfigurationArgs

WindowsFileSystemSelfManagedActiveDirectory, WindowsFileSystemSelfManagedActiveDirectoryArgs

Import

Package Details

On this page

On this page