Interface CfnCrawlerProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCrawlerProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
date="2025-10-14T12:28:11.743Z")
@Stability(Stable)
public interface CfnCrawlerProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnCrawler.
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;
CfnCrawlerProps cfnCrawlerProps = CfnCrawlerProps.builder()
.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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnCrawlerPropsstatic final classAn implementation forCfnCrawlerProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnCrawlerProps.Builderbuilder()A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.default StringCrawler configuration information.default StringThe name of theSecurityConfigurationstructure to be used by this crawler.default StringThe name of the database in which the crawler's output is stored.default StringA description of the crawler.default ObjectSpecifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.default StringgetName()The name of the crawler.default ObjectA policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.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.default ObjectFor scheduled crawlers, the schedule when the crawler runs.default ObjectThe policy that specifies update and delete behaviors for the crawler.default StringThe prefix added to the names of tables that are created.default ObjectgetTags()The tags to use with this crawler.A collection of targets to crawl.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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.- See Also:
-
getTargets
A collection of targets to crawl.- See Also:
-
getClassifiers
A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.- See Also:
-
getConfiguration
Crawler configuration information.This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler .
- See Also:
-
getCrawlerSecurityConfiguration
The name of theSecurityConfigurationstructure to be used by this crawler.- See Also:
-
getDatabaseName
The name of the database in which the crawler's output is stored.- See Also:
-
getDescription
A description of the crawler.- See Also:
-
getLakeFormationConfiguration
Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.- See Also:
-
getName
The name of the crawler.- See Also:
-
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.- See Also:
-
getSchedule
For scheduled crawlers, the schedule when the crawler runs.- See Also:
-
getSchemaChangePolicy
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
SchemaChangePolicydoes not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of theSchemaChangePolicyon a crawler.The SchemaChangePolicy consists of two components,
UpdateBehaviorandDeleteBehavior.- See Also:
-
getTablePrefix
The prefix added to the names of tables that are created.- See Also:
-
getTags
The tags to use with this crawler.- See Also:
-
builder
- Returns:
- a
CfnCrawlerProps.BuilderofCfnCrawlerProps
-