Class: Aws::QuickSight::Types::WebCrawlerParameters

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::WebCrawlerParameters

Defined in:

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

Overview

The parameters for a web crawler data source.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #login_page_url ⇒ String

  The URL of the login page for the web crawler to authenticate.

• #password_button_xpath ⇒ String

  The XPath expression for locating the password submit button on the login page.

• #password_field_xpath ⇒ String

  The XPath expression for locating the password field on the login page.

• #username_button_xpath ⇒ String

  The XPath expression for locating the username submit button on the login page.

• #username_field_xpath ⇒ String

  The XPath expression for locating the username field on the login page.

• #web_crawler_auth_type ⇒ String

  The authentication type for the web crawler.

• #web_proxy_host_name ⇒ String

  The hostname of the web proxy server for the web crawler.

• #web_proxy_port_number ⇒ Integer

  The port number of the web proxy server for the web crawler.

Instance Attribute Details

#login_page_url ⇒ String

The URL of the login page for the web crawler to authenticate.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 41908

class WebCrawlerParameters < Struct.new(
  :web_crawler_auth_type,
  :username_field_xpath,
  :password_field_xpath,
  :username_button_xpath,
  :password_button_xpath,
  :login_page_url,
  :web_proxy_host_name,
  :web_proxy_port_number)
  SENSITIVE = []
  include Aws::Structure
end

#password_button_xpath ⇒ String

The XPath expression for locating the password submit button on the login page.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 41908

class WebCrawlerParameters < Struct.new(
  :web_crawler_auth_type,
  :username_field_xpath,
  :password_field_xpath,
  :username_button_xpath,
  :password_button_xpath,
  :login_page_url,
  :web_proxy_host_name,
  :web_proxy_port_number)
  SENSITIVE = []
  include Aws::Structure
end

#password_field_xpath ⇒ String

The XPath expression for locating the password field on the login page.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 41908

class WebCrawlerParameters < Struct.new(
  :web_crawler_auth_type,
  :username_field_xpath,
  :password_field_xpath,
  :username_button_xpath,
  :password_button_xpath,
  :login_page_url,
  :web_proxy_host_name,
  :web_proxy_port_number)
  SENSITIVE = []
  include Aws::Structure
end

#username_button_xpath ⇒ String

The XPath expression for locating the username submit button on the login page.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 41908

class WebCrawlerParameters < Struct.new(
  :web_crawler_auth_type,
  :username_field_xpath,
  :password_field_xpath,
  :username_button_xpath,
  :password_button_xpath,
  :login_page_url,
  :web_proxy_host_name,
  :web_proxy_port_number)
  SENSITIVE = []
  include Aws::Structure
end

#username_field_xpath ⇒ String

The XPath expression for locating the username field on the login page.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 41908

class WebCrawlerParameters < Struct.new(
  :web_crawler_auth_type,
  :username_field_xpath,
  :password_field_xpath,
  :username_button_xpath,
  :password_button_xpath,
  :login_page_url,
  :web_proxy_host_name,
  :web_proxy_port_number)
  SENSITIVE = []
  include Aws::Structure
end

#web_crawler_auth_type ⇒ String

The authentication type for the web crawler. The type can be one of the following:

• NO_AUTH: No authentication required.

• BASIC_AUTH: Basic authentication using username and password.

• SAML: SAML-based authentication.

• FORM: Form-based authentication.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 41908

class WebCrawlerParameters < Struct.new(
  :web_crawler_auth_type,
  :username_field_xpath,
  :password_field_xpath,
  :username_button_xpath,
  :password_button_xpath,
  :login_page_url,
  :web_proxy_host_name,
  :web_proxy_port_number)
  SENSITIVE = []
  include Aws::Structure
end

#web_proxy_host_name ⇒ String

The hostname of the web proxy server for the web crawler.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 41908

class WebCrawlerParameters < Struct.new(
  :web_crawler_auth_type,
  :username_field_xpath,
  :password_field_xpath,
  :username_button_xpath,
  :password_button_xpath,
  :login_page_url,
  :web_proxy_host_name,
  :web_proxy_port_number)
  SENSITIVE = []
  include Aws::Structure
end

#web_proxy_port_number ⇒ Integer

The port number of the web proxy server for the web crawler.

Returns:

• (Integer)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 41908

class WebCrawlerParameters < Struct.new(
  :web_crawler_auth_type,
  :username_field_xpath,
  :password_field_xpath,
  :username_button_xpath,
  :password_button_xpath,
  :login_page_url,
  :web_proxy_host_name,
  :web_proxy_port_number)
  SENSITIVE = []
  include Aws::Structure
end