AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Glue::Crawler

CfnCrawler

The `AWS::Glue::Crawler` resource specifies an AWS Glue crawler. For more information, see [Cataloging Tables with a Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html) and [Crawler Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-crawler-crawling.html#aws-glue-api-crawler-crawling-Crawler) in the *AWS Glue Developer Guide* .

Import

import { CfnCrawler } from 'aws-cdk-lib/aws-glue';

Or use the module namespace:

import * as glue from 'aws-cdk-lib/aws-glue';
// glue.CfnCrawler

Properties

Configuration passed to the constructor as CfnCrawlerProps.

roleRequired
string | IRoleRef

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.

targetsRequired
IResolvable | TargetsProperty

A collection of targets to crawl.

classifiersOptional
string[]

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

configurationOptional
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](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html) .

crawlerSecurityConfigurationOptional
string

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

databaseNameOptional
string | IBucketRef

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

descriptionOptional
string

A description of the crawler.

lakeFormationConfigurationOptional
IResolvable | LakeFormationConfigurationProperty

Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.

nameOptional
string

The name of the crawler.

recrawlPolicyOptional
IResolvable | RecrawlPolicyProperty

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

scheduleOptional
IResolvable | ScheduleProperty

For scheduled crawlers, the schedule when the crawler runs.

schemaChangePolicyOptional
IResolvable | SchemaChangePolicyProperty

The policy that specifies update and delete behaviors for the crawler. The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl. The `SchemaChangePolicy` does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of the `SchemaChangePolicy` on a crawler. The SchemaChangePolicy consists of two components, `UpdateBehavior` and `DeleteBehavior` .

tablePrefixOptional
string

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

tagsOptional
any

The tags to use with this crawler.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter