Package software.amazon.awscdk.services.glue

Class CfnCrawler

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.glue.CfnCrawler

All Implemented Interfaces:

IInspectable, ICrawlerRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:37.463Z")
@Stability(Stable)
public class CfnCrawler
extends CfnResource
implements IInspectable, ICrawlerRef, ITaggable

The AWS::Glue::Crawler resource specifies an AWS Glue crawler.

For more information, see Cataloging Tables with a Crawler and Crawler Structure in the AWS Glue Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 Object tags;
 CfnCrawler cfnCrawler = CfnCrawler.Builder.create(this, "MyCfnCrawler")
         .role("role")
         .targets(TargetsProperty.builder()
                 .catalogTargets(List.of(CatalogTargetProperty.builder()
                         .connectionName("connectionName")
                         .databaseName("databaseName")
                         .dlqEventQueueArn("dlqEventQueueArn")
                         .eventQueueArn("eventQueueArn")
                         .tables(List.of("tables"))
                         .build()))
                 .deltaTargets(List.of(DeltaTargetProperty.builder()
                         .connectionName("connectionName")
                         .createNativeDeltaTable(false)
                         .deltaTables(List.of("deltaTables"))
                         .writeManifest(false)
                         .build()))
                 .dynamoDbTargets(List.of(DynamoDBTargetProperty.builder()
                         .path("path")
                         .scanAll(false)
                         .scanRate(123)
                         .build()))
                 .hudiTargets(List.of(HudiTargetProperty.builder()
                         .connectionName("connectionName")
                         .exclusions(List.of("exclusions"))
                         .maximumTraversalDepth(123)
                         .paths(List.of("paths"))
                         .build()))
                 .icebergTargets(List.of(IcebergTargetProperty.builder()
                         .connectionName("connectionName")
                         .exclusions(List.of("exclusions"))
                         .maximumTraversalDepth(123)
                         .paths(List.of("paths"))
                         .build()))
                 .jdbcTargets(List.of(JdbcTargetProperty.builder()
                         .connectionName("connectionName")
                         .enableAdditionalMetadata(List.of("enableAdditionalMetadata"))
                         .exclusions(List.of("exclusions"))
                         .path("path")
                         .build()))
                 .mongoDbTargets(List.of(MongoDBTargetProperty.builder()
                         .connectionName("connectionName")
                         .path("path")
                         .build()))
                 .s3Targets(List.of(S3TargetProperty.builder()
                         .connectionName("connectionName")
                         .dlqEventQueueArn("dlqEventQueueArn")
                         .eventQueueArn("eventQueueArn")
                         .exclusions(List.of("exclusions"))
                         .path("path")
                         .sampleSize(123)
                         .build()))
                 .build())
         // the properties below are optional
         .classifiers(List.of("classifiers"))
         .configuration("configuration")
         .crawlerSecurityConfiguration("crawlerSecurityConfiguration")
         .databaseName("databaseName")
         .description("description")
         .lakeFormationConfiguration(LakeFormationConfigurationProperty.builder()
                 .accountId("accountId")
                 .useLakeFormationCredentials(false)
                 .build())
         .name("name")
         .recrawlPolicy(RecrawlPolicyProperty.builder()
                 .recrawlBehavior("recrawlBehavior")
                 .build())
         .schedule(ScheduleProperty.builder()
                 .scheduleExpression("scheduleExpression")
                 .build())
         .schemaChangePolicy(SchemaChangePolicyProperty.builder()
                 .deleteBehavior("deleteBehavior")
                 .updateBehavior("updateBehavior")
                 .build())
         .tablePrefix("tablePrefix")
         .tags(tags)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnCrawler.Builder	A fluent builder for CfnCrawler.
static interface	CfnCrawler.CatalogTargetProperty	Specifies an AWS Glue Data Catalog target.
static interface	CfnCrawler.DeltaTargetProperty	Specifies a Delta data store to crawl one or more Delta tables.
static interface	CfnCrawler.DynamoDBTargetProperty	Specifies an Amazon DynamoDB table to crawl.
static interface	CfnCrawler.HudiTargetProperty	Specifies an Apache Hudi data source.
static interface	CfnCrawler.IcebergTargetProperty	Specifies Apache Iceberg data store targets.
static interface	CfnCrawler.JdbcTargetProperty	Specifies a JDBC data store to crawl.
static interface	CfnCrawler.LakeFormationConfigurationProperty	Specifies AWS Lake Formation configuration settings for the crawler.
static interface	CfnCrawler.MongoDBTargetProperty	Specifies an Amazon DocumentDB or MongoDB data store to crawl.
static interface	CfnCrawler.RecrawlPolicyProperty	When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
static interface	CfnCrawler.S3TargetProperty	Specifies a data store in Amazon Simple Storage Service (Amazon S3).
static interface	CfnCrawler.ScheduleProperty	A scheduling object using a cron statement to schedule an event.
static interface	CfnCrawler.SchemaChangePolicyProperty	The policy that specifies update and delete behaviors for the crawler.
static interface	CfnCrawler.TargetsProperty	Specifies data stores to crawl.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.glue.ICrawlerRef

