Class: Aws::DataSync::Types::CreateLocationFsxWindowsRequest

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

Overview

Note:

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

{
  subdirectory: "FsxWindowsSubdirectory",
  fsx_filesystem_arn: "FsxFilesystemArn", # required
  security_group_arns: ["Ec2SecurityGroupArn"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  user: "SmbUser", # required
  domain: "SmbDomain",
  password: "SmbPassword", # required
}

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#domainString

The name of the Windows domain that the FSx for Windows File Server belongs to.

Returns:

  • (String)


341
342
343
344
345
346
347
348
349
350
351
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 341

class CreateLocationFsxWindowsRequest < Struct.new(
  :subdirectory,
  :fsx_filesystem_arn,
  :security_group_arns,
  :tags,
  :user,
  :domain,
  :password)
  SENSITIVE = [:password]
  include Aws::Structure
end

#fsx_filesystem_arnString

The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

Returns:

  • (String)


341
342
343
344
345
346
347
348
349
350
351
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 341

class CreateLocationFsxWindowsRequest < Struct.new(
  :subdirectory,
  :fsx_filesystem_arn,
  :security_group_arns,
  :tags,
  :user,
  :domain,
  :password)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.

Returns:

  • (String)


341
342
343
344
345
346
347
348
349
350
351
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 341

class CreateLocationFsxWindowsRequest < Struct.new(
  :subdirectory,
  :fsx_filesystem_arn,
  :security_group_arns,
  :tags,
  :user,
  :domain,
  :password)
  SENSITIVE = [:password]
  include Aws::Structure
end

#security_group_arnsArray<String>

The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows File Server file system.

Returns:

  • (Array<String>)


341
342
343
344
345
346
347
348
349
350
351
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 341

class CreateLocationFsxWindowsRequest < Struct.new(
  :subdirectory,
  :fsx_filesystem_arn,
  :security_group_arns,
  :tags,
  :user,
  :domain,
  :password)
  SENSITIVE = [:password]
  include Aws::Structure
end

#subdirectoryString

A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.

Returns:

  • (String)


341
342
343
344
345
346
347
348
349
350
351
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 341

class CreateLocationFsxWindowsRequest < Struct.new(
  :subdirectory,
  :fsx_filesystem_arn,
  :security_group_arns,
  :tags,
  :user,
  :domain,
  :password)
  SENSITIVE = [:password]
  include Aws::Structure
end

#tagsArray<Types::TagListEntry>

The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

Returns:



341
342
343
344
345
346
347
348
349
350
351
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 341

class CreateLocationFsxWindowsRequest < Struct.new(
  :subdirectory,
  :fsx_filesystem_arn,
  :security_group_arns,
  :tags,
  :user,
  :domain,
  :password)
  SENSITIVE = [:password]
  include Aws::Structure
end

#userString

The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Returns:

  • (String)


341
342
343
344
345
346
347
348
349
350
351
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 341

class CreateLocationFsxWindowsRequest < Struct.new(
  :subdirectory,
  :fsx_filesystem_arn,
  :security_group_arns,
  :tags,
  :user,
  :domain,
  :password)
  SENSITIVE = [:password]
  include Aws::Structure
end