AWS v6.60.0 published on Tuesday, Nov 19, 2024 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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:fsx/getOntapFileSystem:getOntapFileSystem
arguments:
# arguments dictionary
The 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.
- Automatic
Backup intRetention Days - The number of days to retain automatic backups.
- Daily
Automatic stringBackup Start Time - The preferred time (in
HH:MM
format) to take daily automatic backups, in the UTC time zone. - Deployment
Type string - The file system deployment type.
- Disk
Iops 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.
- Dns
Name string - DNS name for the file system.
- Endpoint
Ip stringAddress Range - (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist.
- Endpoints
List<Get
Ontap 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 string
- Identifier of the file system (e.g.
fs-12345678
). - Kms
Key stringId - ARN for the KMS Key to encrypt the file system at rest.
- Network
Interface List<string>Ids - The IDs of the elastic network interfaces from which a specific file system is accessible.
- Owner
Id string - AWS account identifier that created the file system.
- Preferred
Subnet stringId - Specifies the subnet in which you want the preferred file server to be located.
- Route
Table List<string>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 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. - Subnet
Ids 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_id
property. - Dictionary<string, string>
- 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 string - The ID of the primary virtual private cloud (VPC) for the file system.
- Weekly
Maintenance stringStart Time - 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.
- Automatic
Backup intRetention Days - The number of days to retain automatic backups.
- Daily
Automatic stringBackup Start Time - The preferred time (in
HH:MM
format) to take daily automatic backups, in the UTC time zone. - Deployment
Type string - The file system deployment type.
- Disk
Iops []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 string - DNS name for the file system.
- Endpoint
Ip stringAddress Range - (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist.
- Endpoints
[]Get
Ontap 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 string
- Identifier of the file system (e.g.
fs-12345678
). - Kms
Key stringId - ARN for the KMS Key to encrypt the file system at rest.
- Network
Interface []stringIds - The IDs of the elastic network interfaces from which a specific file system is accessible.
- Owner
Id string - AWS account identifier that created the file system.
- Preferred
Subnet stringId - Specifies the subnet in which you want the preferred file server to be located.
- Route
Table []stringIds - (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 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. - Subnet
Ids []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_id
property. - map[string]string
- 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 string - The ID of the primary virtual private cloud (VPC) for the file system.
- Weekly
Maintenance stringStart Time - 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.
- automatic
Backup IntegerRetention Days - The number of days to retain automatic backups.
- daily
Automatic StringBackup Start Time - The preferred time (in
HH:MM
format) to take daily automatic backups, in the UTC time zone. - deployment
Type String - The file system deployment type.
- disk
Iops 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.
- dns
Name String - DNS name for the file system.
- endpoint
Ip StringAddress Range - (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist.
- endpoints
List<Get
Ontap 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 Integer - The number of HA pairs for the file system.
- id String
- Identifier of the file system (e.g.
fs-12345678
). - kms
Key StringId - ARN for the KMS Key to encrypt the file system at rest.
- network
Interface List<String>Ids - The IDs of the elastic network interfaces from which a specific file system is accessible.
- owner
Id String - AWS account identifier that created the file system.
- preferred
Subnet StringId - Specifies the subnet in which you want the preferred file server to be located.
- route
Table List<String>Ids - (Multi-AZ only) The VPC route tables in which your file system's endpoints exist.
- storage
Capacity Integer - The storage capacity of the file system in gibibytes (GiB).
- storage
Type 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. - subnet
Ids 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_id
property. - Map<String,String>
- The tags associated with the file system.
- throughput
Capacity 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
- throughput
Capacity IntegerPer Ha Pair - The sustained throughput of each HA pair for an Amazon FSx file system in Megabytes per second (MBps).
- vpc
Id String - The ID of the primary virtual private cloud (VPC) for the file system.
- weekly
Maintenance StringStart Time - 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.
- automatic
Backup numberRetention Days - The number of days to retain automatic backups.
- daily
Automatic stringBackup Start Time - The preferred time (in
HH:MM
format) to take daily automatic backups, in the UTC time zone. - deployment
Type string - The file system deployment type.
- disk
Iops 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 string - DNS name for the file system.
- endpoint
Ip stringAddress Range - (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system exist.
- endpoints
Get
Ontap 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 number - The number of HA pairs for the file system.
- id string
- Identifier of the file system (e.g.
fs-12345678
). - kms
Key stringId - ARN for the KMS Key to encrypt the file system at rest.
- network
Interface string[]Ids - The IDs of the elastic network interfaces from which a specific file system is accessible.
- owner
Id string - AWS account identifier that created the file system.
- preferred
Subnet stringId - Specifies the subnet in which you want the preferred file server to be located.
- route
Table string[]Ids - (Multi-AZ only) The VPC route tables in which your file system's endpoints exist.
- storage
Capacity number - The storage capacity of the file system in gibibytes (GiB).
- storage
Type 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. - subnet
Ids 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_id
property. - {[key: string]: string}
- The tags associated with the file system.
- throughput
Capacity 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
- throughput
Capacity numberPer Ha Pair - The sustained throughput of each HA pair for an Amazon FSx file system in Megabytes per second (MBps).
- vpc
Id string - The ID of the primary virtual private cloud (VPC) for the file system.
- weekly
Maintenance stringStart Time - 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_ intretention_ days - The number of days to retain automatic backups.
- daily_
automatic_ strbackup_ start_ time - The preferred time (in
HH:MM
format) 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[Get
Ontap 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_id
property. - 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:MM
format) to perform weekly maintenance, in the UTC time zone.
- arn String
- Amazon Resource Name of the file system.
- automatic
Backup NumberRetention Days - The number of days to retain automatic backups.
- daily
Automatic StringBackup Start Time - The preferred time (in
HH:MM
format) to take daily automatic backups, in the UTC time zone. - deployment
Type String - The file system deployment type.
- disk
Iops 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.
- dns
Name String - DNS name for the file system.
- endpoint
Ip 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.
- ha
Pairs Number - The number of HA pairs for the file system.
- id String
- Identifier of the file system (e.g.
fs-12345678
). - kms
Key StringId - ARN for the KMS Key to encrypt the file system at rest.
- network
Interface List<String>Ids - The IDs of the elastic network interfaces from which a specific file system is accessible.
- owner
Id String - AWS account identifier that created the file system.
- preferred
Subnet StringId - Specifies the subnet in which you want the preferred file server to be located.
- route
Table List<String>Ids - (Multi-AZ only) The VPC route tables in which your file system's endpoints exist.
- storage
Capacity Number - The storage capacity of the file system in gibibytes (GiB).
- storage
Type 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. - subnet
Ids 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_id
property. - Map<String>
- The tags associated with the file system.
- throughput
Capacity 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
- throughput
Capacity NumberPer Ha Pair - The sustained throughput of each HA pair for an Amazon FSx file system in Megabytes per second (MBps).
- vpc
Id String - The ID of the primary virtual private cloud (VPC) for the file system.
- weekly
Maintenance StringStart Time - The preferred start time (in
D:HH:MM
format) to perform weekly maintenance, in the UTC time zone.
Supporting Types
GetOntapFileSystemDiskIopsConfiguration
GetOntapFileSystemEndpoint
- Interclusters
List<Get
Ontap 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<Get
Ontap File System Endpoint Management> - A FileSystemEndpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See FileSystemEndpoint below.
- Interclusters
[]Get
Ontap File System Endpoint Intercluster - A FileSystemEndpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See FileSystemEndpoint below.
- Managements
[]Get
Ontap 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<Get
Ontap 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<Get
Ontap File System Endpoint Management> - A FileSystemEndpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. See FileSystemEndpoint below.
- interclusters
Get
Ontap File System Endpoint Intercluster[] - A FileSystemEndpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. See FileSystemEndpoint below.
- managements
Get
Ontap 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[Get
Ontap 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[Get
Ontap 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
- Dns
Name string - DNS name for the file system.
- Ip
Addresses List<string>
- Dns
Name string - DNS name for the file system.
- Ip
Addresses []string
- dns
Name String - DNS name for the file system.
- ip
Addresses List<String>
- dns
Name string - DNS name for the file system.
- ip
Addresses string[]
- dns_
name str - DNS name for the file system.
- ip_
addresses Sequence[str]
- dns
Name String - DNS name for the file system.
- ip
Addresses List<String>
GetOntapFileSystemEndpointManagement
- Dns
Name string - DNS name for the file system.
- Ip
Addresses List<string>
- Dns
Name string - DNS name for the file system.
- Ip
Addresses []string
- dns
Name String - DNS name for the file system.
- ip
Addresses List<String>
- dns
Name string - DNS name for the file system.
- ip
Addresses string[]
- dns_
name str - DNS name for the file system.
- ip_
addresses Sequence[str]
- dns
Name String - DNS name for the file system.
- ip
Addresses List<String>
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.