AWS::FSx::FileSystem OntapConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::FSx::FileSystem OntapConfiguration

The configuration for this Amazon FSx for NetApp ONTAP file system.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

Properties

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.

Required: No

Type: Integer

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

DeploymentType

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.

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

Required: Yes

Type: String

Allowed values: MULTI_AZ_1 | SINGLE_AZ_1 | SINGLE_AZ_2

Update requires: No interruption

DiskIopsConfiguration

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

Required: No

Type: DiskIopsConfiguration

Update requires: No interruption

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.

Required: No

Type: String

Pattern: ^[^\u0000\u0085\u2028\u2029\r\n]{9,17}$

Minimum: 9

Maximum: 17

Update requires: No interruption

FsxAdminPassword

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

Required: No

Type: String

Pattern: ^[^\u0000\u0085\u2028\u2029\r\n]{8,50}$

Minimum: 8

Maximum: 50

Update requires: No interruption

HAPairs

Property description not available.

Required: No

Type: Integer

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: Array of String

Maximum: 50

Update requires: No interruption

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.

Required: No

Type: Integer

Minimum: 8

Maximum: 100000

Update requires: No interruption

ThroughputCapacityPerHAPair

Property description not available.

Required: No

Type: Integer

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption