aws.fsx.getWindowsFileSystem

AWS v7.46.0, Sep 10 26

Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Example Usage

Root volume Example

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.fsx.getWindowsFileSystem({
    id: "fs-12345678",
});

import pulumi
import pulumi_aws as aws

example = aws.fsx.get_windows_file_system(id="fs-12345678")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/fsx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fsx.LookupWindowsFileSystem(ctx, &fsx.LookupWindowsFileSystemArgs{
			Id: "fs-12345678",
		}, nil)
		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 = Aws.Fsx.GetWindowsFileSystem.Invoke(new()
    {
        Id = "fs-12345678",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.FsxFunctions;
import com.pulumi.aws.fsx.inputs.GetWindowsFileSystemArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        final var example = FsxFunctions.getWindowsFileSystem(GetWindowsFileSystemArgs.builder()
            .id("fs-12345678")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:fsx:getWindowsFileSystem
      arguments:
        id: fs-12345678

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_fsx_getwindowsfilesystem" "example" {
  id = "fs-12345678"
}

Using getWindowsFileSystem

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWindowsFileSystem(args: GetWindowsFileSystemArgs, opts?: InvokeOptions): Promise<GetWindowsFileSystemResult>
function getWindowsFileSystemOutput(args: GetWindowsFileSystemOutputArgs, opts?: InvokeOutputOptions): Output<GetWindowsFileSystemResult>

def get_windows_file_system(id: Optional[str] = None,
                            region: Optional[str] = None,
                            tags: Optional[Mapping[str, str]] = None,
                            opts: Optional[InvokeOptions] = None) -> GetWindowsFileSystemResult
def get_windows_file_system_output(id: pulumi.Input[Optional[str]] = None,
                            region: pulumi.Input[Optional[str]] = None,
                            tags: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetWindowsFileSystemResult]

func LookupWindowsFileSystem(ctx *Context, args *LookupWindowsFileSystemArgs, opts ...InvokeOption) (*LookupWindowsFileSystemResult, error)
func LookupWindowsFileSystemOutput(ctx *Context, args *LookupWindowsFileSystemOutputArgs, opts ...InvokeOption) LookupWindowsFileSystemResultOutput

> Note: This function is named LookupWindowsFileSystem in the Go SDK.

public static class GetWindowsFileSystem 
{
    public static Task<GetWindowsFileSystemResult> InvokeAsync(GetWindowsFileSystemArgs args, InvokeOptions? opts = null)
    public static Output<GetWindowsFileSystemResult> Invoke(GetWindowsFileSystemInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetWindowsFileSystemResult> Invoke(GetWindowsFileSystemInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetWindowsFileSystemResult> getWindowsFileSystem(GetWindowsFileSystemArgs args, InvokeOptions options)
public static Output<GetWindowsFileSystemResult> getWindowsFileSystem(GetWindowsFileSystemArgs args, InvokeOptions options)
public static Output<GetWindowsFileSystemResult> getWindowsFileSystem(GetWindowsFileSystemArgs args, InvokeOutputOptions options)

fn::invoke:
  function: aws:fsx/getWindowsFileSystem:getWindowsFileSystem
  arguments:
    # arguments dictionary

data "aws_fsx_get_windows_file_system" "name" {
    # arguments
}

The following arguments are supported:

Id string: Identifier of the file system (e.g. fs-12345678).
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Tags Dictionary<string, string>: Tags to associate with the file system.

Id string: Identifier of the file system (e.g. fs-12345678).
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Tags map[string]string: Tags to associate with the file system.

id string: Identifier of the file system (e.g. fs-12345678).
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags map(string): Tags to associate with the file system.

id String: Identifier of the file system (e.g. fs-12345678).
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Map<String,String>: Tags to associate with the file system.

id string: Identifier of the file system (e.g. fs-12345678).
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags {[key: string]: string}: Tags to associate with the file system.

id str: Identifier of the file system (e.g. fs-12345678).
region str: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Mapping[str, str]: Tags to associate with the file system.

id String: Identifier of the file system (e.g. fs-12345678).
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Map<String>: Tags to associate with the file system.

getWindowsFileSystem Result

The following output properties are available:

ActiveDirectoryId string: ID for Microsoft Active Directory instance that the file system is joined to.
Aliases List<string>: Set of DNS alias names associated with the Amazon FSx file system.
Arn string: ARN of the file system.
AuditLogConfigurations List<GetWindowsFileSystemAuditLogConfiguration>: 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.
AutomaticBackupRetentionDays int: Number of days to retain automatic backups.
BackupId string: Identifier of the source backup used to create the file system.
CopyTagsToBackups bool: Whether tags on the file system are copied to backups.
DailyAutomaticBackupStartTime string: Preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
DeploymentType string: File system deployment type.
DiskIopsConfigurations List<GetWindowsFileSystemDiskIopsConfiguration>: SSD IOPS configuration for the file system.
DnsName string: DNS name for the file system (e.g. fs-12345678.corp.example.com).
Id string: Identifier of the file system (e.g. fs-12345678).
KmsKeyId string: ARN for the KMS Key to encrypt the file system at rest.
NetworkInterfaceIds List<string>: Set of network interface identifiers for the file system.
NetworkType string: Network type (IPV4 or DUAL).
OwnerId string: AWS account identifier that created the file system.
PreferredFileServerIp string: IP address of the primary, or preferred, file server.
PreferredSubnetId string: Subnet in which the preferred file server is located.
Region string
SecurityGroupIds List<string>: Set of security group identifiers associated with the file system.
SkipFinalBackup bool: Whether a final backup is skipped when the file system is deleted.
StorageCapacity int: Storage capacity of the file system in gibibytes (GiB).
StorageType string: Type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.
SubnetIds List<string>: IDs of the subnets that the file system is accessible from.
Tags Dictionary<string, string>: Tags to associate with the file system.
ThroughputCapacity int: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
VpcId string: ID of the primary VPC for the file system.
WeeklyMaintenanceStartTime string: Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

ActiveDirectoryId string: ID for Microsoft Active Directory instance that the file system is joined to.
Aliases []string: Set of DNS alias names associated with the Amazon FSx file system.
Arn string: ARN of the file system.
AuditLogConfigurations []GetWindowsFileSystemAuditLogConfiguration: 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.
AutomaticBackupRetentionDays int: Number of days to retain automatic backups.
BackupId string: Identifier of the source backup used to create the file system.
CopyTagsToBackups bool: Whether tags on the file system are copied to backups.
DailyAutomaticBackupStartTime string: Preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
DeploymentType string: File system deployment type.
DiskIopsConfigurations []GetWindowsFileSystemDiskIopsConfiguration: SSD IOPS configuration for the file system.
DnsName string: DNS name for the file system (e.g. fs-12345678.corp.example.com).
Id string: Identifier of the file system (e.g. fs-12345678).
KmsKeyId string: ARN for the KMS Key to encrypt the file system at rest.
NetworkInterfaceIds []string: Set of network interface identifiers for the file system.
NetworkType string: Network type (IPV4 or DUAL).
OwnerId string: AWS account identifier that created the file system.
PreferredFileServerIp string: IP address of the primary, or preferred, file server.
PreferredSubnetId string: Subnet in which the preferred file server is located.
Region string
SecurityGroupIds []string: Set of security group identifiers associated with the file system.
SkipFinalBackup bool: Whether a final backup is skipped when the file system is deleted.
StorageCapacity int: Storage capacity of the file system in gibibytes (GiB).
StorageType string: Type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.
SubnetIds []string: IDs of the subnets that the file system is accessible from.
Tags map[string]string: Tags to associate with the file system.
ThroughputCapacity int: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
VpcId string: ID of the primary VPC for the file system.
WeeklyMaintenanceStartTime string: Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

active_directory_id string: ID for Microsoft Active Directory instance that the file system is joined to.
aliases list(string): Set of DNS alias names associated with the Amazon FSx file system.
arn string: ARN of the file system.
audit_log_configurations list(object): 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.
automatic_backup_retention_days number: Number of days to retain automatic backups.
backup_id string: Identifier of the source backup used to create the file system.
copy_tags_to_backups bool: Whether tags on the file system are copied to backups.
daily_automatic_backup_start_time string: Preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
deployment_type string: File system deployment type.
disk_iops_configurations list(object): SSD IOPS configuration for the file system.
dns_name string: DNS name for the file system (e.g. fs-12345678.corp.example.com).
id string: Identifier of the file system (e.g. fs-12345678).
kms_key_id string: ARN for the KMS Key to encrypt the file system at rest.
network_interface_ids list(string): Set of network interface identifiers for the file system.
network_type string: Network type (IPV4 or DUAL).
owner_id string: AWS account identifier that created the file system.
preferred_file_server_ip string: IP address of the primary, or preferred, file server.
preferred_subnet_id string: Subnet in which the preferred file server is located.
region string
security_group_ids list(string): Set of security group identifiers associated with the file system.
skip_final_backup bool: Whether a final backup is skipped when the file system is deleted.
storage_capacity number: Storage capacity of the file system in gibibytes (GiB).
storage_type string: Type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.
subnet_ids list(string): IDs of the subnets that the file system is accessible from.
tags map(string): Tags to associate with the file system.
throughput_capacity number: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
vpc_id string: ID of the primary VPC for the file system.
weekly_maintenance_start_time string: Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

activeDirectoryId String: ID for Microsoft Active Directory instance that the file system is joined to.
aliases List<String>: Set of DNS alias names associated with the Amazon FSx file system.
arn String: ARN of the file system.
auditLogConfigurations List<GetWindowsFileSystemAuditLogConfiguration>: 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.
automaticBackupRetentionDays Integer: Number of days to retain automatic backups.
backupId String: Identifier of the source backup used to create the file system.
copyTagsToBackups Boolean: Whether tags on the file system are copied to backups.
dailyAutomaticBackupStartTime String: Preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
deploymentType String: File system deployment type.
diskIopsConfigurations List<GetWindowsFileSystemDiskIopsConfiguration>: SSD IOPS configuration for the file system.
dnsName String: DNS name for the file system (e.g. fs-12345678.corp.example.com).
id String: Identifier of the file system (e.g. fs-12345678).
kmsKeyId String: ARN for the KMS Key to encrypt the file system at rest.
networkInterfaceIds List<String>: Set of network interface identifiers for the file system.
networkType String: Network type (IPV4 or DUAL).
ownerId String: AWS account identifier that created the file system.
preferredFileServerIp String: IP address of the primary, or preferred, file server.
preferredSubnetId String: Subnet in which the preferred file server is located.
region String
securityGroupIds List<String>: Set of security group identifiers associated with the file system.
skipFinalBackup Boolean: Whether a final backup is skipped when the file system is deleted.
storageCapacity Integer: Storage capacity of the file system in gibibytes (GiB).
storageType String: Type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.
subnetIds List<String>: IDs of the subnets that the file system is accessible from.
tags Map<String,String>: Tags to associate with the file system.
throughputCapacity Integer: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
vpcId String: ID of the primary VPC for the file system.
weeklyMaintenanceStartTime String: Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

activeDirectoryId string: ID for Microsoft Active Directory instance that the file system is joined to.
aliases string[]: Set of DNS alias names associated with the Amazon FSx file system.
arn string: ARN of the file system.
auditLogConfigurations GetWindowsFileSystemAuditLogConfiguration[]: 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.
automaticBackupRetentionDays number: Number of days to retain automatic backups.
backupId string: Identifier of the source backup used to create the file system.
copyTagsToBackups boolean: Whether tags on the file system are copied to backups.
dailyAutomaticBackupStartTime string: Preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
deploymentType string: File system deployment type.
diskIopsConfigurations GetWindowsFileSystemDiskIopsConfiguration[]: SSD IOPS configuration for the file system.
dnsName string: DNS name for the file system (e.g. fs-12345678.corp.example.com).
id string: Identifier of the file system (e.g. fs-12345678).
kmsKeyId string: ARN for the KMS Key to encrypt the file system at rest.
networkInterfaceIds string[]: Set of network interface identifiers for the file system.
networkType string: Network type (IPV4 or DUAL).
ownerId string: AWS account identifier that created the file system.
preferredFileServerIp string: IP address of the primary, or preferred, file server.
preferredSubnetId string: Subnet in which the preferred file server is located.
region string
securityGroupIds string[]: Set of security group identifiers associated with the file system.
skipFinalBackup boolean: Whether a final backup is skipped when the file system is deleted.
storageCapacity number: Storage capacity of the file system in gibibytes (GiB).
storageType string: Type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.
subnetIds string[]: IDs of the subnets that the file system is accessible from.
tags {[key: string]: string}: Tags to associate with the file system.
throughputCapacity number: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
vpcId string: ID of the primary VPC for the file system.
weeklyMaintenanceStartTime string: Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

active_directory_id str: ID for Microsoft Active Directory instance that the file system is joined to.
aliases Sequence[str]: Set of DNS alias names associated with the Amazon FSx file system.
arn str: ARN of the file system.
audit_log_configurations Sequence[GetWindowsFileSystemAuditLogConfiguration]: 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.
automatic_backup_retention_days int: Number of days to retain automatic backups.
backup_id str: Identifier of the source backup used to create the file system.
copy_tags_to_backups bool: Whether tags on the file system are copied to backups.
daily_automatic_backup_start_time str: Preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
deployment_type str: File system deployment type.
disk_iops_configurations Sequence[GetWindowsFileSystemDiskIopsConfiguration]: SSD IOPS configuration for the file system.
dns_name str: DNS name for the file system (e.g. fs-12345678.corp.example.com).
id str: Identifier of the file system (e.g. fs-12345678).
kms_key_id str: ARN for the KMS Key to encrypt the file system at rest.
network_interface_ids Sequence[str]: Set of network interface identifiers for the file system.
network_type str: Network type (IPV4 or DUAL).
owner_id str: AWS account identifier that created the file system.
preferred_file_server_ip str: IP address of the primary, or preferred, file server.
preferred_subnet_id str: Subnet in which the preferred file server is located.
region str
security_group_ids Sequence[str]: Set of security group identifiers associated with the file system.
skip_final_backup bool: Whether a final backup is skipped when the file system is deleted.
storage_capacity int: Storage capacity of the file system in gibibytes (GiB).
storage_type str: Type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.
subnet_ids Sequence[str]: IDs of the subnets that the file system is accessible from.
tags Mapping[str, str]: Tags to associate with the file system.
throughput_capacity int: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
vpc_id str: ID of the primary VPC for the file system.
weekly_maintenance_start_time str: Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

activeDirectoryId String: ID for Microsoft Active Directory instance that the file system is joined to.
aliases List<String>: Set of DNS alias names associated with the Amazon FSx file system.
arn String: ARN of the file system.
auditLogConfigurations List<Property Map>: 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.
automaticBackupRetentionDays Number: Number of days to retain automatic backups.
backupId String: Identifier of the source backup used to create the file system.
copyTagsToBackups Boolean: Whether tags on the file system are copied to backups.
dailyAutomaticBackupStartTime String: Preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
deploymentType String: File system deployment type.
diskIopsConfigurations List<Property Map>: SSD IOPS configuration for the file system.
dnsName String: DNS name for the file system (e.g. fs-12345678.corp.example.com).
id String: Identifier of the file system (e.g. fs-12345678).
kmsKeyId String: ARN for the KMS Key to encrypt the file system at rest.
networkInterfaceIds List<String>: Set of network interface identifiers for the file system.
networkType String: Network type (IPV4 or DUAL).
ownerId String: AWS account identifier that created the file system.
preferredFileServerIp String: IP address of the primary, or preferred, file server.
preferredSubnetId String: Subnet in which the preferred file server is located.
region String
securityGroupIds List<String>: Set of security group identifiers associated with the file system.
skipFinalBackup Boolean: Whether a final backup is skipped when the file system is deleted.
storageCapacity Number: Storage capacity of the file system in gibibytes (GiB).
storageType String: Type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.
subnetIds List<String>: IDs of the subnets that the file system is accessible from.
tags Map<String>: Tags to associate with the file system.
throughputCapacity Number: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
vpcId String: ID of the primary VPC for the file system.
weeklyMaintenanceStartTime String: Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.