pulumi-aws-kotlin/com.pulumi.aws.fsx.kotlin/OntapFileSystem

OntapFileSystem

class OntapFileSystem : KotlinCustomResource

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,
});

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

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,
    });
});

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

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());
    }
}

resources:
  test:
    type: aws:fsx:OntapFileSystem
    properties:
      storageCapacity: 1024
      subnetIds:
        - ${test1.id}
        - ${test2.id}
      deploymentType: MULTI_AZ_1
      throughputCapacity: 512
      preferredSubnetId: ${test1.id}

Import

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

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

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:

Properties

arn

val arn: Output<String>

Amazon Resource Name of the file system.

automaticBackupRetentionDays

val automaticBackupRetentionDays: Output<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

val dailyAutomaticBackupStartTime: Output<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

val deploymentType: Output<String>

The filesystem deployment type. Supports MULTI_AZ_1 and SINGLE_AZ_1.

diskIopsConfiguration

val diskIopsConfiguration: Output<OntapFileSystemDiskIopsConfiguration>

The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See Disk Iops Configuration below.

dnsName

val dnsName: Output<String>

The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

endpointIpAddressRange

val endpointIpAddressRange: Output<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

val endpoints: Output<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

val fsxAdminPassword: Output<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

val haPairs: Output<Int>

The number of ha_pairs to deploy for the file system. Valid values are 1 through 6. Recommend only using this parameter for 2 or more ha pairs.

val id: Output<String>

kmsKeyId

val kmsKeyId: Output<String>

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

networkInterfaceIds

val networkInterfaceIds: Output<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

val ownerId: Output<String>

AWS account identifier that created the file system.

preferredSubnetId

val preferredSubnetId: Output<String>

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC).

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

routeTableIds

val routeTableIds: Output<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

val securityGroupIds: Output<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

val storageCapacity: Output<Int>?

The storage capacity (GiB) of the file system. Valid values between 1024 and 196608.

storageType

val storageType: Output<String>?

The filesystem storage type. defaults to SSD.

subnetIds

val subnetIds: Output<List<String>>

A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.