Package software.amazon.awscdk.cfnpropertymixins.services.fsx

Class CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.fsx.CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFileSystemPropsMixin.WindowsConfigurationProperty>

Enclosing interface:

CfnFileSystemPropsMixin.WindowsConfigurationProperty

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

A builder for CfnFileSystemPropsMixin.WindowsConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	activeDirectoryId(String activeDirectoryId)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getActiveDirectoryId()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	aliases(List<String> aliases)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getAliases()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	auditLogConfiguration(CfnFileSystemPropsMixin.AuditLogConfigurationProperty auditLogConfiguration)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getAuditLogConfiguration()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	auditLogConfiguration(IResolvable auditLogConfiguration)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getAuditLogConfiguration()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	automaticBackupRetentionDays(Number automaticBackupRetentionDays)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getAutomaticBackupRetentionDays()
CfnFileSystemPropsMixin.WindowsConfigurationProperty	build()	Builds the configured instance.
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	copyTagsToBackups(Boolean copyTagsToBackups)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getCopyTagsToBackups()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	copyTagsToBackups(IResolvable copyTagsToBackups)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getCopyTagsToBackups()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getDailyAutomaticBackupStartTime()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	deploymentType(String deploymentType)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getDeploymentType()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	diskIopsConfiguration(CfnFileSystemPropsMixin.DiskIopsConfigurationProperty diskIopsConfiguration)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getDiskIopsConfiguration()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	diskIopsConfiguration(IResolvable diskIopsConfiguration)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getDiskIopsConfiguration()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	preferredSubnetId(String preferredSubnetId)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getPreferredSubnetId()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	selfManagedActiveDirectoryConfiguration(CfnFileSystemPropsMixin.SelfManagedActiveDirectoryConfigurationProperty selfManagedActiveDirectoryConfiguration)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getSelfManagedActiveDirectoryConfiguration()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	selfManagedActiveDirectoryConfiguration(IResolvable selfManagedActiveDirectoryConfiguration)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getSelfManagedActiveDirectoryConfiguration()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	throughputCapacity(Number throughputCapacity)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getThroughputCapacity()
CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder	weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)	Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.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

activeDirectoryId

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder activeDirectoryId(String activeDirectoryId)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getActiveDirectoryId()

Parameters:

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

Returns:

this

aliases

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder aliases(List<String> aliases)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getAliases()

Parameters:

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

Returns:

this

auditLogConfiguration

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder auditLogConfiguration(IResolvable auditLogConfiguration)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getAuditLogConfiguration()

Parameters:

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

Returns:

this

auditLogConfiguration

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder auditLogConfiguration(CfnFileSystemPropsMixin.AuditLogConfigurationProperty auditLogConfiguration)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getAuditLogConfiguration()

Parameters:

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

Returns:

this

automaticBackupRetentionDays

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder automaticBackupRetentionDays(Number automaticBackupRetentionDays)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.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

copyTagsToBackups

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder copyTagsToBackups(Boolean copyTagsToBackups)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getCopyTagsToBackups()

Parameters:

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

Returns:

this

copyTagsToBackups

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder copyTagsToBackups(IResolvable copyTagsToBackups)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getCopyTagsToBackups()

Parameters:

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

Returns:

this

dailyAutomaticBackupStartTime

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.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

deploymentType

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder deploymentType(String deploymentType)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getDeploymentType()

Parameters:

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

Returns:

this

diskIopsConfiguration

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder diskIopsConfiguration(IResolvable diskIopsConfiguration)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getDiskIopsConfiguration()

Parameters:

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

Returns:

this

diskIopsConfiguration

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder diskIopsConfiguration(CfnFileSystemPropsMixin.DiskIopsConfigurationProperty diskIopsConfiguration)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getDiskIopsConfiguration()

Parameters:

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

Returns:

this

preferredSubnetId

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder preferredSubnetId(String preferredSubnetId)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.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. 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.

Returns:

this

selfManagedActiveDirectoryConfiguration

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder selfManagedActiveDirectoryConfiguration(IResolvable selfManagedActiveDirectoryConfiguration)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getSelfManagedActiveDirectoryConfiguration()

Parameters:

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

Returns:

this

selfManagedActiveDirectoryConfiguration

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder selfManagedActiveDirectoryConfiguration(CfnFileSystemPropsMixin.SelfManagedActiveDirectoryConfigurationProperty selfManagedActiveDirectoryConfiguration)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getSelfManagedActiveDirectoryConfiguration()

Parameters:

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

Returns:

this

throughputCapacity

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder throughputCapacity(Number throughputCapacity)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getThroughputCapacity()

Parameters:

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

Returns:

this

weeklyMaintenanceStartTime

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty.Builder weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)

Sets the value of CfnFileSystemPropsMixin.WindowsConfigurationProperty.getWeeklyMaintenanceStartTime()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnFileSystemPropsMixin.WindowsConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnFileSystemPropsMixin.WindowsConfigurationProperty>

Returns:

a new instance of CfnFileSystemPropsMixin.WindowsConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided