Package software.amazon.awscdk.services.fsx

Interface CfnFileSystem.WindowsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFileSystem.WindowsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFileSystem

@Stability(Stable)
public static interface CfnFileSystem.WindowsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The Microsoft Windows configuration for the file system that's being created.

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.*;
 WindowsConfigurationProperty windowsConfigurationProperty = WindowsConfigurationProperty.builder()
         .throughputCapacity(123)
         // the properties below are optional
         .activeDirectoryId("activeDirectoryId")
         .aliases(List.of("aliases"))
         .auditLogConfiguration(AuditLogConfigurationProperty.builder()
                 .fileAccessAuditLogLevel("fileAccessAuditLogLevel")
                 .fileShareAccessAuditLogLevel("fileShareAccessAuditLogLevel")
                 // the properties below are optional
                 .auditLogDestination("auditLogDestination")
                 .build())
         .automaticBackupRetentionDays(123)
         .copyTagsToBackups(false)
         .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime")
         .deploymentType("deploymentType")
         .diskIopsConfiguration(DiskIopsConfigurationProperty.builder()
                 .iops(123)
                 .mode("mode")
                 .build())
         .preferredSubnetId("preferredSubnetId")
         .selfManagedActiveDirectoryConfiguration(SelfManagedActiveDirectoryConfigurationProperty.builder()
                 .dnsIps(List.of("dnsIps"))
                 .domainName("domainName")
                 .fileSystemAdministratorsGroup("fileSystemAdministratorsGroup")
                 .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
                 .password("password")
                 .userName("userName")
                 .build())
         .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFileSystem.WindowsConfigurationProperty.Builder	builder()
default String	getActiveDirectoryId()	The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
default List<String>	getAliases()	An array of one or more DNS alias names that you want to associate with the Amazon FSx file system.
default Object	getAuditLogConfiguration()	The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
default Number	getAutomaticBackupRetentionDays()	The number of days to retain automatic backups.
default Object	getCopyTagsToBackups()	A boolean flag indicating whether tags for the file system should be copied to backups.
default String	getDailyAutomaticBackupStartTime()	A recurring daily time, in the format HH:MM .
default String	getDeploymentType()	Specifies the file system deployment type, valid values are the following:.
default Object	getDiskIopsConfiguration()	The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.
default String	getPreferredSubnetId()	Required when DeploymentType is set to MULTI_AZ_1 .
default Object	getSelfManagedActiveDirectoryConfiguration()	The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory.
Number	getThroughputCapacity()	Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the n th increments, between 2^3 (8) and 2^11 (2048).
default String	getWeeklyMaintenanceStartTime()	A recurring weekly time, in the format D:HH:MM .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getThroughputCapacity

@Stability(Stable)
@NotNull
Number getThroughputCapacity()

Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the n th increments, between 2^3 (8) and 2^11 (2048).

To increase storage capacity, a file system must have a minimum throughput capacity of 16 MB/s.

See Also:

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

getActiveDirectoryId

@Stability(Stable)
@Nullable
default String getActiveDirectoryId()

The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.

Required if you are joining the file system to an existing AWS Managed Microsoft AD.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-activedirectoryid

getAliases

@Stability(Stable)
@Nullable
default List<String> getAliases()

An array of one or more DNS alias names that you want to associate with the Amazon FSx file system.

Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time.

For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system , including additional steps you must take to be able to access your file system using a DNS alias.

An alias name has to meet the following requirements:

• Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com .
• Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
• Cannot start or end with a hyphen.
• Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetical characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-aliases

getAuditLogConfiguration

@Stability(Stable)
@Nullable
default Object getAuditLogConfiguration()

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-auditlogconfiguration

getAutomaticBackupRetentionDays

@Stability(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 30 .

See Also:

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

getCopyTagsToBackups

@Stability(Stable)
@Nullable
default Object getCopyTagsToBackups()

A boolean flag indicating whether tags for the file system should be copied to backups.

This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-copytagstobackups

getDailyAutomaticBackupStartTime

@Stability(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.

See Also:

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

getDeploymentType

@Stability(Stable)
@Nullable
default String getDeploymentType()

Specifies the file system deployment type, valid values are the following:.

• MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage type
• SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.
• SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.

For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems .

See Also:

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

getDiskIopsConfiguration

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

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.

By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

See Also:

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

getPreferredSubnetId

@Stability(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. For in- AWS applications, we recommend that you launch your clients in the same availability zone as your preferred file server to reduce cross-availability zone data transfer costs and minimize latency.

See Also:

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

getSelfManagedActiveDirectoryConfiguration

@Stability(Stable)
@Nullable
default Object getSelfManagedActiveDirectoryConfiguration()

The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory.

For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration

getWeeklyMaintenanceStartTime

@Stability(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.

See Also:

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

builder

@Stability(Stable)
static CfnFileSystem.WindowsConfigurationProperty.Builder builder()

Returns:

a CfnFileSystem.WindowsConfigurationProperty.Builder of CfnFileSystem.WindowsConfigurationProperty