Class: Aws::FSx::Types::DescribeFileSystemAliasesRequest

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::DescribeFileSystemAliasesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-fsx/types.rb

Overview

The request object for ‘DescribeFileSystemAliases` operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters.

• #file_system_id ⇒ String

  The ID of the file system to return the associated DNS aliases for (String).

• #max_results ⇒ Integer

  Maximum number of DNS aliases to return in the response (integer).

• #next_token ⇒ String

  Opaque pagination token returned from a previous ‘DescribeFileSystemAliases` operation (String).

Instance Attribute Details

#client_request_token ⇒ String

(Optional) An idempotency token for resource creation, in a string of up to 63 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)

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

class DescribeFileSystemAliasesRequest < Struct.new(
  :client_request_token,
  :file_system_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_id ⇒ String

The ID of the file system to return the associated DNS aliases for (String).

Returns:

• (String)

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

class DescribeFileSystemAliasesRequest < Struct.new(
  :client_request_token,
  :file_system_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the ‘MaxResults` parameter specified in the request and the service’s internal maximum number of items per page.

Returns:

• (Integer)

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

class DescribeFileSystemAliasesRequest < Struct.new(
  :client_request_token,
  :file_system_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

Opaque pagination token returned from a previous ‘DescribeFileSystemAliases` operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.

Returns:

• (String)

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

class DescribeFileSystemAliasesRequest < Struct.new(
  :client_request_token,
  :file_system_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end