ICrawlerRef.Jsii$Default, ICrawlerRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnCrawler(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCrawler(software.amazon.jsii.JsiiObjectRef objRef)
	CfnCrawler(software.constructs.Construct scope, String id, CfnCrawlerProps props)	Create a new AWS::Glue::Crawler.

Method Summary

Modifier and Type	Method	Description
static String	arnForCrawler(ICrawlerRef resource)
static ICrawlerRef	fromCrawlerName(software.constructs.Construct scope, String id, String crawlerName)	Creates a new ICrawlerRef from a crawlerName.
protected Map<String,Object>	getCfnProperties()
List<String>	getClassifiers()	A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
String	getConfiguration()	Crawler configuration information.
CrawlerReference	getCrawlerRef()	A reference to a Crawler resource.
String	getCrawlerSecurityConfiguration()	The name of the SecurityConfiguration structure to be used by this crawler.
String	getDatabaseName()	The name of the database in which the crawler's output is stored.
String	getDescription()	A description of the crawler.
Object	getLakeFormationConfiguration()	Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.
String	getName()	The name of the crawler.
Object	getRecrawlPolicy()	A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
String	getRole()	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.
Object	getSchedule()	For scheduled crawlers, the schedule when the crawler runs.
Object	getSchemaChangePolicy()	The policy that specifies update and delete behaviors for the crawler.
String	getTablePrefix()	The prefix added to the names of tables that are created.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
Object	getTagsRaw()	The tags to use with this crawler.
Object	getTargets()	A collection of targets to crawl.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnCrawler(Object x)	Checks whether the given object is a CfnCrawler.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setClassifiers(List<String> value)	A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
void	setConfiguration(String value)	Crawler configuration information.
void	setCrawlerSecurityConfiguration(String value)	The name of the SecurityConfiguration structure to be used by this crawler.
void	setDatabaseName(String value)	The name of the database in which the crawler's output is stored.
void	setDescription(String value)	A description of the crawler.
void	setLakeFormationConfiguration(IResolvable value)	Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.
void	setLakeFormationConfiguration(CfnCrawler.LakeFormationConfigurationProperty value)	Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.
void	setName(String value)	The name of the crawler.
void	setRecrawlPolicy(IResolvable value)	A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
void	setRecrawlPolicy(CfnCrawler.RecrawlPolicyProperty value)	A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
void	setRole(String value)	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.
void	setSchedule(IResolvable value)	For scheduled crawlers, the schedule when the crawler runs.
void	setSchedule(CfnCrawler.ScheduleProperty value)	For scheduled crawlers, the schedule when the crawler runs.
void	setSchemaChangePolicy(IResolvable value)	The policy that specifies update and delete behaviors for the crawler.
void	setSchemaChangePolicy(CfnCrawler.SchemaChangePolicyProperty value)	The policy that specifies update and delete behaviors for the crawler.
void	setTablePrefix(String value)	The prefix added to the names of tables that are created.
void	setTagsRaw(Object value)	The tags to use with this crawler.
void	setTargets(IResolvable value)	A collection of targets to crawl.
void	setTargets(CfnCrawler.TargetsProperty value)	A collection of targets to crawl.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnCrawler

protected CfnCrawler(software.amazon.jsii.JsiiObjectRef objRef)

CfnCrawler

protected CfnCrawler(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCrawler

@Stability(Stable)
public CfnCrawler(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnCrawlerProps props)

Create a new AWS::Glue::Crawler.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForCrawler

@Stability(Stable)
@NotNull
public static String arnForCrawler(@NotNull
 ICrawlerRef resource)

Parameters:

resource - This parameter is required.

fromCrawlerName

@Stability(Stable)
@NotNull
public static ICrawlerRef fromCrawlerName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String crawlerName)

Creates a new ICrawlerRef from a crawlerName.

Parameters:

scope - This parameter is required.

id - This parameter is required.

crawlerName - This parameter is required.

isCfnCrawler

@Stability(Stable)
@NotNull
public static Boolean isCfnCrawler(@NotNull
 Object x)

Checks whether the given object is a CfnCrawler.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCrawlerRef

@Stability(Stable)
@NotNull
public CrawlerReference getCrawlerRef()

A reference to a Crawler resource.

Specified by:

getCrawlerRef in interface ICrawlerRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getRole

@Stability(Stable)
@NotNull
public String getRole()

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.

setRole

@Stability(Stable)
public void setRole(@NotNull
 String value)

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.

getTargets

@Stability(Stable)
@NotNull
public Object getTargets()

A collection of targets to crawl.

Returns union: either IResolvable or CfnCrawler.TargetsProperty

setTargets

@Stability(Stable)
public void setTargets(@NotNull
 IResolvable value)

A collection of targets to crawl.

setTargets

@Stability(Stable)
public void setTargets(@NotNull
 CfnCrawler.TargetsProperty value)

A collection of targets to crawl.

getClassifiers

@Stability(Stable)
@Nullable
public List<String> getClassifiers()

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

setClassifiers

@Stability(Stable)
public void setClassifiers(@Nullable
 List<String> value)

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

getConfiguration

@Stability(Stable)
@Nullable
public String getConfiguration()

Crawler configuration information.

setConfiguration

@Stability(Stable)
public void setConfiguration(@Nullable
 String value)

Crawler configuration information.

getCrawlerSecurityConfiguration

@Stability(Stable)
@Nullable
public String getCrawlerSecurityConfiguration()

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

setCrawlerSecurityConfiguration

@Stability(Stable)
public void setCrawlerSecurityConfiguration(@Nullable
 String value)

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

getDatabaseName

@Stability(Stable)
@Nullable
public String getDatabaseName()

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

setDatabaseName

@Stability(Stable)
public void setDatabaseName(@Nullable
 String value)

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

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

A description of the crawler.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A description of the crawler.

getLakeFormationConfiguration

@Stability(Stable)
@Nullable
public Object getLakeFormationConfiguration()

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

Returns union: either IResolvable or CfnCrawler.LakeFormationConfigurationProperty

setLakeFormationConfiguration

@Stability(Stable)
public void setLakeFormationConfiguration(@Nullable
 IResolvable value)

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

setLakeFormationConfiguration

@Stability(Stable)
public void setLakeFormationConfiguration(@Nullable
 CfnCrawler.LakeFormationConfigurationProperty value)

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

getName

@Stability(Stable)
@Nullable
public String getName()

The name of the crawler.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name of the crawler.

getRecrawlPolicy

@Stability(Stable)
@Nullable
public Object getRecrawlPolicy()

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 union: either IResolvable or CfnCrawler.RecrawlPolicyProperty

setRecrawlPolicy

@Stability(Stable)
public void setRecrawlPolicy(@Nullable
 IResolvable value)

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

setRecrawlPolicy

@Stability(Stable)
public void setRecrawlPolicy(@Nullable
 CfnCrawler.RecrawlPolicyProperty value)

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

getSchedule

@Stability(Stable)
@Nullable
public Object getSchedule()

For scheduled crawlers, the schedule when the crawler runs.

Returns union: either IResolvable or CfnCrawler.ScheduleProperty

setSchedule

@Stability(Stable)
public void setSchedule(@Nullable
 IResolvable value)

For scheduled crawlers, the schedule when the crawler runs.

setSchedule

@Stability(Stable)
public void setSchedule(@Nullable
 CfnCrawler.ScheduleProperty value)

For scheduled crawlers, the schedule when the crawler runs.

getSchemaChangePolicy

@Stability(Stable)
@Nullable
public Object getSchemaChangePolicy()

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

Returns union: either IResolvable or CfnCrawler.SchemaChangePolicyProperty

setSchemaChangePolicy

@Stability(Stable)
public void setSchemaChangePolicy(@Nullable
 IResolvable value)

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

setSchemaChangePolicy

@Stability(Stable)
public void setSchemaChangePolicy(@Nullable
 CfnCrawler.SchemaChangePolicyProperty value)

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

getTablePrefix

@Stability(Stable)
@Nullable
public String getTablePrefix()

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

setTablePrefix

@Stability(Stable)
public void setTablePrefix(@Nullable
 String value)

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

getTagsRaw

@Stability(Stable)
@Nullable
public Object getTagsRaw()

The tags to use with this crawler.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 Object value)

The tags to use with this crawler.