software.amazon.awscdk.services.fsx

Interface CfnFileSystem.OntapConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFileSystem.OntapConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFileSystem

@Stability(value=Stable)
public static interface CfnFileSystem.OntapConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration for this Amazon FSx for NetApp 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 Number	getAutomaticBackupRetentionDays() The number of days to retain automatic backups.
default String	getDailyAutomaticBackupStartTime() A recurring daily time, in the format `HH:MM` .
String	getDeploymentType() Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
default Object	getDiskIopsConfiguration() The SSD IOPS configuration for the FSx for ONTAP file system.
default String	getEndpointIpAddressRange() (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
default 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 String	getPreferredSubnetId() Required when `DeploymentType` is set to `MULTI_AZ_1` .
default List<String>	getRouteTableIds() (Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your file system's endpoints will be created.
default Number	getThroughputCapacity() Sets the throughput capacity for the file system that you're creating.
default String	getWeeklyMaintenanceStartTime() A recurring weekly time, in the format `D:HH:MM` .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeploymentType

@Stability(value=Stable)
 @NotNull
String getDeploymentType()

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

• MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.
• SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type .

getAutomaticBackupRetentionDays

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
 @Nullable
default Object getDiskIopsConfiguration()

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

getEndpointIpAddressRange

@Stability(value=Stable)
 @Nullable
default String getEndpointIpAddressRange()

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

getFsxAdminPassword

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
 @Nullable
default List<String> getRouteTableIds()

(Multi-AZ only) 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

@Stability(value=Stable)
 @Nullable
default Number getThroughputCapacity()

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

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

getWeeklyMaintenanceStartTime

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
static CfnFileSystem.OntapConfigurationProperty.Builder builder()

Returns:

a CfnFileSystem.OntapConfigurationProperty.Builder of CfnFileSystem.OntapConfigurationProperty