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

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

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

Overview

Note:

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

{
  name: "NameString", # required
  role: "RoleArn", # required
  database_name: "DatabaseName", # required
  description: "DescriptionString",
  targets: { # required
    s3_targets: [
      {
        path: "Path",
        exclusions: ["Path"],
      },
    ],
    jdbc_targets: [
      {
        connection_name: "ConnectionName",
        path: "Path",
        exclusions: ["Path"],
      },
    ],
  },
  schedule: "CronExpression",
  classifiers: ["NameString"],
  table_prefix: "TablePrefix",
  schema_change_policy: {
    update_behavior: "LOG", # accepts LOG, UPDATE_IN_DATABASE
    delete_behavior: "LOG", # accepts LOG, DELETE_FROM_DATABASE, DEPRECATE_IN_DATABASE
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#classifiersArray<String>

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

Returns:

  • (Array<String>)


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1023

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy)
  include Aws::Structure
end

#database_nameString

The Glue Database where results will be stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.

Returns:

  • (String)


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1023

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy)
  include Aws::Structure
end

#descriptionString

A description of the new Crawler.

Returns:

  • (String)


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1023

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy)
  include Aws::Structure
end

#nameString

Name of the new Crawler.

Returns:

  • (String)


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1023

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy)
  include Aws::Structure
end

#roleString

The AWS ARN of the IAM role used by the new Crawler to access customer resources.

Returns:

  • (String)


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1023

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy)
  include Aws::Structure
end

#scheduleString

A cron expression that can be used as a Cloudwatch event (see CloudWatch Schedule Expression Syntax. For example, to run every day at 12:15 UTC, specify: cron(15 12 * * ? *).

Returns:

  • (String)


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1023

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy)
  include Aws::Structure
end

#schema_change_policyTypes::SchemaChangePolicy

Policy for the crawler's update and deletion behavior.



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1023

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy)
  include Aws::Structure
end

#table_prefixString

The table prefix used for catalog tables created.

Returns:

  • (String)


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1023

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy)
  include Aws::Structure
end

#targetsTypes::CrawlerTargets

A list of collection of targets to crawl.



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1023

class CreateCrawlerRequest < Struct.new(
  :name,
  :role,
  :database_name,
  :description,
  :targets,
  :schedule,
  :classifiers,
  :table_prefix,
  :schema_change_policy)
  include Aws::Structure
end