aws.fsx.getWindowsFileSystem

Explore with Pulumi AI

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

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/v6/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.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) {
        final var example = FsxFunctions.getWindowsFileSystem(GetWindowsFileSystemArgs.builder()
            .id("fs-12345678")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:fsx:getWindowsFileSystem
      arguments:
        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?: InvokeOptions): Output<GetWindowsFileSystemResult>

def get_windows_file_system(id: Optional[str] = None,
                            tags: Optional[Mapping[str, str]] = None,
                            opts: Optional[InvokeOptions] = None) -> GetWindowsFileSystemResult
def get_windows_file_system_output(id: Optional[pulumi.Input[str]] = None,
                            tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                            opts: Optional[InvokeOptions] = 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 CompletableFuture<GetWindowsFileSystemResult> getWindowsFileSystem(GetWindowsFileSystemArgs args, InvokeOptions options)
public static Output<GetWindowsFileSystemResult> getWindowsFileSystem(GetWindowsFileSystemArgs args, InvokeOptions options)

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

The following arguments are supported:

Id string: Identifier of the file system (e.g. fs-12345678).
Tags Dictionary<string, string>: The tags to associate with the file system.

Id string: Identifier of the file system (e.g. fs-12345678).
Tags map[string]string: The tags to associate with the file system.

id String: Identifier of the file system (e.g. fs-12345678).
tags Map<String,String>: The tags to associate with the file system.

id string: Identifier of the file system (e.g. fs-12345678).
tags {[key: string]: string}: The tags to associate with the file system.

id str: Identifier of the file system (e.g. fs-12345678).
tags Mapping[str, str]: The tags to associate with the file system.

id String: Identifier of the file system (e.g. fs-12345678).
tags Map<String>: The tags to associate with the file system.

getWindowsFileSystem Result

The following output properties are available:

ActiveDirectoryId string: The ID for Microsoft Active Directory instance that the file system is join to.
Aliases List<string>: An array DNS alias names associated with the Amazon FSx file system.
Arn string: Amazon Resource Name of the file system.
AuditLogConfigurations List<GetWindowsFileSystemAuditLogConfiguration>: 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.
AutomaticBackupRetentionDays int: The number of days to retain automatic backups.
BackupId string
CopyTagsToBackups bool: A boolean flag indicating whether tags on the file system should be copied to backups.
DailyAutomaticBackupStartTime string: The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
DeploymentType string: The file system deployment type.
DiskIopsConfigurations List<GetWindowsFileSystemDiskIopsConfiguration>: The 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>
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.
SecurityGroupIds List<string>
SkipFinalBackup bool
StorageCapacity int: The storage capacity of the file system in gibibytes (GiB).
StorageType string: The 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>: Specifies the IDs of the subnets that the file system is accessible from.
Tags Dictionary<string, string>: The 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: The ID of the primary virtual private cloud (VPC) 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 Microsoft Active Directory instance that the file system is join to.
Aliases []string: An array DNS alias names associated with the Amazon FSx file system.
Arn string: Amazon Resource Name of the file system.
AuditLogConfigurations []GetWindowsFileSystemAuditLogConfiguration: 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.
AutomaticBackupRetentionDays int: The number of days to retain automatic backups.
BackupId string
CopyTagsToBackups bool: A boolean flag indicating whether tags on the file system should be copied to backups.
DailyAutomaticBackupStartTime string: The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
DeploymentType string: The file system deployment type.
DiskIopsConfigurations []GetWindowsFileSystemDiskIopsConfiguration: The 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
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.
SecurityGroupIds []string
SkipFinalBackup bool
StorageCapacity int: The storage capacity of the file system in gibibytes (GiB).
StorageType string: The 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: Specifies the IDs of the subnets that the file system is accessible from.
Tags map[string]string: The 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: The ID of the primary virtual private cloud (VPC) 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 Microsoft Active Directory instance that the file system is join to.
aliases List<String>: An array DNS alias names associated with the Amazon FSx file system.
arn String: Amazon Resource Name of the file system.
auditLogConfigurations List<GetWindowsFileSystemAuditLogConfiguration>: 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.
automaticBackupRetentionDays Integer: The number of days to retain automatic backups.
backupId String
copyTagsToBackups Boolean: A boolean flag indicating whether tags on the file system should be copied to backups.
dailyAutomaticBackupStartTime String: The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
deploymentType String: The file system deployment type.
diskIopsConfigurations List<GetWindowsFileSystemDiskIopsConfiguration>: The 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>
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.
securityGroupIds List<String>
skipFinalBackup Boolean
storageCapacity Integer: The storage capacity of the file system in gibibytes (GiB).
storageType String: The 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>: Specifies the IDs of the subnets that the file system is accessible from.
tags Map<String,String>: The 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: The ID of the primary virtual private cloud (VPC) 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 Microsoft Active Directory instance that the file system is join to.
aliases string[]: An array DNS alias names associated with the Amazon FSx file system.
arn string: Amazon Resource Name of the file system.
auditLogConfigurations GetWindowsFileSystemAuditLogConfiguration[]: 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.
automaticBackupRetentionDays number: The number of days to retain automatic backups.
backupId string
copyTagsToBackups boolean: A boolean flag indicating whether tags on the file system should be copied to backups.
dailyAutomaticBackupStartTime string: The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
deploymentType string: The file system deployment type.
diskIopsConfigurations GetWindowsFileSystemDiskIopsConfiguration[]: The 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[]
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.
securityGroupIds string[]
skipFinalBackup boolean
storageCapacity number: The storage capacity of the file system in gibibytes (GiB).
storageType string: The 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[]: Specifies the IDs of the subnets that the file system is accessible from.
tags {[key: string]: string}: The 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: The ID of the primary virtual private cloud (VPC) 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 Microsoft Active Directory instance that the file system is join to.
aliases Sequence[str]: An array DNS alias names associated with the Amazon FSx file system.
arn str: Amazon Resource Name of the file system.
audit_log_configurations Sequence[GetWindowsFileSystemAuditLogConfiguration]: 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.
automatic_backup_retention_days int: The number of days to retain automatic backups.
backup_id str
copy_tags_to_backups bool: A boolean flag indicating whether tags on the file system should be copied to backups.
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: The file system deployment type.
disk_iops_configurations Sequence[GetWindowsFileSystemDiskIopsConfiguration]: The 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]
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.
security_group_ids Sequence[str]
skip_final_backup bool
storage_capacity int: The storage capacity of the file system in gibibytes (GiB).
storage_type str: The 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]: Specifies the IDs of the subnets that the file system is accessible from.
tags Mapping[str, str]: The 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: The ID of the primary virtual private cloud (VPC) 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 Microsoft Active Directory instance that the file system is join to.
aliases List<String>: An array DNS alias names associated with the Amazon FSx file system.
arn String: Amazon Resource Name of the file system.
auditLogConfigurations List<Property Map>: The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
automaticBackupRetentionDays Number: The number of days to retain automatic backups.
backupId String
copyTagsToBackups Boolean: A boolean flag indicating whether tags on the file system should be copied to backups.
dailyAutomaticBackupStartTime String: The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
deploymentType String: The file system deployment type.
diskIopsConfigurations List<Property Map>: The 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>
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.
securityGroupIds List<String>
skipFinalBackup Boolean
storageCapacity Number: The storage capacity of the file system in gibibytes (GiB).
storageType String: The 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>: Specifies the IDs of the subnets that the file system is accessible from.
tags Map<String>: The 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: The ID of the primary virtual private cloud (VPC) for the file system.
weeklyMaintenanceStartTime String: The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.