Class CfnFileSystemPropsMixin.OntapConfigurationProperty

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

Inheritance
object
CfnFileSystemPropsMixin.OntapConfigurationProperty
Inherited Members
Namespace: Amazon.CDK.Mixins.Preview.AWS.FSx.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnFileSystemPropsMixin.OntapConfigurationProperty : CfnFileSystemPropsMixin.IOntapConfigurationProperty
Syntax (vb)
Public Class CfnFileSystemPropsMixin.OntapConfigurationProperty Implements CfnFileSystemPropsMixin.IOntapConfigurationProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.FSx.Mixins;

             var ontapConfigurationProperty = new OntapConfigurationProperty {
                 AutomaticBackupRetentionDays = 123,
                 DailyAutomaticBackupStartTime = "dailyAutomaticBackupStartTime",
                 DeploymentType = "deploymentType",
                 DiskIopsConfiguration = new DiskIopsConfigurationProperty {
                     Iops = 123,
                     Mode = "mode"
                 },
                 EndpointIpAddressRange = "endpointIpAddressRange",
                 EndpointIpv6AddressRange = "endpointIpv6AddressRange",
                 FsxAdminPassword = "fsxAdminPassword",
                 HaPairs = 123,
                 PreferredSubnetId = "preferredSubnetId",
                 RouteTableIds = new [] { "routeTableIds" },
                 ThroughputCapacity = 123,
                 ThroughputCapacityPerHaPair = 123,
                 WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
             };

Synopsis

Constructors

OntapConfigurationProperty()

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

Properties

AutomaticBackupRetentionDays

The number of days to retain automatic backups.
DailyAutomaticBackupStartTime

A recurring daily time, in the format HH:MM .
DeploymentType

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

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

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

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

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

Specifies how many high-availability (HA) pairs of file servers will power your file system.
PreferredSubnetId

Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2 .
RouteTableIds

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.
ThroughputCapacity

Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps).
ThroughputCapacityPerHaPair

Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
WeeklyMaintenanceStartTime

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

Constructors

OntapConfigurationProperty()

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

public OntapConfigurationProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.FSx.Mixins;

             var ontapConfigurationProperty = new OntapConfigurationProperty {
                 AutomaticBackupRetentionDays = 123,
                 DailyAutomaticBackupStartTime = "dailyAutomaticBackupStartTime",
                 DeploymentType = "deploymentType",
                 DiskIopsConfiguration = new DiskIopsConfigurationProperty {
                     Iops = 123,
                     Mode = "mode"
                 },
                 EndpointIpAddressRange = "endpointIpAddressRange",
                 EndpointIpv6AddressRange = "endpointIpv6AddressRange",
                 FsxAdminPassword = "fsxAdminPassword",
                 HaPairs = 123,
                 PreferredSubnetId = "preferredSubnetId",
                 RouteTableIds = new [] { "routeTableIds" },
                 ThroughputCapacity = 123,
                 ThroughputCapacityPerHaPair = 123,
                 WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
             };

Properties

AutomaticBackupRetentionDays

The number of days to retain automatic backups.

public double? AutomaticBackupRetentionDays { get; set; }
Property Value

double?

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-automaticbackupretentiondays

DailyAutomaticBackupStartTime

A recurring daily time, in the format HH:MM .

public string? DailyAutomaticBackupStartTime { get; set; }
Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-dailyautomaticbackupstarttime

DeploymentType

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

public string? DeploymentType { get; set; }
Property Value

string

Remarks

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

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-deploymenttype

    DiskIopsConfiguration

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

    public object? DiskIopsConfiguration { get; set; }
    Property Value

    object

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-diskiopsconfiguration

    Type union: either IResolvable or CfnFileSystemPropsMixin.IDiskIopsConfigurationProperty

    EndpointIpAddressRange

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

    public string? EndpointIpAddressRange { get; set; }
    Property Value

    string

    Remarks

    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.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-endpointipaddressrange

    EndpointIpv6AddressRange

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

    public string? EndpointIpv6AddressRange { get; set; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-endpointipv6addressrange

    FsxAdminPassword

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

    public string? FsxAdminPassword { get; set; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-fsxadminpassword

    HaPairs

    Specifies how many high-availability (HA) pairs of file servers will power your file system.

    public double? HaPairs { get; set; }
    Property Value

    double?

    Remarks

    First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. The default value is 1. The value of this property affects the values of StorageCapacity , Iops , and ThroughputCapacity . For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols .

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

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-hapairs

      PreferredSubnetId

      Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2 .

      public string? PreferredSubnetId { get; set; }
      Property Value

      string

      Remarks

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

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-preferredsubnetid

      RouteTableIds

      (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.

      public string[]? RouteTableIds { get; set; }
      Property Value

      string[]

      Remarks

      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.

      Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with <code>Key: AmazonFSx; Value: ManagedByAmazonFSx</code> . When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the <code>Key: AmazonFSx; Value: ManagedByAmazonFSx</code> tag manually.

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-routetableids

      ThroughputCapacity

      Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps).

      public double? ThroughputCapacity { get; set; }
      Property Value

      double?

      Remarks

      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:

        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-throughputcapacity

        ThroughputCapacityPerHaPair

        Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.

        public double? ThroughputCapacityPerHaPair { get; set; }
        Property Value

        double?

        Remarks

        You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.

        This field and ThroughputCapacity are the same for file systems powered by one HA pair.

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

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-throughputcapacityperhapair

            WeeklyMaintenanceStartTime

            The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

            public string? WeeklyMaintenanceStartTime { get; set; }
            Property Value

            string

            Remarks

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

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-weeklymaintenancestarttime

            Implements