1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. fsx

Module fsx

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Others

Resources

Resource LustreFileSystem

class LustreFileSystem extends CustomResource

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

Example Usage

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

const example = new aws.fsx.LustreFileSystem("example", {
    importPath: pulumi.interpolate`s3://${aws_s3_bucket_example.bucket}`,
    storageCapacity: 1200,
    subnetIds: aws_subnet_example.id,
});

constructor

new LustreFileSystem(name: string, args: LustreFileSystemArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LustreFileSystemState, opts?: pulumi.CustomResourceOptions): LustreFileSystem

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is LustreFileSystem

Returns true if the given object is an instance of LustreFileSystem. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name of the file system.

property dnsName

public dnsName: pulumi.Output<string>;

DNS name for the file system, e.g. fs-12345678.fsx.us-west-2.amazonaws.com

property exportPath

public exportPath: pulumi.Output<string>;

S3 URI (with optional prefix) where the root of your Amazon FSx file system is exported. Can only be specified with importPath argument and the path must use the same Amazon S3 bucket as specified in importPath. Set equal to importPath to overwrite files on export. Defaults to s3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property importPath

public importPath: pulumi.Output<string | undefined>;

S3 URI (with optional prefix) that you’re using as the data repository for your FSx for Lustre file system. For example, s3://example-bucket/optional-prefix/.

property importedFileChunkSize

public importedFileChunkSize: pulumi.Output<number>;

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. Can only be specified with importPath argument. Defaults to 1024. Minimum of 1 and maximum of 512000.

property networkInterfaceIds

public networkInterfaceIds: pulumi.Output<string[]>;

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

property ownerId

public ownerId: pulumi.Output<string>;

AWS account identifier that created the file system.

property securityGroupIds

public securityGroupIds: pulumi.Output<string[] | undefined>;

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.

property storageCapacity

public storageCapacity: pulumi.Output<number>;

The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.

property subnetIds

public subnetIds: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the file system.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

Identifier of the Virtual Private Cloud for the file system.

property weeklyMaintenanceStartTime

public weeklyMaintenanceStartTime: pulumi.Output<string>;

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

Resource WindowsFileSystem

class WindowsFileSystem extends CustomResource

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

NOTE: Either the activeDirectoryId argument or selfManagedActiveDirectory configuration block must be specified.

Example Usage

Using AWS Directory Service
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
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,
});

constructor

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

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WindowsFileSystemState, opts?: pulumi.CustomResourceOptions): WindowsFileSystem

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is WindowsFileSystem

Returns true if the given object is an instance of WindowsFileSystem. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property activeDirectoryId

public activeDirectoryId: pulumi.Output<string | undefined>;

The ID for an existing Microsoft Active Directory instance that the file system should join when it’s created. Cannot be specified with selfManagedActiveDirectory.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name of the file system.

property automaticBackupRetentionDays

public automaticBackupRetentionDays: pulumi.Output<number | undefined>;

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

property copyTagsToBackups

public copyTagsToBackups: pulumi.Output<boolean | undefined>;

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

property dailyAutomaticBackupStartTime

public dailyAutomaticBackupStartTime: pulumi.Output<string>;

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

property dnsName

public dnsName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

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

property networkInterfaceIds

public networkInterfaceIds: pulumi.Output<string[]>;

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

property ownerId

public ownerId: pulumi.Output<string>;

AWS account identifier that created the file system.

property securityGroupIds

public securityGroupIds: pulumi.Output<string[] | undefined>;

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.

property selfManagedActiveDirectory

public selfManagedActiveDirectory: pulumi.Output<WindowsFileSystemSelfManagedActiveDirectory | undefined>;

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

property skipFinalBackup

public skipFinalBackup: pulumi.Output<boolean | undefined>;

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.

property storageCapacity

public storageCapacity: pulumi.Output<number>;

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

property subnetIds

public subnetIds: pulumi.Output<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.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the file system.

property throughputCapacity

public throughputCapacity: pulumi.Output<number>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

Identifier of the Virtual Private Cloud for the file system.

property weeklyMaintenanceStartTime

public weeklyMaintenanceStartTime: pulumi.Output<string>;

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

Others

interface LustreFileSystemArgs

interface LustreFileSystemArgs

The set of arguments for constructing a LustreFileSystem resource.

property exportPath

exportPath?: pulumi.Input<string>;

S3 URI (with optional prefix) where the root of your Amazon FSx file system is exported. Can only be specified with importPath argument and the path must use the same Amazon S3 bucket as specified in importPath. Set equal to importPath to overwrite files on export. Defaults to s3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}.

property importPath

importPath?: pulumi.Input<string>;

S3 URI (with optional prefix) that you’re using as the data repository for your FSx for Lustre file system. For example, s3://example-bucket/optional-prefix/.

property importedFileChunkSize

importedFileChunkSize?: pulumi.Input<number>;

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. Can only be specified with importPath argument. Defaults to 1024. Minimum of 1 and maximum of 512000.

property securityGroupIds

