software.amazon.awscdk.services.glue

Interface CfnCrawlerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCrawlerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.532Z")
 @Stability(value=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()
                         .databaseName("databaseName")
                         .tables(List.of("tables"))
                         .build()))
                 .dynamoDbTargets(List.of(DynamoDBTargetProperty.builder()
                         .path("path")
                         .build()))
                 .jdbcTargets(List.of(JdbcTargetProperty.builder()
                         .connectionName("connectionName")
                         .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")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCrawlerProps.Builder A builder for CfnCrawlerProps
static class	CfnCrawlerProps.Jsii$Proxy An implementation for CfnCrawlerProps

Method Summary

Modifier and Type	Method and Description
static CfnCrawlerProps.Builder	builder()
default List<String>	getClassifiers() A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
default String	getConfiguration() Crawler configuration information.
default String	getCrawlerSecurityConfiguration() The name of the `SecurityConfiguration` structure to be used by this crawler.
default String	getDatabaseName() The name of the database in which the crawler's output is stored.
default String	getDescription() A description of the crawler.
default String	getName() The name of the crawler.
default 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.
default Object	getSchedule() For scheduled crawlers, the schedule when the crawler runs.
default Object	getSchemaChangePolicy() The policy that specifies update and delete behaviors for the crawler.
default String	getTablePrefix() The prefix added to the names of tables that are created.
default Object	getTags() The tags to use with this crawler.
Object	getTargets() A collection of targets to crawl.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRole

@Stability(value=Stable)
 @NotNull
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.

getTargets

@Stability(value=Stable)
 @NotNull
Object getTargets()

A collection of targets to crawl.

getClassifiers

@Stability(value=Stable)
 @Nullable
default List<String> getClassifiers()

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

getConfiguration

@Stability(value=Stable)
 @Nullable
default String 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 .

getCrawlerSecurityConfiguration

@Stability(value=Stable)
 @Nullable
default String getCrawlerSecurityConfiguration()

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

getDatabaseName

@Stability(value=Stable)
 @Nullable
default String getDatabaseName()

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

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the crawler.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

The name of the crawler.

getRecrawlPolicy

@Stability(value=Stable)
 @Nullable
default 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.

getSchedule

@Stability(value=Stable)
 @Nullable
default Object getSchedule()

For scheduled crawlers, the schedule when the crawler runs.

getSchemaChangePolicy

@Stability(value=Stable)
 @Nullable
default Object 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 the SchemaChangePolicy on a crawler.

The SchemaChangePolicy consists of two components, UpdateBehavior and DeleteBehavior .

getTablePrefix

@Stability(value=Stable)
 @Nullable
default String getTablePrefix()

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

getTags

@Stability(value=Stable)
 @Nullable
default Object getTags()

The tags to use with this crawler.

builder

@Stability(value=Stable)
static CfnCrawlerProps.Builder builder()

Returns:

a CfnCrawlerProps.Builder of CfnCrawlerProps