OntapFileSystem

class OntapFileSystem : KotlinCustomResource

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

Example Usage

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(
aws_subnet.test1().id(),
aws_subnet.test2().id())
.deploymentType("MULTI_AZ_1")
.throughputCapacity(512)
.preferredSubnetId(aws_subnet.test1().id())
.build());
}
}

Import

FSx File Systems can be imported using the id, e.g.,

$ 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 the provider configuration on an imported resource, the provider will always show a difference. To workaround this behavior, either omit the argument from the provider configuration or use ignore_changes to hide the difference, e.g., terraform resource "aws_fsx_ontap_file_system" "example" {

... other configuration ...

security_group_ids = aws_security_group.example.id

There is no FSx API for reading security_group_ids

lifecycle { ignore_changes = security_group_ids } }

Properties

Link copied to clipboard
val arn: Output<String>

Amazon Resource Name of the file system.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
val deploymentType: Output<String>

The filesystem deployment type. Supports MULTI_AZ_1 and SINGLE_AZ_1.

Link copied to clipboard

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

Link copied to clipboard
val dnsName: Output<String>

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
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.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val kmsKeyId: Output<String>

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

Link copied to clipboard

Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.

Link copied to clipboard
val ownerId: Output<String>

AWS account identifier that created the file system.

Link copied to clipboard

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard

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.

Link copied to clipboard
val storageCapacity: Output<Int>?

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

Link copied to clipboard
val storageType: Output<String>?

The filesystem storage type. defaults to SSD.

Link copied to clipboard
val subnetIds: Output<List<String>>

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

Link copied to clipboard
val tags: Output<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.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val throughputCapacity: Output<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.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val vpcId: Output<String>

Identifier of the Virtual Private Cloud for the file system.

Link copied to clipboard

The preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.