securityGroupIds?: pulumi.Input<pulumi.Input<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.

property storageCapacity

storageCapacity: pulumi.Input<number>;

The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.

property subnetIds

subnetIds: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the file system.

property weeklyMaintenanceStartTime

weeklyMaintenanceStartTime?: pulumi.Input<string>;

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

interface LustreFileSystemState

interface LustreFileSystemState

Input properties used for looking up and filtering LustreFileSystem resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name of the file system.

property dnsName

dnsName?: pulumi.Input<string>;

DNS name for the file system, e.g. fs-12345678.fsx.us-west-2.amazonaws.com

property exportPath

exportPath?: pulumi.Input<string>;

S3 URI (with optional prefix) where the root of your Amazon FSx file system is exported. Can only be specified with importPath argument and the path must use the same Amazon S3 bucket as specified in importPath. Set equal to importPath to overwrite files on export. Defaults to s3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}.

property importPath

importPath?: pulumi.Input<string>;

S3 URI (with optional prefix) that you’re using as the data repository for your FSx for Lustre file system. For example, s3://example-bucket/optional-prefix/.

property importedFileChunkSize

importedFileChunkSize?: pulumi.Input<number>;

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. Can only be specified with importPath argument. Defaults to 1024. Minimum of 1 and maximum of 512000.

property networkInterfaceIds

networkInterfaceIds?: pulumi.Input<pulumi.Input<string>[]>;

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

property ownerId

ownerId?: pulumi.Input<string>;

AWS account identifier that created the file system.

property securityGroupIds

securityGroupIds?: pulumi.Input<pulumi.Input<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.

property storageCapacity

storageCapacity?: pulumi.Input<number>;

The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.

property subnetIds

subnetIds?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the file system.

property vpcId

vpcId?: pulumi.Input<string>;

Identifier of the Virtual Private Cloud for the file system.

property weeklyMaintenanceStartTime

weeklyMaintenanceStartTime?: pulumi.Input<string>;

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

interface WindowsFileSystemArgs

interface WindowsFileSystemArgs

The set of arguments for constructing a WindowsFileSystem resource.

property activeDirectoryId

activeDirectoryId?: pulumi.Input<string>;

The ID for an existing Microsoft Active Directory instance that the file system should join when it’s created. Cannot be specified with selfManagedActiveDirectory.

property automaticBackupRetentionDays

automaticBackupRetentionDays?: pulumi.Input<number>;

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

property copyTagsToBackups

copyTagsToBackups?: pulumi.Input<boolean>;

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

property dailyAutomaticBackupStartTime

dailyAutomaticBackupStartTime?: pulumi.Input<string>;

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

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

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

property securityGroupIds

securityGroupIds?: pulumi.Input<pulumi.Input<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.

property selfManagedActiveDirectory

selfManagedActiveDirectory?: pulumi.Input<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 activeDirectoryId. Detailed below.

property skipFinalBackup

skipFinalBackup?: pulumi.Input<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.

property storageCapacity

storageCapacity: pulumi.Input<number>;

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

property subnetIds

subnetIds: pulumi.Input<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.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the file system.

property throughputCapacity

throughputCapacity: pulumi.Input<number>;

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

property weeklyMaintenanceStartTime

weeklyMaintenanceStartTime?: pulumi.Input<string>;

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

interface WindowsFileSystemState

interface WindowsFileSystemState

Input properties used for looking up and filtering WindowsFileSystem resources.

property activeDirectoryId

activeDirectoryId?: pulumi.Input<string>;

The ID for an existing Microsoft Active Directory instance that the file system should join when it’s created. Cannot be specified with selfManagedActiveDirectory.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name of the file system.

property automaticBackupRetentionDays

automaticBackupRetentionDays?: pulumi.Input<number>;

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

property copyTagsToBackups

copyTagsToBackups?: pulumi.Input<boolean>;

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

property dailyAutomaticBackupStartTime

dailyAutomaticBackupStartTime?: pulumi.Input<string>;

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

property dnsName

dnsName?: pulumi.Input<string>;

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

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

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

property networkInterfaceIds

networkInterfaceIds?: pulumi.Input<pulumi.Input<string>[]>;

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

property ownerId

ownerId?: pulumi.Input<string>;

AWS account identifier that created the file system.

property securityGroupIds

securityGroupIds?: pulumi.Input<pulumi.Input<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.

property selfManagedActiveDirectory

selfManagedActiveDirectory?: pulumi.Input<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 activeDirectoryId. Detailed below.

property skipFinalBackup

skipFinalBackup?: pulumi.Input<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.

property storageCapacity

storageCapacity?: pulumi.Input<number>;

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

property subnetIds

subnetIds?: pulumi.Input<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.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the file system.

property throughputCapacity

throughputCapacity?: pulumi.Input<number>;

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

property vpcId

vpcId?: pulumi.Input<string>;

Identifier of the Virtual Private Cloud for the file system.

property weeklyMaintenanceStartTime

weeklyMaintenanceStartTime?: pulumi.Input<string>;

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