Package software.amazon.awscdk.services.glue

Class CfnCrawler

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.glue.CfnCrawler
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:02.413Z") @Stability(Stable) public class CfnCrawler extends CfnResource implements IInspectable, ITaggable
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()))
                 .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:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnCrawlerProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

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

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable String value)
      Crawler configuration information.

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

    • getLakeFormationConfiguration

      @Stability(Stable) @Nullable public Object getLakeFormationConfiguration()
      Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.

    • setLakeFormationConfiguration

      @Stability(Stable) public void setLakeFormationConfiguration(@Nullable IResolvable value)
      Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.

    • setLakeFormationConfiguration

      @Stability(Stable) public void setLakeFormationConfiguration(@Nullable CfnCrawler.LakeFormationConfigurationProperty value)
      Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.

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

    • setSchemaChangePolicy

      @Stability(Stable) public void setSchemaChangePolicy(@Nullable IResolvable value)
      The policy that specifies update and delete behaviors for the crawler.

    • setSchemaChangePolicy

      @Stability(Stable) public void setSchemaChangePolicy(@Nullable CfnCrawler.SchemaChangePolicyProperty value)
      The policy that specifies update and delete behaviors for the crawler.

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

    • getTagsRaw

      @Stability(Stable) @Nullable public Object getTagsRaw()
      The tags to use with this crawler.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      The tags to use with this crawler.