AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
aws.fsx.getOntapFileSystem
Explore with Pulumi AI
Retrieve information on FSx ONTAP File System.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.fsx.getOntapFileSystem({
    id: "fs-12345678",
});
import pulumi
import pulumi_aws as aws
example = aws.fsx.get_ontap_file_system(id="fs-12345678")
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.LookupOntapFileSystem(ctx, &fsx.LookupOntapFileSystemArgs{
			Id: "fs-12345678",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var example = Aws.Fsx.GetOntapFileSystem.Invoke(new()
    {
        Id = "fs-12345678",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.FsxFunctions;
import com.pulumi.aws.fsx.inputs.GetOntapFileSystemArgs;
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) {
        final var example = FsxFunctions.getOntapFileSystem(GetOntapFileSystemArgs.builder()
            .id("fs-12345678")
            .build());
    }
}
variables:
  example:
    fn::invoke:
      function: aws:fsx:getOntapFileSystem
      arguments:
        id: fs-12345678
Using getOntapFileSystem
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getOntapFileSystem(args: GetOntapFileSystemArgs, opts?: InvokeOptions): Promise<GetOntapFileSystemResult>
function getOntapFileSystemOutput(args: GetOntapFileSystemOutputArgs, opts?: InvokeOptions): Output<GetOntapFileSystemResult>def get_ontap_file_system(id: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetOntapFileSystemResult
def get_ontap_file_system_output(id: Optional[pulumi.Input[str]] = None,
                          tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetOntapFileSystemResult]func LookupOntapFileSystem(ctx *Context, args *LookupOntapFileSystemArgs, opts ...InvokeOption) (*LookupOntapFileSystemResult, error)
func LookupOntapFileSystemOutput(ctx *Context, args *LookupOntapFileSystemOutputArgs, opts ...InvokeOption) LookupOntapFileSystemResultOutput> Note: This function is named LookupOntapFileSystem in the Go SDK.
public static class GetOntapFileSystem 
{
    public static Task<GetOntapFileSystemResult> InvokeAsync(GetOntapFileSystemArgs args, InvokeOptions? opts = null)
    public static Output<GetOntapFileSystemResult> Invoke(GetOntapFileSystemInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetOntapFileSystemResult> getOntapFileSystem(GetOntapFileSystemArgs args, InvokeOptions options)
public static Output<GetOntapFileSystemResult> getOntapFileSystem(GetOntapFileSystemArgs args, InvokeOptions options)
fn::invoke:
  function: aws:fsx/getOntapFileSystem:getOntapFileSystem
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Id string
- Identifier of the file system (e.g. fs-12345678).
- Dictionary<string, string>
- The tags associated with the file system.
- Id string
- Identifier of the file system (e.g. fs-12345678).
- map[string]string
- The tags associated with the file system.
- id String
- Identifier of the file system (e.g. fs-12345678).
- Map<String,String>
- The tags associated with the file system.
- id string
- Identifier of the file system (e.g. fs-12345678).
- {[key: string]: string}
- The tags associated with the file system.
- id str
- Identifier of the file system (e.g. fs-12345678).
- Mapping[str, str]
- The tags associated with the file system.
- id String
- Identifier of the file system (e.g. fs-12345678).
- Map<String>
- The tags associated with the file system.
getOntapFileSystem Result
The following output properties are available:
- Arn string
- Amazon Resource Name of the file system.
- AutomaticBackup intRetention Days 
- The number of days to retain automatic backups.
- DailyAutomatic stringBackup Start Time 
- The preferred time (in HH:MMformat) to take daily automatic backups, in the UTC time zone.
- DeploymentType string
- The file system deployment type.
- DiskIops List<GetConfigurations Ontap File System Disk Iops Configuration> 
- The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system, specifying the number of provisioned IOPS and the provision mode. See Disk IOPS Below.
- DnsName string
- DNS name for the file system.
- EndpointIp stringAddress Range 
- (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist.
- Endpoints
List<GetOntap File System Endpoint> 
- The Management and Intercluster FileSystemEndpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See FileSystemEndpoints below.
- HaPairs int
- The number of HA pairs for the file system.
- Id string
- Identifier of the file system (e.g. fs-12345678).
- KmsKey stringId 
- ARN for the KMS Key to encrypt the file system at rest.
- NetworkInterface List<string>Ids 
- The IDs of the elastic network interfaces from which a specific file system is accessible.
- OwnerId string
- AWS account identifier that created the file system.
- PreferredSubnet stringId 
- Specifies the subnet in which you want the preferred file server to be located.
- RouteTable List<string>Ids 
- (Multi-AZ only) The VPC route tables in which your file system's endpoints exist.
- StorageCapacity int
- The storage capacity of the file system in gibibytes (GiB).
- StorageType string
- The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set toHDD, the file system uses hard disk drive storage.
- SubnetIds List<string>
- Specifies the IDs of the subnets that the file system is accessible from. For the MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the preferred_subnet_idproperty.
- Dictionary<string, string>
- The tags associated with the file system.
- ThroughputCapacity int
- The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). If the file system uses multiple HA pairs this will equal throuthput_capacity_per_ha_pair x ha_pairs
- ThroughputCapacity intPer Ha Pair 
- The sustained throughput of each HA pair for an Amazon FSx file system in Megabytes per second (MBps).
- VpcId string
- The ID of the primary virtual private cloud (VPC) for the file system.
- WeeklyMaintenance stringStart Time 
- The preferred start time (in D:HH:MMformat) to perform weekly maintenance, in the UTC time zone.
- Arn string
- Amazon Resource Name of the file system.
- AutomaticBackup intRetention Days 
- The number of days to retain automatic backups.
- DailyAutomatic stringBackup Start Time 
- The preferred time (in HH:MMformat) to take daily automatic backups, in the UTC time zone.
- DeploymentType string
- The file system deployment type.
- DiskIops []GetConfigurations Ontap File System Disk Iops Configuration 
- The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system, specifying the number of provisioned IOPS and the provision mode. See Disk IOPS Below.
- DnsName string
- DNS name for the file system.
- EndpointIp stringAddress Range 
- (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist.
- Endpoints
[]GetOntap File System Endpoint 
- The Management and Intercluster FileSystemEndpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See FileSystemEndpoints below.
- HaPairs int
- The number of HA pairs for the file system.
- Id string
- Identifier of the file system (e.g. fs-12345678).
- KmsKey stringId 
- ARN for the KMS Key to encrypt the file system at rest.
- NetworkInterface []stringIds 
- The IDs of the elastic network interfaces from which a specific file system is accessible.
- OwnerId string
- AWS account identifier that created the file system.
- PreferredSubnet stringId 
- Specifies the subnet in which you want the preferred file server to be located.
- RouteTable []stringIds 
- (Multi-AZ only) The VPC route tables in which your file system's endpoints exist.
- StorageCapacity int
- The storage capacity of the file system in gibibytes (GiB).
- StorageType string
- The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set toHDD, the file system uses hard disk drive storage.
- SubnetIds []string
- Specifies the IDs of the subnets that the file system is accessible from. For the MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the preferred_subnet_idproperty.
- map[string]string
- The tags associated with the file system.
- ThroughputCapacity int
- The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). If the file system uses multiple HA pairs this will equal throuthput_capacity_per_ha_pair x ha_pairs
- ThroughputCapacity intPer Ha Pair 
- The sustained throughput of each HA pair for an Amazon FSx file system in Megabytes per second (MBps).
- VpcId string
- The ID of the primary virtual private cloud (VPC) for the file system.
- WeeklyMaintenance stringStart Time 
- The preferred start time (in D:HH:MMformat) to perform weekly maintenance, in the UTC time zone.
- arn String
- Amazon Resource Name of the file system.
- automaticBackup IntegerRetention Days 
- The number of days to retain automatic backups.
- dailyAutomatic StringBackup Start Time 
- The preferred time (in HH:MMformat) to take daily automatic backups, in the UTC time zone.
- deploymentType String
- The file system deployment type.
- diskIops List<GetConfigurations Ontap File System Disk Iops Configuration> 
- The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system, specifying the number of provisioned IOPS and the provision mode. See Disk IOPS Below.
- dnsName String
- DNS name for the file system.
- endpointIp StringAddress Range 
- (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist.
- endpoints
List<GetOntap File System Endpoint> 
- The Management and Intercluster FileSystemEndpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See FileSystemEndpoints below.
- haPairs Integer
- The number of HA pairs for the file system.
- id String
- Identifier of the file system (e.g. fs-12345678).
- kmsKey StringId 
- ARN for the KMS Key to encrypt the file system at rest.
- networkInterface List<String>Ids 
- The IDs of the elastic network interfaces from which a specific file system is accessible.
- ownerId String
- AWS account identifier that created the file system.
- preferredSubnet StringId 
- Specifies the subnet in which you want the preferred file server to be located.
- routeTable List<String>Ids 
- (Multi-AZ only) The VPC route tables in which your file system's endpoints exist.
- storageCapacity Integer
- The storage capacity of the file system in gibibytes (GiB).
- storageType String
- The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set toHDD, the file system uses hard disk drive storage.
- subnetIds List<String>
- Specifies the IDs of the subnets that the file system is accessible from. For the MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the preferred_subnet_idproperty.
- Map<String,String>
- The tags associated with the file system.
- throughputCapacity Integer
- The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). If the file system uses multiple HA pairs this will equal throuthput_capacity_per_ha_pair x ha_pairs
- throughputCapacity IntegerPer Ha Pair 
- The sustained throughput of each HA pair for an Amazon FSx file system in Megabytes per second (MBps).
- vpcId String
- The ID of the primary virtual private cloud (VPC) for the file system.
- weeklyMaintenance StringStart Time 
- The preferred start time (in D:HH:MMformat) to perform weekly maintenance, in the UTC time zone.
- arn string
- Amazon Resource Name of the file system.
- automaticBackup numberRetention Days 
- The number of days to retain automatic backups.
- dailyAutomatic stringBackup Start Time 
- The preferred time (in HH:MMformat) to take daily automatic backups, in the UTC time zone.
- deploymentType string
- The file system deployment type.
- diskIops GetConfigurations Ontap File System Disk Iops Configuration[] 
- The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system, specifying the number of provisioned IOPS and the provision mode. See Disk IOPS Below.
- dnsName string
- DNS name for the file system.
- endpointIp stringAddress Range 
- (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist.
- endpoints
GetOntap File System Endpoint[] 
- The Management and Intercluster FileSystemEndpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See FileSystemEndpoints below.
- haPairs number
- The number of HA pairs for the file system.
- id string
- Identifier of the file system (e.g. fs-12345678).
- kmsKey stringId 
- ARN for the KMS Key to encrypt the file system at rest.
- networkInterface string[]Ids 
- The IDs of the elastic network interfaces from which a specific file system is accessible.
- ownerId string
- AWS account identifier that created the file system.
- preferredSubnet stringId 
- Specifies the subnet in which you want the preferred file server to be located.
- routeTable string[]Ids 
- (Multi-AZ only) The VPC route tables in which your file system's endpoints exist.
- storageCapacity number
- The storage capacity of the file system in gibibytes (GiB).
- storageType string
- The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set toHDD, the file system uses hard disk drive storage.
- subnetIds string[]
- Specifies the IDs of the subnets that the file system is accessible from. For the MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the preferred_subnet_idproperty.
- {[key: string]: string}
- The tags associated with the file system.
- throughputCapacity number
- The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). If the file system uses multiple HA pairs this will equal throuthput_capacity_per_ha_pair x ha_pairs
- throughputCapacity numberPer Ha Pair 
- The sustained throughput of each HA pair for an Amazon FSx file system in Megabytes per second (MBps).
- vpcId string
- The ID of the primary virtual private cloud (VPC) for the file system.
- weeklyMaintenance stringStart Time 
- The preferred start time (in D:HH:MMformat) to perform weekly maintenance, in the UTC time zone.
- arn str
- Amazon Resource Name of the file system.
- automatic_backup_ intretention_ days 
- The number of days to retain automatic backups.
- daily_automatic_ strbackup_ start_ time 
- The preferred time (in HH:MMformat) to take daily automatic backups, in the UTC time zone.
- deployment_type str
- The file system deployment type.
- disk_iops_ Sequence[Getconfigurations Ontap File System Disk Iops Configuration] 
- The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system, specifying the number of provisioned IOPS and the provision mode. See Disk IOPS Below.
- dns_name str
- DNS name for the file system.
- endpoint_ip_ straddress_ range 
- (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist.
- endpoints
Sequence[GetOntap File System Endpoint] 
- The Management and Intercluster FileSystemEndpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See FileSystemEndpoints below.
- ha_pairs int
- The number of HA pairs for the file system.
- id str
- Identifier of the file system (e.g. fs-12345678).
- kms_key_ strid 
- ARN for the KMS Key to encrypt the file system at rest.
- network_interface_ Sequence[str]ids 
- The IDs of the elastic network interfaces from which a specific file system is accessible.
- owner_id str
- AWS account identifier that created the file system.
- preferred_subnet_ strid 
- Specifies the subnet in which you want the preferred file server to be located.
- route_table_ Sequence[str]ids 
- (Multi-AZ only) The VPC route tables in which your file system's endpoints exist.
- storage_capacity int
- The storage capacity of the file system in gibibytes (GiB).
- storage_type str
- The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set toHDD, the file system uses hard disk drive storage.
- subnet_ids Sequence[str]
- Specifies the IDs of the subnets that the file system is accessible from. For the MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the preferred_subnet_idproperty.
- Mapping[str, str]
- The tags associated with the file system.
- throughput_capacity int
- The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). If the file system uses multiple HA pairs this will equal throuthput_capacity_per_ha_pair x ha_pairs
- throughput_capacity_ intper_ ha_ pair 
- The sustained throughput of each HA pair for an Amazon FSx file system in Megabytes per second (MBps).
- vpc_id str
- The ID of the primary virtual private cloud (VPC) for the file system.
- weekly_maintenance_ strstart_ time 
- The preferred start time (in D:HH:MMformat) to perform weekly maintenance, in the UTC time zone.
- arn String
- Amazon Resource Name of the file system.
- automaticBackup NumberRetention Days 
- The number of days to retain automatic backups.
- dailyAutomatic StringBackup Start Time 
- The preferred time (in HH:MMformat) to take daily automatic backups, in the UTC time zone.
- deploymentType String
- The file system deployment type.
- diskIops List<Property Map>Configurations 
- The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system, specifying the number of provisioned IOPS and the provision mode. See Disk IOPS Below.
- dnsName String
- DNS name for the file system.
- endpointIp StringAddress Range 
- (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist.
- endpoints List<Property Map>
- The Management and Intercluster FileSystemEndpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See FileSystemEndpoints below.
- haPairs Number
- The number of HA pairs for the file system.
- id String
- Identifier of the file system (e.g. fs-12345678).
- kmsKey StringId 
- ARN for the KMS Key to encrypt the file system at rest.
- networkInterface List<String>Ids 
- The IDs of the elastic network interfaces from which a specific file system is accessible.
- ownerId String
- AWS account identifier that created the file system.
- preferredSubnet StringId 
- Specifies the subnet in which you want the preferred file server to be located.
- routeTable List<String>Ids 
- (Multi-AZ only) The VPC route tables in which your file system's endpoints exist.
- storageCapacity Number
- The storage capacity of the file system in gibibytes (GiB).
- storageType String
- The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set toHDD, the file system uses hard disk drive storage.
- subnetIds List<String>
- Specifies the IDs of the subnets that the file system is accessible from. For the MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the preferred_subnet_idproperty.
- Map<String>
- The tags associated with the file system.
- throughputCapacity Number
- The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps). If the file system uses multiple HA pairs this will equal throuthput_capacity_per_ha_pair x ha_pairs
- throughputCapacity NumberPer Ha Pair 
- The sustained throughput of each HA pair for an Amazon FSx file system in Megabytes per second (MBps).
- vpcId String
- The ID of the primary virtual private cloud (VPC) for the file system.
- weeklyMaintenance StringStart Time 
- The preferred start time (in D:HH:MMformat) to perform weekly maintenance, in the UTC time zone.
Supporting Types
GetOntapFileSystemDiskIopsConfiguration      
GetOntapFileSystemEndpoint    
- Interclusters
List<GetOntap File System Endpoint Intercluster> 
- A FileSystemEndpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See FileSystemEndpoint below.
- Managements
List<GetOntap File System Endpoint Management> 
- A FileSystemEndpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See FileSystemEndpoint below.
- Interclusters
[]GetOntap File System Endpoint Intercluster 
- A FileSystemEndpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See FileSystemEndpoint below.
- Managements
[]GetOntap File System Endpoint Management 
- A FileSystemEndpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See FileSystemEndpoint below.
- interclusters
List<GetOntap File System Endpoint Intercluster> 
- A FileSystemEndpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See FileSystemEndpoint below.
- managements
List<GetOntap File System Endpoint Management> 
- A FileSystemEndpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See FileSystemEndpoint below.
- interclusters
GetOntap File System Endpoint Intercluster[] 
- A FileSystemEndpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See FileSystemEndpoint below.
- managements
GetOntap File System Endpoint Management[] 
- A FileSystemEndpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See FileSystemEndpoint below.
- interclusters
Sequence[GetOntap File System Endpoint Intercluster] 
- A FileSystemEndpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See FileSystemEndpoint below.
- managements
Sequence[GetOntap File System Endpoint Management] 
- A FileSystemEndpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See FileSystemEndpoint below.
- interclusters List<Property Map>
- A FileSystemEndpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See FileSystemEndpoint below.
- managements List<Property Map>
- A FileSystemEndpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See FileSystemEndpoint below.
GetOntapFileSystemEndpointIntercluster     
- DnsName string
- DNS name for the file system.
- IpAddresses List<string>
- DnsName string
- DNS name for the file system.
- IpAddresses []string
- dnsName String
- DNS name for the file system.
- ipAddresses List<String>
- dnsName string
- DNS name for the file system.
- ipAddresses string[]
- dns_name str
- DNS name for the file system.
- ip_addresses Sequence[str]
- dnsName String
- DNS name for the file system.
- ipAddresses List<String>
GetOntapFileSystemEndpointManagement     
- DnsName string
- DNS name for the file system.
- IpAddresses List<string>
- DnsName string
- DNS name for the file system.
- IpAddresses []string
- dnsName String
- DNS name for the file system.
- ipAddresses List<String>
- dnsName string
- DNS name for the file system.
- ipAddresses string[]
- dns_name str
- DNS name for the file system.
- ip_addresses Sequence[str]
- dnsName String
- DNS name for the file system.
- ipAddresses List<String>
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the awsTerraform Provider.