software.amazon.awscdk.services.fsx

Interface CfnFileSystem.OntapConfigurationProperty

All Known Implementing Classes:

CfnFileSystem.OntapConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFileSystem

public static interface CfnFileSystem.OntapConfigurationProperty

The configuration for this FSx for ONTAP file system.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.fsx.*;
 OntapConfigurationProperty ontapConfigurationProperty = OntapConfigurationProperty.builder()
         .deploymentType("deploymentType")
         // the properties below are optional
         .automaticBackupRetentionDays(123)
         .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime")
         .diskIopsConfiguration(DiskIopsConfigurationProperty.builder()
                 .iops(123)
                 .mode("mode")
                 .build())
         .endpointIpAddressRange("endpointIpAddressRange")
         .fsxAdminPassword("fsxAdminPassword")
         .preferredSubnetId("preferredSubnetId")
         .routeTableIds(List.of("routeTableIds"))
         .throughputCapacity(123)
         .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFileSystem.OntapConfigurationProperty.Builder A builder for CfnFileSystem.OntapConfigurationProperty
static class	CfnFileSystem.OntapConfigurationProperty.Jsii$Proxy An implementation for CfnFileSystem.OntapConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnFileSystem.OntapConfigurationProperty.Builder	builder()
default java.lang.Number	getAutomaticBackupRetentionDays() The number of days to retain automatic backups.
default java.lang.String	getDailyAutomaticBackupStartTime() A recurring daily time, in the format `HH:MM` .
java.lang.String	getDeploymentType() Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
default java.lang.Object	getDiskIopsConfiguration() The SSD IOPS configuration for the FSx for ONTAP file system.
default java.lang.String	getEndpointIpAddressRange() Specifies the IP address range in which the endpoints to access your file system will be created.
default java.lang.String	getFsxAdminPassword() The ONTAP administrative password for the `fsxadmin` user with which you administer your file system using the NetApp ONTAP CLI and REST API.
default java.lang.String	getPreferredSubnetId() Required when `DeploymentType` is set to `MULTI_AZ_1` .
default java.util.List<java.lang.String>	getRouteTableIds() Specifies the virtual private cloud (VPC) route tables in which your file system's endpoints will be created.
default java.lang.Number	getThroughputCapacity() Sets the throughput capacity for the file system that you're creating.
default java.lang.String	getWeeklyMaintenanceStartTime() A recurring weekly time, in the format `D:HH:MM` .

Method Detail

getDeploymentType

java.lang.String getDeploymentType()

Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

MULTI_AZ_1 is the supported ONTAP deployment type.

getAutomaticBackupRetentionDays

default java.lang.Number getAutomaticBackupRetentionDays()

The number of days to retain automatic backups.

Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0 .

getDailyAutomaticBackupStartTime

default java.lang.String getDailyAutomaticBackupStartTime()

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.

getDiskIopsConfiguration

default java.lang.Object getDiskIopsConfiguration()

The SSD IOPS configuration for the FSx for ONTAP file system.

getEndpointIpAddressRange

default java.lang.String getEndpointIpAddressRange()

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.

getFsxAdminPassword

default java.lang.String getFsxAdminPassword()

The ONTAP administrative password for the `fsxadmin` user with which you administer your file system using the NetApp ONTAP CLI and REST API.

getPreferredSubnetId

default java.lang.String getPreferredSubnetId()

Required when `DeploymentType` is set to `MULTI_AZ_1` .

This specifies the subnet in which you want the preferred file server to be located.

getRouteTableIds

default java.util.List<java.lang.String> getRouteTableIds()

Specifies the virtual private cloud (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.

getThroughputCapacity

default java.lang.Number getThroughputCapacity()

Sets the throughput capacity for the file system that you're creating.

Valid values are 128, 256, 512, 1024, and 2048 MBps.

getWeeklyMaintenanceStartTime

default java.lang.String getWeeklyMaintenanceStartTime()

A recurring weekly time, in the format `D:HH:MM` .

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

builder

static CfnFileSystem.OntapConfigurationProperty.Builder builder()

Returns:

a CfnFileSystem.OntapConfigurationProperty.Builder of CfnFileSystem.OntapConfigurationProperty