Package software.amazon.awscdk.services.glue

Class CfnCrawler

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.glue.CfnCrawler
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.359Z") @Stability(Stable) public class CfnCrawler extends CfnResource implements IInspectable
A CloudFormation AWS::Glue::Crawler.

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")
                         .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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags to use with this crawler.

    • 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.

    • 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.

      This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler .

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable String value)
      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 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.

    • 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.

    • 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.

    • 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.

      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 .

    • setSchemaChangePolicy

      @Stability(Stable) public void setSchemaChangePolicy(@Nullable IResolvable value)
      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 .

    • setSchemaChangePolicy

      @Stability(Stable) public void setSchemaChangePolicy(@Nullable CfnCrawler.SchemaChangePolicyProperty value)
      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 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.