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

OntapFileSystemArgs

data class OntapFileSystemArgs(val automaticBackupRetentionDays: Output<Int>? = null, val dailyAutomaticBackupStartTime: Output<String>? = null, val deploymentType: Output<String>? = null, val diskIopsConfiguration: Output<OntapFileSystemDiskIopsConfigurationArgs>? = null, val endpointIpAddressRange: Output<String>? = null, val fsxAdminPassword: Output<String>? = null, val kmsKeyId: Output<String>? = null, val preferredSubnetId: Output<String>? = null, val routeTableIds: Output<List<String>>? = null, val securityGroupIds: Output<List<String>>? = null, val storageCapacity: Output<Int>? = null, val storageType: Output<String>? = null, val subnetIds: Output<List<String>>? = null, val tags: Output<Map<String, String>>? = null, val throughputCapacity: Output<Int>? = null, val weeklyMaintenanceStartTime: Output<String>? = null) : ConvertibleToJava<OntapFileSystemArgs>

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

Constructors

OntapFileSystemArgs

fun OntapFileSystemArgs(automaticBackupRetentionDays: Output<Int>? = null, dailyAutomaticBackupStartTime: Output<String>? = null, deploymentType: Output<String>? = null, diskIopsConfiguration: Output<OntapFileSystemDiskIopsConfigurationArgs>? = null, endpointIpAddressRange: Output<String>? = null, fsxAdminPassword: Output<String>? = null, kmsKeyId: Output<String>? = null, preferredSubnetId: Output<String>? = null, routeTableIds: Output<List<String>>? = null, securityGroupIds: Output<List<String>>? = null, storageCapacity: Output<Int>? = null, storageType: Output<String>? = null, subnetIds: Output<List<String>>? = null, tags: Output<Map<String, String>>? = null, throughputCapacity: Output<Int>? = null, weeklyMaintenanceStartTime: Output<String>? = null)

Functions

toJava

open override fun toJava(): OntapFileSystemArgs

Properties

automaticBackupRetentionDays

val automaticBackupRetentionDays: Output<Int>? = null

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>? = null

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>? = null

The filesystem deployment type. Supports MULTI_AZ_1 and SINGLE_AZ_1.

diskIopsConfiguration

val diskIopsConfiguration: Output<OntapFileSystemDiskIopsConfigurationArgs>? = null

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

endpointIpAddressRange

val endpointIpAddressRange: Output<String>? = null

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

val fsxAdminPassword: Output<String>? = null

The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.

kmsKeyId

val kmsKeyId: Output<String>? = null

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

preferredSubnetId

val preferredSubnetId: Output<String>? = null

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

routeTableIds

val routeTableIds: Output<List<String>>? = null

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>>? = null

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>? = null

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

storageType

val storageType: Output<String>? = null

The filesystem storage type. defaults to SSD.

subnetIds

val subnetIds: Output<List<String>>? = null

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