Interface CfnCrawlerProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCrawlerProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-22T02:24:02.420Z")
@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") .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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnCrawlerProps
static final class
An implementation forCfnCrawlerProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnCrawlerProps.Builder
builder()
A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.default String
Crawler configuration information.default String
The name of theSecurityConfiguration
structure to be used by this crawler.default String
The name of the database in which the crawler's output is stored.default String
A description of the crawler.default Object
Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.default String
getName()
The name of the crawler.default Object
A 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 Object
For scheduled crawlers, the schedule when the crawler runs.default Object
The policy that specifies update and delete behaviors for the crawler.default String
The prefix added to the names of tables that are created.default Object
getTags()
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 theSecurityConfiguration
structure 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
SchemaChangePolicy
does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of theSchemaChangePolicy
on a crawler.The SchemaChangePolicy consists of two components,
UpdateBehavior
andDeleteBehavior
.- 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.Builder
ofCfnCrawlerProps
-