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,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := fsx.NewWindowsFileSystem(ctx, "example", &fsx.WindowsFileSystemArgs{
            ActiveDirectoryId:  pulumi.String(aws_directory_service_directory.Example.Id),
            KmsKeyId:           pulumi.String(aws_kms_key.Example.Arn),
            StorageCapacity:    pulumi.Int(300),
            SubnetIds:          pulumi.String(aws_subnet.Example.Id),
            ThroughputCapacity: pulumi.Int(1024),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.fsx.WindowsFileSystem("example",
    active_directory_id=aws_directory_service_directory["example"]["id"],
    kms_key_id=aws_kms_key["example"]["arn"],
    storage_capacity=300,
    subnet_ids=aws_subnet["example"]["id"],
    throughput_capacity=1024)

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

const example = new aws.fsx.WindowsFileSystem("example", {
    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,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := fsx.NewWindowsFileSystem(ctx, "example", &fsx.WindowsFileSystemArgs{
            KmsKeyId: pulumi.String(aws_kms_key.Example.Arn),
            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"),
            },
            StorageCapacity:    pulumi.Int(300),
            SubnetIds:          pulumi.String(aws_subnet.Example.Id),
            ThroughputCapacity: pulumi.Int(1024),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.fsx.WindowsFileSystem("example",
    kms_key_id=aws_kms_key["example"]["arn"],
    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",
    },
    storage_capacity=300,
    subnet_ids=aws_subnet["example"]["id"],
    throughput_capacity=1024)

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

const example = new aws.fsx.WindowsFileSystem("example", {
    kmsKeyId: aws_kms_key_example.arn,
    selfManagedActiveDirectory: {
        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,
});

Create a WindowsFileSystem Resource

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

def WindowsFileSystem(resource_name, opts=None, active_directory_id=None, automatic_backup_retention_days=None, copy_tags_to_backups=None, daily_automatic_backup_start_time=None, kms_key_id=None, security_group_ids=None, self_managed_active_directory=None, skip_final_backup=None, storage_capacity=None, subnet_ids=None, tags=None, throughput_capacity=None, weekly_maintenance_start_time=None, __props__=None);

func NewWindowsFileSystem(ctx *Context, name string, args WindowsFileSystemArgs, opts ...ResourceOption) (*WindowsFileSystem, error)

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

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.
opts ResourceOptions: A bag of options that control this 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.

WindowsFileSystem Resource Properties

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

Inputs

The WindowsFileSystem resource accepts the following input properties:

StorageCapacity int: Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.
SubnetIds string: 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.
ThroughputCapacity int: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
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.
AutomaticBackupRetentionDays int: The number of days to retain automatic backups. Minimum of 0 and maximum of 35. Defaults to 7. Set to 0 to disable.
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.
KmsKeyId string: ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
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 WindowsFileSystemSelfManagedActiveDirectoryArgs: Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. Detailed below.
SkipFinalBackup bool: When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
Tags Dictionary<string, string>: A map of tags to assign to the file system.
WeeklyMaintenanceStartTime string: The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

StorageCapacity int: Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.
SubnetIds string: 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.
ThroughputCapacity int: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
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.
AutomaticBackupRetentionDays int: The number of days to retain automatic backups. Minimum of 0 and maximum of 35. Defaults to 7. Set to 0 to disable.
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.
KmsKeyId string: ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
SecurityGroupIds []string: A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
SelfManagedActiveDirectory WindowsFileSystemSelfManagedActiveDirectory: Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. Detailed below.
SkipFinalBackup bool: When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
Tags map[string]string: A map of tags to assign to the file system.
WeeklyMaintenanceStartTime string: The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

storageCapacity number: Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.
subnetIds string: 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.
throughputCapacity number: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
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.
automaticBackupRetentionDays number: The number of days to retain automatic backups. Minimum of 0 and maximum of 35. Defaults to 7. Set to 0 to disable.
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.
kmsKeyId string: ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
securityGroupIds string[]: A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
selfManagedActiveDirectory WindowsFileSystemSelfManagedActiveDirectory: Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. Detailed below.
skipFinalBackup boolean: When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
tags {[key: string]: string}: A map of tags to assign to the file system.
weeklyMaintenanceStartTime string: The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

storage_capacity float: Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.
subnet_ids str: 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.
throughput_capacity float: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
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.
automatic_backup_retention_days float: The number of days to retain automatic backups. Minimum of 0 and maximum of 35. Defaults to 7. Set to 0 to disable.
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.
kms_key_id str: ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
security_group_ids List[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 Dict[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. Detailed below.
skip_final_backup bool: When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
tags Dict[str, str]: A map of tags to assign to 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.

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.
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.
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.
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 List[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.
vpc_id str: Identifier of the Virtual Private Cloud for the file system.

Look up an 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

static get(resource_name, id, opts=None, active_directory_id=None, arn=None, automatic_backup_retention_days=None, copy_tags_to_backups=None, daily_automatic_backup_start_time=None, dns_name=None, kms_key_id=None, network_interface_ids=None, owner_id=None, security_group_ids=None, self_managed_active_directory=None, skip_final_backup=None, storage_capacity=None, subnet_ids=None, tags=None, throughput_capacity=None, vpc_id=None, weekly_maintenance_start_time=None, __props__=None);

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)

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.

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.
Arn string: Amazon Resource Name of the file system.
AutomaticBackupRetentionDays int: The number of days to retain automatic backups. Minimum of 0 and maximum of 35. Defaults to 7. Set to 0 to disable.
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.
DnsName string: DNS name for the file system, e.g. fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
KmsKeyId string: ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
NetworkInterfaceIds List<string>: Set of Elastic Network Interface identifiers from which the file system is accessible.
OwnerId string: AWS account identifier that created the file system.
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 WindowsFileSystemSelfManagedActiveDirectoryArgs: Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. Detailed below.
SkipFinalBackup bool: When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
StorageCapacity int: Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.
SubnetIds string: 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.
Tags Dictionary<string, string>: A map of tags to assign to 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: 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.
Arn string: Amazon Resource Name of the file system.
AutomaticBackupRetentionDays int: The number of days to retain automatic backups. Minimum of 0 and maximum of 35. Defaults to 7. Set to 0 to disable.
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.
DnsName string: DNS name for the file system, e.g. fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
KmsKeyId string: ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
NetworkInterfaceIds []string: Set of Elastic Network Interface identifiers from which the file system is accessible.
OwnerId string: AWS account identifier that created the file system.
SecurityGroupIds []string: A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
SelfManagedActiveDirectory WindowsFileSystemSelfManagedActiveDirectory: Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. Detailed below.
SkipFinalBackup bool: When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
StorageCapacity int: Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.
SubnetIds string: 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.
Tags map[string]string: A map of tags to assign to 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: 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.
arn string: Amazon Resource Name of the file system.
automaticBackupRetentionDays number: The number of days to retain automatic backups. Minimum of 0 and maximum of 35. Defaults to 7. Set to 0 to disable.
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.
dnsName string: DNS name for the file system, e.g. fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
kmsKeyId string: ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
networkInterfaceIds string[]: Set of Elastic Network Interface identifiers from which the file system is accessible.
ownerId string: AWS account identifier that created the file system.
securityGroupIds string[]: A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
selfManagedActiveDirectory WindowsFileSystemSelfManagedActiveDirectory: Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with active_directory_id. Detailed below.
skipFinalBackup boolean: When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
storageCapacity number: Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.
subnetIds string: 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.
tags {[key: string]: string}: A map of tags to assign to 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: 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.
arn str: Amazon Resource Name of the file system.
automatic_backup_retention_days float: The number of days to retain automatic backups. Minimum of 0 and maximum of 35. Defaults to 7. Set to 0 to disable.
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.
dns_name str: DNS name for the file system, e.g. fs-12345678.corp.example.com (domain name matching the Active Directory domain name)
kms_key_id str: ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
network_interface_ids List[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.
security_group_ids List[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 Dict[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. Detailed below.
skip_final_backup bool: When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
storage_capacity float: Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.
subnet_ids str: 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.
tags Dict[str, str]: A map of tags to assign to the file system.
throughput_capacity float: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
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.

Supporting Types

WindowsFileSystemSelfManagedActiveDirectory

See the input and output API doc for this type.

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 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 List[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.
fileSystemAdministratorsGroup 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.
organizationalUnitDistinguishedName 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.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud