You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Glue::Types::Crawler

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the AWS Glue Data Catalog.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#classifiers ⇒ Array<String>

A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.

Returns:

  • (Array<String>) —

    A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.

#configuration ⇒ String

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler\'s behavior. For more information, see Configuring a Crawler.

Returns:

  • (String) —

    Crawler configuration information.

#crawl_elapsed_time ⇒ Integer

If the crawler is running, contains the total time elapsed since the last crawl began.

Returns:

  • (Integer) —

    If the crawler is running, contains the total time elapsed since the last crawl began.

#crawler_security_configuration ⇒ String

The name of the SecurityConfiguration structure to be used by this crawler.

Returns:

  • (String) —

    The name of the SecurityConfiguration structure to be used by this crawler.

#creation_time ⇒ Time

The time that the crawler was created.

Returns:

  • (Time) —

    The time that the crawler was created.

#database_name ⇒ String

The name of the database in which the crawler\'s output is stored.

Returns:

  • (String) —

    The name of the database in which the crawler\'s output is stored.

#description ⇒ String

A description of the crawler.

Returns:

  • (String) —

    A description of the crawler.

#last_crawl ⇒ Types::LastCrawlInfo

The status of the last crawl, and potentially error information if an error occurred.

Returns:

  • (Types::LastCrawlInfo) —

    The status of the last crawl, and potentially error information if an error occurred.

#last_updated ⇒ Time

The time that the crawler was last updated.

Returns:

  • (Time) —

    The time that the crawler was last updated.

#name ⇒ String

The name of the crawler.

Returns:

  • (String) —

    The name of the crawler.

#recrawl_policy ⇒ Types::RecrawlPolicy

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

Returns:

  • (Types::RecrawlPolicy) —

    A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

#role ⇒ String

The Amazon Resource Name (ARN) of an IAM role that\'s used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of an IAM role that\'s used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.

#schedule ⇒ Types::Schedule

For scheduled crawlers, the schedule when the crawler runs.

Returns:

  • (Types::Schedule) —

    For scheduled crawlers, the schedule when the crawler runs.

#schema_change_policy ⇒ Types::SchemaChangePolicy

The policy that specifies update and delete behaviors for the crawler.

Returns:

#state ⇒ String

Indicates whether the crawler is running, or whether a run is pending.

Possible values:

  • READY
  • RUNNING
  • STOPPING

Returns:

  • (String) —

    Indicates whether the crawler is running, or whether a run is pending.

#table_prefix ⇒ String

The prefix added to the names of tables that are created.

Returns:

  • (String) —

    The prefix added to the names of tables that are created.

#targets ⇒ Types::CrawlerTargets

A collection of targets to crawl.

Returns:

#version ⇒ Integer

The version of the crawler.

Returns:

  • (Integer) —

    The version of the crawler.