Class: Aws::Glue::Types::CreateCrawlerRequest

Inherits:

Struct

Object
Struct
Aws::Glue::Types::CreateCrawlerRequest

show all

Defined in:: gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#catalog_id ⇒ String
The ID of the Data Catalog in which to store the crawler's output.
#classifiers ⇒ Array<String>
A list of custom classifiers that the user has registered.
#configuration ⇒ String
Crawler configuration information.
#crawler_security_configuration ⇒ String
The name of the SecurityConfiguration structure to be used by this crawler.
#database_name ⇒ String
The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
#description ⇒ String
A description of the new crawler.
#lake_formation_configuration ⇒ Types::LakeFormationConfiguration
Specifies Lake Formation configuration settings for the crawler.
#lineage_configuration ⇒ Types::LineageConfiguration
Specifies data lineage configuration settings for the crawler.
#name ⇒ String
Name of the new 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.
#role ⇒ String
The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
#schedule ⇒ String
A cron expression used to specify the schedule (see [Time-Based Schedules for Jobs and Crawlers][1]. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).
#schema_change_policy ⇒ Types::SchemaChangePolicy
The policy for the crawler's update and deletion behavior.
#table_prefix ⇒ String
The table prefix used for catalog tables that are created.
#tags ⇒ Hash<String,String>
The tags to use with this crawler request.
#targets ⇒ Types::CrawlerTargets
A list of collection of targets to crawl.

Instance Attribute Details

#catalog_id ⇒ `String`

The ID of the Data Catalog in which to store the crawler's output. If none is supplied, the Amazon Web Services account ID is used by default.

Returns:

(String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#classifiers ⇒ `Array<String>`

A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

Returns:

(Array<String>)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#crawler_security_configuration ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ `String`

The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

Returns:

(String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description of the new crawler.

Returns:

(String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#lake_formation_configuration ⇒ `Types::LakeFormationConfiguration`

Specifies Lake Formation configuration settings for the crawler.

Returns:

(Types::LakeFormationConfiguration)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#lineage_configuration ⇒ `Types::LineageConfiguration`

Specifies data lineage configuration settings for the crawler.

Returns:

(Types::LineageConfiguration)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

Name of the new crawler.

Returns:

(String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ `String`

The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.

Returns:

(String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ `String`

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

Returns:

(String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#schema_change_policy ⇒ `Types::SchemaChangePolicy`

The policy for the crawler's update and deletion behavior.

Returns:

(Types::SchemaChangePolicy)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#table_prefix ⇒ `String`

The table prefix used for catalog tables that are created.

Returns:

(String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#targets ⇒ `Types::CrawlerTargets`

A list of collection of targets to crawl.

Returns:

(Types::CrawlerTargets)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 5891

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy,
  :recrawl_policy,
  :lineage_configuration,
  :lake_formation_configuration,
  :configuration,
  :crawler_security_configuration,
  :tags,
  :catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Glue::Types::CreateCrawlerRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_id ⇒ String

#classifiers ⇒ Array<String>

#configuration ⇒ String

#crawler_security_configuration ⇒ String

#database_name ⇒ String

#description ⇒ String

#lake_formation_configuration ⇒ Types::LakeFormationConfiguration

#lineage_configuration ⇒ Types::LineageConfiguration

#name ⇒ String

#recrawl_policy ⇒ Types::RecrawlPolicy

#role ⇒ String

#schedule ⇒ String

#schema_change_policy ⇒ Types::SchemaChangePolicy

#table_prefix ⇒ String

#tags ⇒ Hash<String,String>

#targets ⇒ Types::CrawlerTargets

#catalog_id ⇒ `String`

#classifiers ⇒ `Array<String>`

#configuration ⇒ `String`

#crawler_security_configuration ⇒ `String`

#database_name ⇒ `String`

#description ⇒ `String`

#lake_formation_configuration ⇒ `Types::LakeFormationConfiguration`

#lineage_configuration ⇒ `Types::LineageConfiguration`

#name ⇒ `String`

#recrawl_policy ⇒ `Types::RecrawlPolicy`

#role ⇒ `String`

#schedule ⇒ `String`

#schema_change_policy ⇒ `Types::SchemaChangePolicy`

#table_prefix ⇒ `String`

#tags ⇒ `Hash<String,String>`

#targets ⇒ `Types::CrawlerTargets`