Class: Aws::FSx::Types::AssociateFileSystemAliasesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

Note:

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

{
  client_request_token: "ClientRequestToken",
  file_system_id: "FileSystemId", # required
  aliases: ["AlternateDNSName"], # required
}

The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aliasesArray<String>

An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements:

  • Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.corp.example.com.

  • Can contain alphanumeric characters and the hyphen (-).

  • Cannot start or end with a hyphen.

  • Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetic 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>)


303
304
305
306
307
308
309
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 303

class AssociateFileSystemAliasesRequest < Struct.new(
  :client_request_token,
  :file_system_id,
  :aliases)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_tokenString

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


303
304
305
306
307
308
309
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 303

class AssociateFileSystemAliasesRequest < Struct.new(
  :client_request_token,
  :file_system_id,
  :aliases)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_idString

Specifies the file system with which you want to associate one or more DNS aliases.

Returns:

  • (String)


303
304
305
306
307
308
309
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 303

class AssociateFileSystemAliasesRequest < Struct.new(
  :client_request_token,
  :file_system_id,
  :aliases)
  SENSITIVE = []
  include Aws::Structure
end