Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. fsx
  5. OntapFileSystem
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.fsx.OntapFileSystem

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Manages an Amazon FSx for NetApp ONTAP file system. See the FSx ONTAP User Guide for more information.

Example Usage

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

const test = new aws.fsx.OntapFileSystem("test", {
    storageCapacity: 1024,
    subnetIds: [
        test1.id,
        test2.id,
    ],
    deploymentType: "MULTI_AZ_1",
    throughputCapacity: 512,
    preferredSubnetId: test1.id,
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.fsx.OntapFileSystem("test",
    storage_capacity=1024,
    subnet_ids=[
        test1["id"],
        test2["id"],
    ],
    deployment_type="MULTI_AZ_1",
    throughput_capacity=512,
    preferred_subnet_id=test1["id"])
Copy
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.NewOntapFileSystem(ctx, "test", &fsx.OntapFileSystemArgs{
			StorageCapacity: pulumi.Int(1024),
			SubnetIds: pulumi.StringArray{
				test1.Id,
				test2.Id,
			},
			DeploymentType:     pulumi.String("MULTI_AZ_1"),
			ThroughputCapacity: pulumi.Int(512),
			PreferredSubnetId:  pulumi.Any(test1.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Fsx.OntapFileSystem("test", new()
    {
        StorageCapacity = 1024,
        SubnetIds = new[]
        {
            test1.Id,
            test2.Id,
        },
        DeploymentType = "MULTI_AZ_1",
        ThroughputCapacity = 512,
        PreferredSubnetId = test1.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OntapFileSystem;
import com.pulumi.aws.fsx.OntapFileSystemArgs;
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) {
        var test = new OntapFileSystem("test", OntapFileSystemArgs.builder()
            .storageCapacity(1024)
            .subnetIds(            
                test1.id(),
                test2.id())
            .deploymentType("MULTI_AZ_1")
            .throughputCapacity(512)
            .preferredSubnetId(test1.id())
            .build());

    }
}
Copy
resources:
  test:
    type: aws:fsx:OntapFileSystem
    properties:
      storageCapacity: 1024
      subnetIds:
        - ${test1.id}
        - ${test2.id}
      deploymentType: MULTI_AZ_1
      throughputCapacity: 512
      preferredSubnetId: ${test1.id}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testhapairs = new aws.fsx.OntapFileSystem("testhapairs", {
    storageCapacity: 2048,
    subnetIds: [test1.id],
    deploymentType: "SINGLE_AZ_1",
    haPairs: 2,
    throughputCapacityPerHaPair: 128,
    preferredSubnetId: test1.id,
});
Copy
import pulumi
import pulumi_aws as aws

testhapairs = aws.fsx.OntapFileSystem("testhapairs",
    storage_capacity=2048,
    subnet_ids=[test1["id"]],
    deployment_type="SINGLE_AZ_1",
    ha_pairs=2,
    throughput_capacity_per_ha_pair=128,
    preferred_subnet_id=test1["id"])
Copy
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.NewOntapFileSystem(ctx, "testhapairs", &fsx.OntapFileSystemArgs{
			StorageCapacity: pulumi.Int(2048),
			SubnetIds: pulumi.StringArray{
				test1.Id,
			},
			DeploymentType:              pulumi.String("SINGLE_AZ_1"),
			HaPairs:                     pulumi.Int(2),
			ThroughputCapacityPerHaPair: pulumi.Int(128),
			PreferredSubnetId:           pulumi.Any(test1.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var testhapairs = new Aws.Fsx.OntapFileSystem("testhapairs", new()
    {
        StorageCapacity = 2048,
        SubnetIds = new[]
        {
            test1.Id,
        },
        DeploymentType = "SINGLE_AZ_1",
        HaPairs = 2,
        ThroughputCapacityPerHaPair = 128,
        PreferredSubnetId = test1.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OntapFileSystem;
import com.pulumi.aws.fsx.OntapFileSystemArgs;
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) {
        var testhapairs = new OntapFileSystem("testhapairs", OntapFileSystemArgs.builder()
            .storageCapacity(2048)
            .subnetIds(test1.id())
            .deploymentType("SINGLE_AZ_1")
            .haPairs(2)
            .throughputCapacityPerHaPair(128)
            .preferredSubnetId(test1.id())
            .build());

    }
}
Copy
resources:
  testhapairs:
    type: aws:fsx:OntapFileSystem
    properties:
      storageCapacity: 2048
      subnetIds:
        - ${test1.id}
      deploymentType: SINGLE_AZ_1
      haPairs: 2
      throughputCapacityPerHaPair: 128
      preferredSubnetId: ${test1.id}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testsingleazgen2 = new aws.fsx.OntapFileSystem("testsingleazgen2", {
    storageCapacity: 4096,
    subnetIds: [test1.id],
    deploymentType: "SINGLE_AZ_2",
    haPairs: 4,
    throughputCapacityPerHaPair: 384,
    preferredSubnetId: test1.id,
});
Copy
import pulumi
import pulumi_aws as aws

testsingleazgen2 = aws.fsx.OntapFileSystem("testsingleazgen2",
    storage_capacity=4096,
    subnet_ids=[test1["id"]],
    deployment_type="SINGLE_AZ_2",
    ha_pairs=4,
    throughput_capacity_per_ha_pair=384,
    preferred_subnet_id=test1["id"])
Copy
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.NewOntapFileSystem(ctx, "testsingleazgen2", &fsx.OntapFileSystemArgs{
			StorageCapacity: pulumi.Int(4096),
			SubnetIds: pulumi.StringArray{
				test1.Id,
			},
			DeploymentType:              pulumi.String("SINGLE_AZ_2"),
			HaPairs:                     pulumi.Int(4),
			ThroughputCapacityPerHaPair: pulumi.Int(384),
			PreferredSubnetId:           pulumi.Any(test1.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var testsingleazgen2 = new Aws.Fsx.OntapFileSystem("testsingleazgen2", new()
    {
        StorageCapacity = 4096,
        SubnetIds = new[]
        {
            test1.Id,
        },
        DeploymentType = "SINGLE_AZ_2",
        HaPairs = 4,
        ThroughputCapacityPerHaPair = 384,
        PreferredSubnetId = test1.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OntapFileSystem;
import com.pulumi.aws.fsx.OntapFileSystemArgs;
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) {
        var testsingleazgen2 = new OntapFileSystem("testsingleazgen2", OntapFileSystemArgs.builder()
            .storageCapacity(4096)
            .subnetIds(test1.id())
            .deploymentType("SINGLE_AZ_2")
            .haPairs(4)
            .throughputCapacityPerHaPair(384)
            .preferredSubnetId(test1.id())
            .build());

    }
}
Copy
resources:
  testsingleazgen2:
    type: aws:fsx:OntapFileSystem
    properties:
      storageCapacity: 4096
      subnetIds:
        - ${test1.id}
      deploymentType: SINGLE_AZ_2
      haPairs: 4
      throughputCapacityPerHaPair: 384
      preferredSubnetId: ${test1.id}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testmultiazgen2 = new aws.fsx.OntapFileSystem("testmultiazgen2", {
    storageCapacity: 1024,
    subnetIds: [
        test1.id,
        test2.id,
    ],
    deploymentType: "MULTI_AZ_2",
    haPairs: 1,
    throughputCapacityPerHaPair: 384,
    preferredSubnetId: test1.id,
});
Copy
import pulumi
import pulumi_aws as aws

testmultiazgen2 = aws.fsx.OntapFileSystem("testmultiazgen2",
    storage_capacity=1024,
    subnet_ids=[
        test1["id"],
        test2["id"],
    ],
    deployment_type="MULTI_AZ_2",
    ha_pairs=1,
    throughput_capacity_per_ha_pair=384,
    preferred_subnet_id=test1["id"])
Copy
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.NewOntapFileSystem(ctx, "testmultiazgen2", &fsx.OntapFileSystemArgs{
			StorageCapacity: pulumi.Int(1024),
			SubnetIds: pulumi.StringArray{
				test1.Id,
				test2.Id,
			},
			DeploymentType:              pulumi.String("MULTI_AZ_2"),
			HaPairs:                     pulumi.Int(1),
			ThroughputCapacityPerHaPair: pulumi.Int(384),
			PreferredSubnetId:           pulumi.Any(test1.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var testmultiazgen2 = new Aws.Fsx.OntapFileSystem("testmultiazgen2", new()
    {
        StorageCapacity = 1024,
        SubnetIds = new[]
        {
            test1.Id,
            test2.Id,
        },
        DeploymentType = "MULTI_AZ_2",
        HaPairs = 1,
        ThroughputCapacityPerHaPair = 384,
        PreferredSubnetId = test1.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.OntapFileSystem;
import com.pulumi.aws.fsx.OntapFileSystemArgs;
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) {
        var testmultiazgen2 = new OntapFileSystem("testmultiazgen2", OntapFileSystemArgs.builder()
            .storageCapacity(1024)
            .subnetIds(            
                test1.id(),
                test2.id())
            .deploymentType("MULTI_AZ_2")
            .haPairs(1)
            .throughputCapacityPerHaPair(384)
            .preferredSubnetId(test1.id())
            .build());

    }
}
Copy
resources:
  testmultiazgen2:
    type: aws:fsx:OntapFileSystem
    properties:
      storageCapacity: 1024
      subnetIds:
        - ${test1.id}
        - ${test2.id}
      deploymentType: MULTI_AZ_2
      haPairs: 1
      throughputCapacityPerHaPair: 384
      preferredSubnetId: ${test1.id}
Copy

Create OntapFileSystem Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new OntapFileSystem(name: string, args: OntapFileSystemArgs, opts?: CustomResourceOptions);
@overload
def OntapFileSystem(resource_name: str,
                    args: OntapFileSystemArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def OntapFileSystem(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    preferred_subnet_id: Optional[str] = None,
                    subnet_ids: Optional[Sequence[str]] = None,
                    deployment_type: Optional[str] = None,
                    storage_capacity: Optional[int] = None,
                    endpoint_ip_address_range: Optional[str] = None,
                    disk_iops_configuration: Optional[OntapFileSystemDiskIopsConfigurationArgs] = None,
                    ha_pairs: Optional[int] = None,
                    kms_key_id: Optional[str] = None,
                    automatic_backup_retention_days: Optional[int] = None,
                    route_table_ids: Optional[Sequence[str]] = None,
                    security_group_ids: Optional[Sequence[str]] = None,
                    fsx_admin_password: Optional[str] = None,
                    storage_type: Optional[str] = None,
                    daily_automatic_backup_start_time: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    throughput_capacity: Optional[int] = None,
                    throughput_capacity_per_ha_pair: Optional[int] = None,
                    weekly_maintenance_start_time: Optional[str] = None)
func NewOntapFileSystem(ctx *Context, name string, args OntapFileSystemArgs, opts ...ResourceOption) (*OntapFileSystem, error)
public OntapFileSystem(string name, OntapFileSystemArgs args, CustomResourceOptions? opts = null)
public OntapFileSystem(String name, OntapFileSystemArgs args)
public OntapFileSystem(String name, OntapFileSystemArgs args, CustomResourceOptions options)

type: aws:fsx:OntapFileSystem
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OntapFileSystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OntapFileSystemArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OntapFileSystemArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OntapFileSystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OntapFileSystemArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var ontapFileSystemResource = new Aws.Fsx.OntapFileSystem("ontapFileSystemResource", new()
{
    PreferredSubnetId = "string",
    SubnetIds = new[]
    {
        "string",
    },
    DeploymentType = "string",
    StorageCapacity = 0,
    EndpointIpAddressRange = "string",
    DiskIopsConfiguration = new Aws.Fsx.Inputs.OntapFileSystemDiskIopsConfigurationArgs
    {
        Iops = 0,
        Mode = "string",
    },
    HaPairs = 0,
    KmsKeyId = "string",
    AutomaticBackupRetentionDays = 0,
    RouteTableIds = new[]
    {
        "string",
    },
    SecurityGroupIds = new[]
    {
        "string",
    },
    FsxAdminPassword = "string",
    StorageType = "string",
    DailyAutomaticBackupStartTime = "string",
    Tags = 
    {
        { "string", "string" },
    },
    ThroughputCapacity = 0,
    ThroughputCapacityPerHaPair = 0,
    WeeklyMaintenanceStartTime = "string",
});
Copy
example, err := fsx.NewOntapFileSystem(ctx, "ontapFileSystemResource", &fsx.OntapFileSystemArgs{
	PreferredSubnetId: pulumi.String("string"),
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	DeploymentType:         pulumi.String("string"),
	StorageCapacity:        pulumi.Int(0),
	EndpointIpAddressRange: pulumi.String("string"),
	DiskIopsConfiguration: &fsx.OntapFileSystemDiskIopsConfigurationArgs{
		Iops: pulumi.Int(0),
		Mode: pulumi.String("string"),
	},
	HaPairs:                      pulumi.Int(0),
	KmsKeyId:                     pulumi.String("string"),
	AutomaticBackupRetentionDays: pulumi.Int(0),
	RouteTableIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	FsxAdminPassword:              pulumi.String("string"),
	StorageType:                   pulumi.String("string"),
	DailyAutomaticBackupStartTime: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ThroughputCapacity:          pulumi.Int(0),
	ThroughputCapacityPerHaPair: pulumi.Int(0),
	WeeklyMaintenanceStartTime:  pulumi.String("string"),
})
Copy
var ontapFileSystemResource = new OntapFileSystem("ontapFileSystemResource", OntapFileSystemArgs.builder()
    .preferredSubnetId("string")
    .subnetIds("string")
    .deploymentType("string")
    .storageCapacity(0)
    .endpointIpAddressRange("string")
    .diskIopsConfiguration(OntapFileSystemDiskIopsConfigurationArgs.builder()
        .iops(0)
        .mode("string")
        .build())
    .haPairs(0)
    .kmsKeyId("string")
    .automaticBackupRetentionDays(0)
    .routeTableIds("string")
    .securityGroupIds("string")
    .fsxAdminPassword("string")
    .storageType("string")
    .dailyAutomaticBackupStartTime("string")
    .tags(Map.of("string", "string"))
    .throughputCapacity(0)
    .throughputCapacityPerHaPair(0)
    .weeklyMaintenanceStartTime("string")
    .build());
Copy
ontap_file_system_resource = aws.fsx.OntapFileSystem("ontapFileSystemResource",
    preferred_subnet_id="string",
    subnet_ids=["string"],
    deployment_type="string",
    storage_capacity=0,
    endpoint_ip_address_range="string",
    disk_iops_configuration={
        "iops": 0,
        "mode": "string",
    },
    ha_pairs=0,
    kms_key_id="string",
    automatic_backup_retention_days=0,
    route_table_ids=["string"],
    security_group_ids=["string"],
    fsx_admin_password="string",
    storage_type="string",
    daily_automatic_backup_start_time="string",
    tags={
        "string": "string",
    },
    throughput_capacity=0,
    throughput_capacity_per_ha_pair=0,
    weekly_maintenance_start_time="string")
Copy
const ontapFileSystemResource = new aws.fsx.OntapFileSystem("ontapFileSystemResource", {
    preferredSubnetId: "string",
    subnetIds: ["string"],
    deploymentType: "string",
    storageCapacity: 0,
    endpointIpAddressRange: "string",
    diskIopsConfiguration: {
        iops: 0,
        mode: "string",
    },
    haPairs: 0,
    kmsKeyId: "string",
    automaticBackupRetentionDays: 0,
    routeTableIds: ["string"],
    securityGroupIds: ["string"],
    fsxAdminPassword: "string",
    storageType: "string",
    dailyAutomaticBackupStartTime: "string",
    tags: {
        string: "string",
    },
    throughputCapacity: 0,
    throughputCapacityPerHaPair: 0,
    weeklyMaintenanceStartTime: "string",
});
Copy
type: aws:fsx:OntapFileSystem
properties:
    automaticBackupRetentionDays: 0
    dailyAutomaticBackupStartTime: string
    deploymentType: string
    diskIopsConfiguration:
        iops: 0
        mode: string
    endpointIpAddressRange: string
    fsxAdminPassword: string
    haPairs: 0
    kmsKeyId: string
    preferredSubnetId: string
    routeTableIds:
        - string
    securityGroupIds:
        - string
    storageCapacity: 0
    storageType: string
    subnetIds:
        - string
    tags:
        string: string
    throughputCapacity: 0
    throughputCapacityPerHaPair: 0
    weeklyMaintenanceStartTime: string
Copy

OntapFileSystem Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The OntapFileSystem resource accepts the following input properties:

DeploymentType
This property is required.
Changes to this property will trigger replacement.
string
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
PreferredSubnetId
This property is required.
Changes to this property will trigger replacement.
string
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
StorageCapacity This property is required. int
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
SubnetIds
This property is required.
Changes to this property will trigger replacement.
List<string>
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
AutomaticBackupRetentionDays int
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
DailyAutomaticBackupStartTime string
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
DiskIopsConfiguration OntapFileSystemDiskIopsConfiguration
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
EndpointIpAddressRange Changes to this property will trigger replacement. string
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
FsxAdminPassword string
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
HaPairs int
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
KmsKeyId Changes to this property will trigger replacement. string
ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.
RouteTableIds List<string>
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
SecurityGroupIds Changes to this property will trigger replacement. 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.
StorageType Changes to this property will trigger replacement. string
The filesystem storage type. defaults to SSD.
Tags Dictionary<string, string>
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
ThroughputCapacity int
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
ThroughputCapacityPerHaPair int
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
WeeklyMaintenanceStartTime string
The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
DeploymentType
This property is required.
Changes to this property will trigger replacement.
string
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
PreferredSubnetId
This property is required.
Changes to this property will trigger replacement.
string
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
StorageCapacity This property is required. int
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
SubnetIds
This property is required.
Changes to this property will trigger replacement.
[]string
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
AutomaticBackupRetentionDays int
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
DailyAutomaticBackupStartTime string
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
DiskIopsConfiguration OntapFileSystemDiskIopsConfigurationArgs
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
EndpointIpAddressRange Changes to this property will trigger replacement. string
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
FsxAdminPassword string
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
HaPairs int
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
KmsKeyId Changes to this property will trigger replacement. string
ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.
RouteTableIds []string
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
SecurityGroupIds Changes to this property will trigger replacement. []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.
StorageType Changes to this property will trigger replacement. string
The filesystem storage type. defaults to SSD.
Tags map[string]string
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
ThroughputCapacity int
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
ThroughputCapacityPerHaPair int
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
WeeklyMaintenanceStartTime string
The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
deploymentType
This property is required.
Changes to this property will trigger replacement.
String
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
preferredSubnetId
This property is required.
Changes to this property will trigger replacement.
String
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
storageCapacity This property is required. Integer
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
subnetIds
This property is required.
Changes to this property will trigger replacement.
List<String>
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
automaticBackupRetentionDays Integer
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
dailyAutomaticBackupStartTime String
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
diskIopsConfiguration OntapFileSystemDiskIopsConfiguration
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
endpointIpAddressRange Changes to this property will trigger replacement. String
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
fsxAdminPassword String
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
haPairs Integer
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
kmsKeyId Changes to this property will trigger replacement. String
ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.
routeTableIds List<String>
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
securityGroupIds Changes to this property will trigger replacement. 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.
storageType Changes to this property will trigger replacement. String
The filesystem storage type. defaults to SSD.
tags Map<String,String>
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
throughputCapacity Integer
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
throughputCapacityPerHaPair Integer
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
weeklyMaintenanceStartTime String
The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
deploymentType
This property is required.
Changes to this property will trigger replacement.
string
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
preferredSubnetId
This property is required.
Changes to this property will trigger replacement.
string
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
storageCapacity This property is required. number
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
subnetIds
This property is required.
Changes to this property will trigger replacement.
string[]
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
automaticBackupRetentionDays number
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
dailyAutomaticBackupStartTime string
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
diskIopsConfiguration OntapFileSystemDiskIopsConfiguration
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
endpointIpAddressRange Changes to this property will trigger replacement. string
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
fsxAdminPassword string
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
haPairs number
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
kmsKeyId Changes to this property will trigger replacement. string
ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.
routeTableIds string[]
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
securityGroupIds Changes to this property will trigger replacement. 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.
storageType Changes to this property will trigger replacement. string
The filesystem storage type. defaults to SSD.
tags {[key: string]: string}
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
throughputCapacity number
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
throughputCapacityPerHaPair number
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
weeklyMaintenanceStartTime string
The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
deployment_type
This property is required.
Changes to this property will trigger replacement.
str
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
preferred_subnet_id
This property is required.
Changes to this property will trigger replacement.
str
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
storage_capacity This property is required. int
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
subnet_ids
This property is required.
Changes to this property will trigger replacement.
Sequence[str]
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
automatic_backup_retention_days int
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
daily_automatic_backup_start_time str
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
disk_iops_configuration OntapFileSystemDiskIopsConfigurationArgs
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
endpoint_ip_address_range Changes to this property will trigger replacement. str
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
fsx_admin_password str
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
ha_pairs int
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
kms_key_id Changes to this property will trigger replacement. str
ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.
route_table_ids Sequence[str]
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
security_group_ids Changes to this property will trigger replacement. Sequence[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.
storage_type Changes to this property will trigger replacement. str
The filesystem storage type. defaults to SSD.
tags Mapping[str, str]
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
throughput_capacity int
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
throughput_capacity_per_ha_pair int
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
weekly_maintenance_start_time str
The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
deploymentType
This property is required.
Changes to this property will trigger replacement.
String
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
preferredSubnetId
This property is required.
Changes to this property will trigger replacement.
String
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
storageCapacity This property is required. Number
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
subnetIds
This property is required.
Changes to this property will trigger replacement.
List<String>
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
automaticBackupRetentionDays Number
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
dailyAutomaticBackupStartTime String
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
diskIopsConfiguration Property Map
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
endpointIpAddressRange Changes to this property will trigger replacement. String
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
fsxAdminPassword String
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
haPairs Number
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
kmsKeyId Changes to this property will trigger replacement. String
ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.
routeTableIds List<String>
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
securityGroupIds Changes to this property will trigger replacement. 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.
storageType Changes to this property will trigger replacement. String
The filesystem storage type. defaults to SSD.
tags Map<String>
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
throughputCapacity Number
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
throughputCapacityPerHaPair Number
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
weeklyMaintenanceStartTime String
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 OntapFileSystem resource produces the following output properties:

Arn string
Amazon Resource Name of the file system.
DnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
Endpoints List<OntapFileSystemEndpoint>
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
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 The first network interface returned is the primary network interface.
OwnerId string
AWS account identifier that created the file system.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
Identifier of the Virtual Private Cloud for the file system.
Arn string
Amazon Resource Name of the file system.
DnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
Endpoints []OntapFileSystemEndpoint
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
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 The first network interface returned is the primary network interface.
OwnerId string
AWS account identifier that created the file system.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
Identifier of the Virtual Private Cloud for the file system.
arn String
Amazon Resource Name of the file system.
dnsName String
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
endpoints List<OntapFileSystemEndpoint>
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
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 The first network interface returned is the primary network interface.
ownerId String
AWS account identifier that created the file system.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
Identifier of the Virtual Private Cloud for the file system.
arn string
Amazon Resource Name of the file system.
dnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
endpoints OntapFileSystemEndpoint[]
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
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 The first network interface returned is the primary network interface.
ownerId string
AWS account identifier that created the file system.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId string
Identifier of the Virtual Private Cloud for the file system.
arn str
Amazon Resource Name of the file system.
dns_name str
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
endpoints Sequence[OntapFileSystemEndpoint]
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
id str
The provider-assigned unique ID for this managed resource.
network_interface_ids Sequence[str]
Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.
owner_id str
AWS account identifier that created the file system.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpc_id str
Identifier of the Virtual Private Cloud for the file system.
arn String
Amazon Resource Name of the file system.
dnsName String
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
endpoints List<Property Map>
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
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 The first network interface returned is the primary network interface.
ownerId String
AWS account identifier that created the file system.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
Identifier of the Virtual Private Cloud for the file system.

Look up Existing OntapFileSystem Resource

Get an existing OntapFileSystem 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?: OntapFileSystemState, opts?: CustomResourceOptions): OntapFileSystem
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        automatic_backup_retention_days: Optional[int] = None,
        daily_automatic_backup_start_time: Optional[str] = None,
        deployment_type: Optional[str] = None,
        disk_iops_configuration: Optional[OntapFileSystemDiskIopsConfigurationArgs] = None,
        dns_name: Optional[str] = None,
        endpoint_ip_address_range: Optional[str] = None,
        endpoints: Optional[Sequence[OntapFileSystemEndpointArgs]] = None,
        fsx_admin_password: Optional[str] = None,
        ha_pairs: Optional[int] = None,
        kms_key_id: Optional[str] = None,
        network_interface_ids: Optional[Sequence[str]] = None,
        owner_id: Optional[str] = None,
        preferred_subnet_id: Optional[str] = None,
        route_table_ids: Optional[Sequence[str]] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        storage_capacity: Optional[int] = None,
        storage_type: Optional[str] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        throughput_capacity: Optional[int] = None,
        throughput_capacity_per_ha_pair: Optional[int] = None,
        vpc_id: Optional[str] = None,
        weekly_maintenance_start_time: Optional[str] = None) -> OntapFileSystem
func GetOntapFileSystem(ctx *Context, name string, id IDInput, state *OntapFileSystemState, opts ...ResourceOption) (*OntapFileSystem, error)
public static OntapFileSystem Get(string name, Input<string> id, OntapFileSystemState? state, CustomResourceOptions? opts = null)
public static OntapFileSystem get(String name, Output<String> id, OntapFileSystemState state, CustomResourceOptions options)
resources:  _:    type: aws:fsx:OntapFileSystem    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Arn string
Amazon Resource Name of the file system.
AutomaticBackupRetentionDays int
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
DailyAutomaticBackupStartTime string
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
DeploymentType Changes to this property will trigger replacement. string
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
DiskIopsConfiguration OntapFileSystemDiskIopsConfiguration
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
DnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
EndpointIpAddressRange Changes to this property will trigger replacement. string
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
Endpoints List<OntapFileSystemEndpoint>
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
FsxAdminPassword string
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
HaPairs int
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
KmsKeyId Changes to this property will trigger replacement. 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 The first network interface returned is the primary network interface.
OwnerId string
AWS account identifier that created the file system.
PreferredSubnetId Changes to this property will trigger replacement. string
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
RouteTableIds List<string>
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
SecurityGroupIds Changes to this property will trigger replacement. 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.
StorageCapacity int
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
StorageType Changes to this property will trigger replacement. string
The filesystem storage type. defaults to SSD.
SubnetIds Changes to this property will trigger replacement. List<string>
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
Tags Dictionary<string, string>
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

ThroughputCapacity int
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
ThroughputCapacityPerHaPair int
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
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.
Arn string
Amazon Resource Name of the file system.
AutomaticBackupRetentionDays int
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
DailyAutomaticBackupStartTime string
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
DeploymentType Changes to this property will trigger replacement. string
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
DiskIopsConfiguration OntapFileSystemDiskIopsConfigurationArgs
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
DnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
EndpointIpAddressRange Changes to this property will trigger replacement. string
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
Endpoints []OntapFileSystemEndpointArgs
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
FsxAdminPassword string
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
HaPairs int
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
KmsKeyId Changes to this property will trigger replacement. 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 The first network interface returned is the primary network interface.
OwnerId string
AWS account identifier that created the file system.
PreferredSubnetId Changes to this property will trigger replacement. string
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
RouteTableIds []string
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
SecurityGroupIds Changes to this property will trigger replacement. []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.
StorageCapacity int
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
StorageType Changes to this property will trigger replacement. string
The filesystem storage type. defaults to SSD.
SubnetIds Changes to this property will trigger replacement. []string
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
Tags map[string]string
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

ThroughputCapacity int
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
ThroughputCapacityPerHaPair int
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
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.
arn String
Amazon Resource Name of the file system.
automaticBackupRetentionDays Integer
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
dailyAutomaticBackupStartTime String
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
deploymentType Changes to this property will trigger replacement. String
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
diskIopsConfiguration OntapFileSystemDiskIopsConfiguration
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
dnsName String
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
endpointIpAddressRange Changes to this property will trigger replacement. String
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
endpoints List<OntapFileSystemEndpoint>
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
fsxAdminPassword String
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
haPairs Integer
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
kmsKeyId Changes to this property will trigger replacement. 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 The first network interface returned is the primary network interface.
ownerId String
AWS account identifier that created the file system.
preferredSubnetId Changes to this property will trigger replacement. String
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
routeTableIds List<String>
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
securityGroupIds Changes to this property will trigger replacement. 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.
storageCapacity Integer
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
storageType Changes to this property will trigger replacement. String
The filesystem storage type. defaults to SSD.
subnetIds Changes to this property will trigger replacement. List<String>
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
tags Map<String,String>
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

throughputCapacity Integer
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
throughputCapacityPerHaPair Integer
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
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.
arn string
Amazon Resource Name of the file system.
automaticBackupRetentionDays number
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
dailyAutomaticBackupStartTime string
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
deploymentType Changes to this property will trigger replacement. string
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
diskIopsConfiguration OntapFileSystemDiskIopsConfiguration
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
dnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
endpointIpAddressRange Changes to this property will trigger replacement. string
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
endpoints OntapFileSystemEndpoint[]
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
fsxAdminPassword string
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
haPairs number
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
kmsKeyId Changes to this property will trigger replacement. 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 The first network interface returned is the primary network interface.
ownerId string
AWS account identifier that created the file system.
preferredSubnetId Changes to this property will trigger replacement. string
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
routeTableIds string[]
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
securityGroupIds Changes to this property will trigger replacement. 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.
storageCapacity number
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
storageType Changes to this property will trigger replacement. string
The filesystem storage type. defaults to SSD.
subnetIds Changes to this property will trigger replacement. string[]
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
tags {[key: string]: string}
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

throughputCapacity number
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
throughputCapacityPerHaPair number
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
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.
arn str
Amazon Resource Name of the file system.
automatic_backup_retention_days int
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
daily_automatic_backup_start_time str
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
deployment_type Changes to this property will trigger replacement. str
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
disk_iops_configuration OntapFileSystemDiskIopsConfigurationArgs
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
dns_name str
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
endpoint_ip_address_range Changes to this property will trigger replacement. str
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
endpoints Sequence[OntapFileSystemEndpointArgs]
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
fsx_admin_password str
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
ha_pairs int
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
kms_key_id Changes to this property will trigger replacement. str
ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.
network_interface_ids Sequence[str]
Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.
owner_id str
AWS account identifier that created the file system.
preferred_subnet_id Changes to this property will trigger replacement. str
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
route_table_ids Sequence[str]
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
security_group_ids Changes to this property will trigger replacement. Sequence[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.
storage_capacity int
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
storage_type Changes to this property will trigger replacement. str
The filesystem storage type. defaults to SSD.
subnet_ids Changes to this property will trigger replacement. Sequence[str]
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
tags Mapping[str, str]
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

throughput_capacity int
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
throughput_capacity_per_ha_pair int
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
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.
arn String
Amazon Resource Name of the file system.
automaticBackupRetentionDays Number
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
dailyAutomaticBackupStartTime String
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily. Requires automatic_backup_retention_days to be set.
deploymentType Changes to this property will trigger replacement. String
The filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
diskIopsConfiguration Property Map
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.
dnsName String
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
endpointIpAddressRange Changes to this property will trigger replacement. String
Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
endpoints List<Property Map>
The endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See Endpoints below.
fsxAdminPassword String
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
haPairs Number
The number of ha_pairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
kmsKeyId Changes to this property will trigger replacement. 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 The first network interface returned is the primary network interface.
ownerId String
AWS account identifier that created the file system.
preferredSubnetId Changes to this property will trigger replacement. String
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).
routeTableIds List<String>
Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
securityGroupIds Changes to this property will trigger replacement. 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.
storageCapacity Number
The storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deployment_type SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deployment_type SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
storageType Changes to this property will trigger replacement. String
The filesystem storage type. defaults to SSD.
subnetIds Changes to this property will trigger replacement. List<String>
A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
tags Map<String>
A map of tags to assign to the file system. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

throughputCapacity Number
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
throughputCapacityPerHaPair Number
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughput_capacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where ha_pairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where ha_pairs is greater than 1. This parameter is only supported when specifying the ha_pairs parameter. Either throughput_capacity or throughput_capacity_per_ha_pair must be specified.
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.

Supporting Types

OntapFileSystemDiskIopsConfiguration
, OntapFileSystemDiskIopsConfigurationArgs

Iops int
The total number of SSD IOPS provisioned for the file system.
Mode string
Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.
Iops int
The total number of SSD IOPS provisioned for the file system.
Mode string
Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.
iops Integer
The total number of SSD IOPS provisioned for the file system.
mode String
Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.
iops number
The total number of SSD IOPS provisioned for the file system.
mode string
Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.
iops int
The total number of SSD IOPS provisioned for the file system.
mode str
Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.
iops Number
The total number of SSD IOPS provisioned for the file system.
mode String
Specifies whether the number of IOPS for the file system is using the system. Valid values are AUTOMATIC and USER_PROVISIONED. Default value is AUTOMATIC.

OntapFileSystemEndpoint
, OntapFileSystemEndpointArgs

Interclusters List<OntapFileSystemEndpointIntercluster>
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See Endpoint.
Managements List<OntapFileSystemEndpointManagement>
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.
Interclusters []OntapFileSystemEndpointIntercluster
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See Endpoint.
Managements []OntapFileSystemEndpointManagement
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.
interclusters List<OntapFileSystemEndpointIntercluster>
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See Endpoint.
managements List<OntapFileSystemEndpointManagement>
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.
interclusters OntapFileSystemEndpointIntercluster[]
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See Endpoint.
managements OntapFileSystemEndpointManagement[]
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.
interclusters Sequence[OntapFileSystemEndpointIntercluster]
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See Endpoint.
managements Sequence[OntapFileSystemEndpointManagement]
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.
interclusters List<Property Map>
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See Endpoint.
managements List<Property Map>
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See Endpoint.

OntapFileSystemEndpointIntercluster
, OntapFileSystemEndpointInterclusterArgs

DnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses List<string>
IP addresses of the file system endpoint.
DnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses []string
IP addresses of the file system endpoint.
dnsName String
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
ipAddresses List<String>
IP addresses of the file system endpoint.
dnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
ipAddresses string[]
IP addresses of the file system endpoint.
dns_name str
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
ip_addresses Sequence[str]
IP addresses of the file system endpoint.
dnsName String
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
ipAddresses List<String>
IP addresses of the file system endpoint.

OntapFileSystemEndpointManagement
, OntapFileSystemEndpointManagementArgs

DnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses List<string>
IP addresses of the file system endpoint.
DnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses []string
IP addresses of the file system endpoint.
dnsName String
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
ipAddresses List<String>
IP addresses of the file system endpoint.
dnsName string
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
ipAddresses string[]
IP addresses of the file system endpoint.
dns_name str
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
ip_addresses Sequence[str]
IP addresses of the file system endpoint.
dnsName String
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
ipAddresses List<String>
IP addresses of the file system endpoint.

Import

Using pulumi import, import FSx File Systems using the id. For example:

$ pulumi import aws:fsx/ontapFileSystem:OntapFileSystem example fs-543ab12b1ca672f33
Copy

Certain resource arguments, like security_group_ids, do not have a FSx API method for reading the information after creation. If the argument is set in the Pulumi program on an imported resource, Pulumi will always show a difference. To workaround this behavior, either omit the argument from the Pulumi program or use ignore_changes to hide the difference. For example:

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws