Class: Aws::FSx::Types::UpdateFileSystemWindowsConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::UpdateFileSystemWindowsConfiguration

Defined in:

gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass UpdateFileSystemWindowsConfiguration data as a hash:

{
  weekly_maintenance_start_time: "WeeklyTime",
  daily_automatic_backup_start_time: "DailyTime",
  automatic_backup_retention_days: 1,
  throughput_capacity: 1,
  self_managed_active_directory_configuration: {
    user_name: "DirectoryUserName",
    password: "DirectoryPassword",
    dns_ips: ["IpAddress"],
  },
}

Updates the configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx only overwrites existing properties with non-null values provided in the request.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #automatic_backup_retention_days ⇒ Integer

  The number of days to retain automatic daily backups.

• #daily_automatic_backup_start_time ⇒ String

  The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00.

• #self_managed_active_directory_configuration ⇒ Types::SelfManagedActiveDirectoryConfigurationUpdates

  The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD directory.

• #throughput_capacity ⇒ Integer

  Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to.

• #weekly_maintenance_start_time ⇒ String

  The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone.

Instance Attribute Details

#automatic_backup_retention_days ⇒ Integer

The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see Working with Automatic Daily Backups.

Returns:

• (Integer)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3574

class UpdateFileSystemWindowsConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :throughput_capacity,
  :self_managed_active_directory_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#daily_automatic_backup_start_time ⇒ String

The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3574

class UpdateFileSystemWindowsConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :throughput_capacity,
  :self_managed_active_directory_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#self_managed_active_directory_configuration ⇒ Types::SelfManagedActiveDirectoryConfigurationUpdates

The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD directory. You cannot make a self-managed Microsoft AD update request if there is an existing self-managed Microsoft AD update request in progress.

Returns:

• (Types::SelfManagedActiveDirectoryConfigurationUpdates)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3574

class UpdateFileSystemWindowsConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :throughput_capacity,
  :self_managed_active_directory_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#throughput_capacity ⇒ Integer

Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, see Managing Throughput Capacity.

Returns:

• (Integer)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3574

class UpdateFileSystemWindowsConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :throughput_capacity,
  :self_managed_active_directory_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#weekly_maintenance_start_time ⇒ String

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, with 1 = Monday and 7 = Sunday.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3574

class UpdateFileSystemWindowsConfiguration < Struct.new(
  :weekly_maintenance_start_time,
  :daily_automatic_backup_start_time,
  :automatic_backup_retention_days,
  :throughput_capacity,
  :self_managed_active_directory_configuration)
  SENSITIVE = []
  include Aws::Structure
end