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.

fsx¶

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.

class pulumi_aws.fsx.LustreFileSystem(resource_name, opts=None, export_path=None, import_path=None, imported_file_chunk_size=None, security_group_ids=None, storage_capacity=None, subnet_ids=None, tags=None, weekly_maintenance_start_time=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_aws as aws

example = aws.fsx.LustreFileSystem("example",
    import_path=f"s3://{aws_s3_bucket['example']['bucket']}",
    storage_capacity=1200,
    subnet_ids=aws_subnet["example"]["id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
export_path (pulumi.Input[str]) – S3 URI (with optional prefix) where the root of your Amazon FSx file system is exported. Can only be specified with import_path argument and the path must use the same Amazon S3 bucket as specified in import_path. Set equal to import_path to overwrite files on export. Defaults to s3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}.
import_path (pulumi.Input[str]) – 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/.
imported_file_chunk_size (pulumi.Input[float]) – 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 import_path argument. Defaults to 1024. Minimum of 1 and maximum of 512000.
security_group_ids (pulumi.Input[list]) – 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.
storage_capacity (pulumi.Input[float]) – The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.
subnet_ids (pulumi.Input[str]) – 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.
tags (pulumi.Input[dict]) – A map of tags to assign to the file system.
weekly_maintenance_start_time (pulumi.Input[str]) – The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

arn: pulumi.Output[str] = None¶: Amazon Resource Name of the file system.

dns_name: pulumi.Output[str] = None¶: DNS name for the file system, e.g. fs-12345678.fsx.us-west-2.amazonaws.com

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

import_path: pulumi.Output[str] = None¶: 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/.

imported_file_chunk_size: pulumi.Output[float] = None¶: 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 import_path argument. Defaults to 1024. Minimum of 1 and maximum of 512000.

network_interface_ids: pulumi.Output[list] = None¶: Set of Elastic Network Interface identifiers from which the file system is accessible.

owner_id: pulumi.Output[str] = None¶: AWS account identifier that created the file system.

security_group_ids: pulumi.Output[list] = None¶: 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.

storage_capacity: pulumi.Output[float] = None¶: The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.

subnet_ids: pulumi.Output[str] = None¶: 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.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the file system.

vpc_id: pulumi.Output[str] = None¶: Identifier of the Virtual Private Cloud for the file system.

weekly_maintenance_start_time: pulumi.Output[str] = None¶: The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

static get(resource_name, id, opts=None, arn=None, dns_name=None, export_path=None, import_path=None, imported_file_chunk_size=None, network_interface_ids=None, owner_id=None, security_group_ids=None, storage_capacity=None, subnet_ids=None, tags=None, vpc_id=None, weekly_maintenance_start_time=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – Amazon Resource Name of the file system.
dns_name (pulumi.Input[str]) – DNS name for the file system, e.g. fs-12345678.fsx.us-west-2.amazonaws.com
export_path (pulumi.Input[str]) – S3 URI (with optional prefix) where the root of your Amazon FSx file system is exported. Can only be specified with import_path argument and the path must use the same Amazon S3 bucket as specified in import_path. Set equal to import_path to overwrite files on export. Defaults to s3://{IMPORT BUCKET}/FSxLustre{CREATION TIMESTAMP}.
import_path (pulumi.Input[str]) – 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/.
imported_file_chunk_size (pulumi.Input[float]) – 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 import_path argument. Defaults to 1024. Minimum of 1 and maximum of 512000.
network_interface_ids (pulumi.Input[list]) – Set of Elastic Network Interface identifiers from which the file system is accessible.
owner_id (pulumi.Input[str]) – AWS account identifier that created the file system.
security_group_ids (pulumi.Input[list]) – 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.
storage_capacity (pulumi.Input[float]) – The storage capacity (GiB) of the file system. Minimum of 1200. Storage capacity is provisioned in increments of 3,600 GiB.
subnet_ids (pulumi.Input[str]) – 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.
tags (pulumi.Input[dict]) – A map of tags to assign to the file system.
vpc_id (pulumi.Input[str]) – Identifier of the Virtual Private Cloud for the file system.
weekly_maintenance_start_time (pulumi.Input[str]) – The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.fsx.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, __name__=None, __opts__=None)¶

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.

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 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)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
active_directory_id (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[bool]) – A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
daily_automatic_backup_start_time (pulumi.Input[str]) – The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
kms_key_id (pulumi.Input[str]) – ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
security_group_ids (pulumi.Input[list]) – 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 (pulumi.Input[dict]) – 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 (pulumi.Input[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 (pulumi.Input[float]) – Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.
subnet_ids (pulumi.Input[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 (pulumi.Input[dict]) – A map of tags to assign to the file system.
throughput_capacity (pulumi.Input[float]) – Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
weekly_maintenance_start_time (pulumi.Input[str]) – The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

The self_managed_active_directory object supports the following:

dns_ips (pulumi.Input[list]) - 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 (pulumi.Input[str]) - The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
fileSystemAdministratorsGroup (pulumi.Input[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 (pulumi.Input[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.
password (pulumi.Input[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 (pulumi.Input[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.

active_directory_id: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: Amazon Resource Name of the file system.

automatic_backup_retention_days: pulumi.Output[float] = None¶: 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: pulumi.Output[bool] = None¶: A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.

daily_automatic_backup_start_time: pulumi.Output[str] = None¶: The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.

dns_name: pulumi.Output[str] = None¶: DNS name for the file system, e.g. fs-12345678.corp.example.com (domain name matching the Active Directory domain name)

kms_key_id: pulumi.Output[str] = None¶: ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.

network_interface_ids: pulumi.Output[list] = None¶: Set of Elastic Network Interface identifiers from which the file system is accessible.

owner_id: pulumi.Output[str] = None¶: AWS account identifier that created the file system.

security_group_ids: pulumi.Output[list] = None¶: 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: pulumi.Output[dict] = None¶

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.

dns_ips (list) - 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.
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.
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.

skip_final_backup: pulumi.Output[bool] = None¶: 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: pulumi.Output[float] = None¶: Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.

subnet_ids: pulumi.Output[str] = None¶: 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: pulumi.Output[dict] = None¶: A map of tags to assign to the file system.

throughput_capacity: pulumi.Output[float] = None¶: Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.

vpc_id: pulumi.Output[str] = None¶: Identifier of the Virtual Private Cloud for the file system.

weekly_maintenance_start_time: pulumi.Output[str] = None¶: The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

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)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
active_directory_id (pulumi.Input[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 (pulumi.Input[str]) – Amazon Resource Name of the file system.
automatic_backup_retention_days (pulumi.Input[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 (pulumi.Input[bool]) – A boolean flag indicating whether tags on the file system should be copied to backups. Defaults to false.
daily_automatic_backup_start_time (pulumi.Input[str]) – The preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
dns_name (pulumi.Input[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 (pulumi.Input[str]) – ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
network_interface_ids (pulumi.Input[list]) – Set of Elastic Network Interface identifiers from which the file system is accessible.
owner_id (pulumi.Input[str]) – AWS account identifier that created the file system.
security_group_ids (pulumi.Input[list]) – 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 (pulumi.Input[dict]) – 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 (pulumi.Input[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 (pulumi.Input[float]) – Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536.
subnet_ids (pulumi.Input[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 (pulumi.Input[dict]) – A map of tags to assign to the file system.
throughput_capacity (pulumi.Input[float]) – Throughput (megabytes per second) of the file system in power of 2 increments. Minimum of 8 and maximum of 2048.
vpc_id (pulumi.Input[str]) – Identifier of the Virtual Private Cloud for the file system.
weekly_maintenance_start_time (pulumi.Input[str]) – The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.

The self_managed_active_directory object supports the following:

dns_ips (pulumi.Input[list]) - 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 (pulumi.Input[str]) - The fully qualified domain name of the self-managed AD directory. For example, corp.example.com.
fileSystemAdministratorsGroup (pulumi.Input[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 (pulumi.Input[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.
password (pulumi.Input[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 (pulumi.Input[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.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

fsx¶

On This Page