Package software.amazon.awscdk.services.fsx

Class CfnFileSystem.OntapConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.fsx.CfnFileSystem.OntapConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFileSystem.OntapConfigurationProperty>

Enclosing interface:

CfnFileSystem.OntapConfigurationProperty

@Stability(Stable)
public static final class CfnFileSystem.OntapConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFileSystem.OntapConfigurationProperty>

A builder for CfnFileSystem.OntapConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFileSystem.OntapConfigurationProperty.Builder	automaticBackupRetentionDays(Number automaticBackupRetentionDays)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getAutomaticBackupRetentionDays()
CfnFileSystem.OntapConfigurationProperty	build()	Builds the configured instance.
CfnFileSystem.OntapConfigurationProperty.Builder	dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getDailyAutomaticBackupStartTime()
CfnFileSystem.OntapConfigurationProperty.Builder	deploymentType(String deploymentType)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getDeploymentType()
CfnFileSystem.OntapConfigurationProperty.Builder	diskIopsConfiguration(IResolvable diskIopsConfiguration)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getDiskIopsConfiguration()
CfnFileSystem.OntapConfigurationProperty.Builder	diskIopsConfiguration(CfnFileSystem.DiskIopsConfigurationProperty diskIopsConfiguration)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getDiskIopsConfiguration()
CfnFileSystem.OntapConfigurationProperty.Builder	endpointIpAddressRange(String endpointIpAddressRange)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getEndpointIpAddressRange()
CfnFileSystem.OntapConfigurationProperty.Builder	fsxAdminPassword(String fsxAdminPassword)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getFsxAdminPassword()
CfnFileSystem.OntapConfigurationProperty.Builder	haPairs(Number haPairs)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getHaPairs()
CfnFileSystem.OntapConfigurationProperty.Builder	preferredSubnetId(String preferredSubnetId)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getPreferredSubnetId()
CfnFileSystem.OntapConfigurationProperty.Builder	routeTableIds(List<String> routeTableIds)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getRouteTableIds()
CfnFileSystem.OntapConfigurationProperty.Builder	throughputCapacity(Number throughputCapacity)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getThroughputCapacity()
CfnFileSystem.OntapConfigurationProperty.Builder	throughputCapacityPerHaPair(Number throughputCapacityPerHaPair)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getThroughputCapacityPerHaPair()
CfnFileSystem.OntapConfigurationProperty.Builder	weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)	Sets the value of CfnFileSystem.OntapConfigurationProperty.getWeeklyMaintenanceStartTime()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

deploymentType

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder deploymentType(String deploymentType)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getDeploymentType()

Parameters:

deploymentType - Specifies the FSx for ONTAP file system deployment type to use in creating the file system. This parameter is required.

• 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.
• SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs 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 .

Returns:

this

automaticBackupRetentionDays

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder automaticBackupRetentionDays(Number automaticBackupRetentionDays)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getAutomaticBackupRetentionDays()

Parameters:

automaticBackupRetentionDays - 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 30 .

Returns:

this

dailyAutomaticBackupStartTime

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getDailyAutomaticBackupStartTime()

Parameters:

dailyAutomaticBackupStartTime - 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.

Returns:

this

diskIopsConfiguration

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder diskIopsConfiguration(IResolvable diskIopsConfiguration)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getDiskIopsConfiguration()

Parameters:

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

Returns:

this

diskIopsConfiguration

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder diskIopsConfiguration(CfnFileSystem.DiskIopsConfigurationProperty diskIopsConfiguration)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getDiskIopsConfiguration()

Parameters:

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

Returns:

this

endpointIpAddressRange

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder endpointIpAddressRange(String endpointIpAddressRange)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getEndpointIpAddressRange()

Parameters:

endpointIpAddressRange - (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, as long as they don't overlap with any subnet.

Returns:

this

fsxAdminPassword

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder fsxAdminPassword(String fsxAdminPassword)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getFsxAdminPassword()

Parameters:

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

Returns:

this

haPairs

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder haPairs(Number haPairs)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getHaPairs()

Parameters:

haPairs - the value to be set.

Returns:

this

preferredSubnetId

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder preferredSubnetId(String preferredSubnetId)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getPreferredSubnetId()

Parameters:

preferredSubnetId - Required when DeploymentType is set to MULTI_AZ_1 . This specifies the subnet in which you want the preferred file server to be located.

Returns:

this

routeTableIds

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder routeTableIds(List<String> routeTableIds)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getRouteTableIds()

Parameters:

routeTableIds - (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

Returns:

this

throughputCapacity

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder throughputCapacity(Number throughputCapacity)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getThroughputCapacity()

Parameters:

throughputCapacity - Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps). For more information, see Managing throughput capacity in the FSx for ONTAP User Guide.

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

• The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
• The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity .

Returns:

this

throughputCapacityPerHaPair

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder throughputCapacityPerHaPair(Number throughputCapacityPerHaPair)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getThroughputCapacityPerHaPair()

Parameters:

throughputCapacityPerHaPair - the value to be set.

Returns:

this

weeklyMaintenanceStartTime

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty.Builder weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)

Sets the value of CfnFileSystem.OntapConfigurationProperty.getWeeklyMaintenanceStartTime()

Parameters:

weeklyMaintenanceStartTime - 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.

Returns:

this

build

@Stability(Stable)
public CfnFileSystem.OntapConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnFileSystem.OntapConfigurationProperty>

Returns:

a new instance of CfnFileSystem.OntapConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided