Class WindowsFileSystem

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

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

Example Usage

Using AWS Directory Service

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Fsx.WindowsFileSystem("example", new Aws.Fsx.WindowsFileSystemArgs
    {
        ActiveDirectoryId = aws_directory_service_directory.Example.Id,
        KmsKeyId = aws_kms_key.Example.Arn,
        StorageCapacity = 300,
        SubnetIds = aws_subnet.Example.Id,
        ThroughputCapacity = 1024,
    });
}

}

Using a Self-Managed Microsoft Active Directory

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Fsx.WindowsFileSystem("example", new Aws.Fsx.WindowsFileSystemArgs
    {
        KmsKeyId = aws_kms_key.Example.Arn,
        SelfManagedActiveDirectory = new Aws.Fsx.Inputs.WindowsFileSystemSelfManagedActiveDirectoryArgs
        {
            DnsIps = 
            {
                "10.0.0.111",
                "10.0.0.222",
            },
            DomainName = "corp.example.com",
            Password = "avoid-plaintext-passwords",
            Username = "Admin",
        },
        StorageCapacity = 300,
        SubnetIds = aws_subnet.Example.Id,
        ThroughputCapacity = 1024,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

WindowsFileSystem

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Fsx

Assembly: Pulumi.Aws.dll

Syntax

public class WindowsFileSystem : CustomResource

Constructors

WindowsFileSystem(String, WindowsFileSystemArgs, CustomResourceOptions)

Create a WindowsFileSystem resource with the given unique name, arguments, and options.

Declaration

public WindowsFileSystem(string name, WindowsFileSystemArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
WindowsFileSystemArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ActiveDirectoryId

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.

Declaration

public Output<string> ActiveDirectoryId { get; }

Property Value

Type	Description
Output<System.String>

Arn

Amazon Resource Name of the file system.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

AutomaticBackupRetentionDays

The number of days to retain automatic backups. Minimum of 0 and maximum of 35. Defaults to 7. Set to 0 to disable.

Declaration

public Output<int?> AutomaticBackupRetentionDays { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

CopyTagsToBackups

A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.

Declaration

public Output<bool?> CopyTagsToBackups { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

DailyAutomaticBackupStartTime

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

Declaration

public Output<string> DailyAutomaticBackupStartTime { get; }

Property Value

Type	Description
Output<System.String>

DnsName

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

Declaration

public Output<string> DnsName { get; }

Property Value

Type	Description
Output<System.String>

KmsKeyId

ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.

Declaration

public Output<string> KmsKeyId { get; }

Property Value

Type	Description
Output<System.String>

NetworkInterfaceIds

Set of Elastic Network Interface identifiers from which the file system is accessible.

Declaration

public Output<ImmutableArray<string>> NetworkInterfaceIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

OwnerId

AWS account identifier that created the file system.

Declaration

public Output<string> OwnerId { get; }

Property Value

Type	Description
Output<System.String>

SecurityGroupIds

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.

Declaration

public Output<ImmutableArray<string>> SecurityGroupIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

SelfManagedActiveDirectory

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. Detailed below.

Declaration

public Output<WindowsFileSystemSelfManagedActiveDirectory> SelfManagedActiveDirectory { get; }

Property Value

Type	Description
Output<WindowsFileSystemSelfManagedActiveDirectory>

SkipFinalBackup

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.

Declaration

public Output<bool?> SkipFinalBackup { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

StorageCapacity

Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.

Declaration

public Output<int> StorageCapacity { get; }

Property Value

Type	Description
Output<System.Int32>

SubnetIds

A list of IDs for the subnets that the file system will be accessible from. File systems support only one subnet. The file server is also launched in that subnet's Availability Zone.

Declaration

public Output<string> SubnetIds { get; }

Property Value

Type	Description
Output<System.String>

Tags

A map of tags to assign to the file system.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

ThroughputCapacity

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

Declaration

public Output<int> ThroughputCapacity { get; }

Property Value

Type	Description
Output<System.Int32>

VpcId

Identifier of the Virtual Private Cloud for the file system.

Declaration

public Output<string> VpcId { get; }

Property Value

Type	Description
Output<System.String>

WeeklyMaintenanceStartTime

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

Declaration

public Output<string> WeeklyMaintenanceStartTime { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, WindowsFileSystemState, CustomResourceOptions)

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

Declaration

public static WindowsFileSystem Get(string name, Input<string> id, WindowsFileSystemState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
WindowsFileSystemState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
WindowsFileSystem