Package 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.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.374Z") @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()))
                 .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();

  • Method Details

    • getRole

      @Stability(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(Stable) @NotNull Object getTargets()
      A collection of targets to crawl.

    • getClassifiers

      @Stability(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(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(Stable) @Nullable default String getCrawlerSecurityConfiguration()
      The name of the SecurityConfiguration structure to be used by this crawler.

    • getDatabaseName

      @Stability(Stable) @Nullable default String getDatabaseName()
      The name of the database in which the crawler's output is stored.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description of the crawler.

    • getName

      @Stability(Stable) @Nullable default String getName()
      The name of the crawler.

    • getRecrawlPolicy

      @Stability(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(Stable) @Nullable default Object getSchedule()
      For scheduled crawlers, the schedule when the crawler runs.

    • getSchemaChangePolicy

      @Stability(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(Stable) @Nullable default String getTablePrefix()
      The prefix added to the names of tables that are created.

    • getTags

      @Stability(Stable) @Nullable default Object getTags()
      The tags to use with this crawler.

    • builder

      @Stability(Stable) static CfnCrawlerProps.Builder builder()
      Returns:
      a CfnCrawlerProps.Builder of CfnCrawlerProps