Class: AWSCDK::FSX::CfnFileSystem::WindowsConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
fsx/cfn_file_system.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(throughput_capacity:, active_directory_id: nil, aliases: nil, audit_log_configuration: nil, automatic_backup_retention_days: nil, copy_tags_to_backups: nil, daily_automatic_backup_start_time: nil, deployment_type: nil, disk_iops_configuration: nil, fsrm_configuration: nil, preferred_subnet_id: nil, self_managed_active_directory_configuration: nil, weekly_maintenance_start_time: nil) ⇒ WindowsConfigurationProperty

Returns a new instance of WindowsConfigurationProperty.

Parameters:

  • throughput_capacity (Numeric) —

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

  • active_directory_id (String, nil) (defaults to: nil) —

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

  • aliases (Array<String>, nil) (defaults to: nil) —

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

  • audit_log_configuration (AWSCDK::IResolvable, AWSCDK::FSX::CfnFileSystem::AuditLogConfigurationProperty, nil) (defaults to: nil) —

    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.

  • automatic_backup_retention_days (Numeric, nil) (defaults to: nil) —

    The number of days to retain automatic backups.

  • copy_tags_to_backups (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • daily_automatic_backup_start_time (String, nil) (defaults to: nil) —

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

  • deployment_type (String, nil) (defaults to: nil) —

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

  • disk_iops_configuration (AWSCDK::IResolvable, AWSCDK::FSX::CfnFileSystem::DiskIopsConfigurationProperty, nil) (defaults to: nil) —

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

  • fsrm_configuration (AWSCDK::IResolvable, AWSCDK::FSX::CfnFileSystem::FsrmConfigurationProperty, nil) (defaults to: nil)
  • preferred_subnet_id (String, nil) (defaults to: nil) —

    Required when DeploymentType is set to MULTI_AZ_1 .

  • self_managed_active_directory_configuration (AWSCDK::IResolvable, AWSCDK::FSX::CfnFileSystem::SelfManagedActiveDirectoryConfigurationProperty, nil) (defaults to: nil) —

    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.

  • weekly_maintenance_start_time (String, nil) (defaults to: nil) —

    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.



2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
 
# File 'fsx/cfn_file_system.rb', line 2052

def initialize(throughput_capacity:, active_directory_id: nil, aliases: nil, audit_log_configuration: nil, automatic_backup_retention_days: nil, copy_tags_to_backups: nil, daily_automatic_backup_start_time: nil, deployment_type: nil, disk_iops_configuration: nil, fsrm_configuration: nil, preferred_subnet_id: nil, self_managed_active_directory_configuration: nil, weekly_maintenance_start_time: nil)
  @throughput_capacity = throughput_capacity
  Jsii::Type.check_type(@throughput_capacity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "throughputCapacity")
  @active_directory_id = active_directory_id
  Jsii::Type.check_type(@active_directory_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "activeDirectoryId") unless @active_directory_id.nil?
  @aliases = aliases
  Jsii::Type.check_type(@aliases, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "aliases") unless @aliases.nil?
  @audit_log_configuration = audit_log_configuration.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::AuditLogConfigurationProperty.new(**audit_log_configuration.transform_keys(&:to_sym)) : audit_log_configuration
  Jsii::Type.check_type(@audit_log_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5BdWRpdExvZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "auditLogConfiguration") unless @audit_log_configuration.nil?
  @automatic_backup_retention_days = automatic_backup_retention_days
  Jsii::Type.check_type(@automatic_backup_retention_days, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "automaticBackupRetentionDays") unless @automatic_backup_retention_days.nil?
  @copy_tags_to_backups = copy_tags_to_backups
  Jsii::Type.check_type(@copy_tags_to_backups, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "copyTagsToBackups") unless @copy_tags_to_backups.nil?
  @daily_automatic_backup_start_time = daily_automatic_backup_start_time
  Jsii::Type.check_type(@daily_automatic_backup_start_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dailyAutomaticBackupStartTime") unless @daily_automatic_backup_start_time.nil?
  @deployment_type = deployment_type
  Jsii::Type.check_type(@deployment_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deploymentType") unless @deployment_type.nil?
  @disk_iops_configuration = disk_iops_configuration.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::DiskIopsConfigurationProperty.new(**disk_iops_configuration.transform_keys(&:to_sym)) : disk_iops_configuration
  Jsii::Type.check_type(@disk_iops_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5EaXNrSW9wc0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "diskIopsConfiguration") unless @disk_iops_configuration.nil?
  @fsrm_configuration = fsrm_configuration.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::FsrmConfigurationProperty.new(**fsrm_configuration.transform_keys(&:to_sym)) : fsrm_configuration
  Jsii::Type.check_type(@fsrm_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5Gc3JtQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "fsrmConfiguration") unless @fsrm_configuration.nil?
  @preferred_subnet_id = preferred_subnet_id
  Jsii::Type.check_type(@preferred_subnet_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredSubnetId") unless @preferred_subnet_id.nil?
  @self_managed_active_directory_configuration = self_managed_active_directory_configuration.is_a?(Hash) ? ::AWSCDK::FSX::CfnFileSystem::SelfManagedActiveDirectoryConfigurationProperty.new(**self_managed_active_directory_configuration.transform_keys(&:to_sym)) : self_managed_active_directory_configuration
  Jsii::Type.check_type(@self_managed_active_directory_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mc3guQ2ZuRmlsZVN5c3RlbS5TZWxmTWFuYWdlZEFjdGl2ZURpcmVjdG9yeUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "selfManagedActiveDirectoryConfiguration") unless @self_managed_active_directory_configuration.nil?
  @weekly_maintenance_start_time = weekly_maintenance_start_time
  Jsii::Type.check_type(@weekly_maintenance_start_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "weeklyMaintenanceStartTime") unless @weekly_maintenance_start_time.nil?
end

Instance Attribute Details

#active_directory_id ⇒ String? (readonly)

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:

  • (String, nil)

See Also:



2094
2095
2096
 
# File 'fsx/cfn_file_system.rb', line 2094

def active_directory_id
  @active_directory_id
end

#aliases ⇒ Array<String>? (readonly)

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:

  • (Array<String>, nil)

See Also:



2112
2113
2114
 
# File 'fsx/cfn_file_system.rb', line 2112

def aliases
  @aliases
end

#audit_log_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



2117
2118
2119
 
# File 'fsx/cfn_file_system.rb', line 2117

def audit_log_configuration
  @audit_log_configuration
end

#automatic_backup_retention_days ⇒ Numeric? (readonly)

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:

  • (Numeric, nil)

See Also:



2124
2125
2126
 
# File 'fsx/cfn_file_system.rb', line 2124

def automatic_backup_retention_days
  @automatic_backup_retention_days
end

#copy_tags_to_backups ⇒ Boolean, ... (readonly)

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:

See Also:



2131
2132
2133
 
# File 'fsx/cfn_file_system.rb', line 2131

def copy_tags_to_backups
  @copy_tags_to_backups
end

#daily_automatic_backup_start_time ⇒ String? (readonly)

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:

  • (String, nil)

See Also:



2138
2139
2140
 
# File 'fsx/cfn_file_system.rb', line 2138

def daily_automatic_backup_start_time
  @daily_automatic_backup_start_time
end

#deployment_type ⇒ String? (readonly)

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:

  • (String, nil)

See Also:



2149
2150
2151
 
# File 'fsx/cfn_file_system.rb', line 2149

def deployment_type
  @deployment_type
end

#disk_iops_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



2156
2157
2158
 
# File 'fsx/cfn_file_system.rb', line 2156

def disk_iops_configuration
  @disk_iops_configuration
end

#fsrm_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



2159
2160
2161
 
# File 'fsx/cfn_file_system.rb', line 2159

def fsrm_configuration
  @fsrm_configuration
end

#preferred_subnet_id ⇒ String? (readonly)

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:

  • (String, nil)

See Also:



2166
2167
2168
 
# File 'fsx/cfn_file_system.rb', line 2166

def preferred_subnet_id
  @preferred_subnet_id
end

#self_managed_active_directory_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



2173
2174
2175
 
# File 'fsx/cfn_file_system.rb', line 2173

def self_managed_active_directory_configuration
  @self_managed_active_directory_configuration
end

#throughput_capacity ⇒ Numeric (readonly)

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:

  • (Numeric)

See Also:



2087
2088
2089
 
# File 'fsx/cfn_file_system.rb', line 2087

def throughput_capacity
  @throughput_capacity
end

#weekly_maintenance_start_time ⇒ String? (readonly)

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:

  • (String, nil)

See Also:



2178
2179
2180
 
# File 'fsx/cfn_file_system.rb', line 2178

def weekly_maintenance_start_time
  @weekly_maintenance_start_time
end

Class Method Details

.jsii_properties ⇒ Object 



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
 
# File 'fsx/cfn_file_system.rb', line 2180

def self.jsii_properties
  {
    :throughput_capacity => "throughputCapacity",
    :active_directory_id => "activeDirectoryId",
    :aliases => "aliases",
    :audit_log_configuration => "auditLogConfiguration",
    :automatic_backup_retention_days => "automaticBackupRetentionDays",
    :copy_tags_to_backups => "copyTagsToBackups",
    :daily_automatic_backup_start_time => "dailyAutomaticBackupStartTime",
    :deployment_type => "deploymentType",
    :disk_iops_configuration => "diskIopsConfiguration",
    :fsrm_configuration => "fsrmConfiguration",
    :preferred_subnet_id => "preferredSubnetId",
    :self_managed_active_directory_configuration => "selfManagedActiveDirectoryConfiguration",
    :weekly_maintenance_start_time => "weeklyMaintenanceStartTime",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
 
# File 'fsx/cfn_file_system.rb', line 2198

def to_jsii
  result = {}
  result.merge!({
    "throughputCapacity" => @throughput_capacity,
    "activeDirectoryId" => @active_directory_id,
    "aliases" => @aliases,
    "auditLogConfiguration" => @audit_log_configuration,
    "automaticBackupRetentionDays" => @automatic_backup_retention_days,
    "copyTagsToBackups" => @copy_tags_to_backups,
    "dailyAutomaticBackupStartTime" => @daily_automatic_backup_start_time,
    "deploymentType" => @deployment_type,
    "diskIopsConfiguration" => @disk_iops_configuration,
    "fsrmConfiguration" => @fsrm_configuration,
    "preferredSubnetId" => @preferred_subnet_id,
    "selfManagedActiveDirectoryConfiguration" => @self_managed_active_directory_configuration,
    "weeklyMaintenanceStartTime" => @weekly_maintenance_start_time,
  })
  result.compact
end