CfnCrawler

java.lang.Object
- 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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:31.148Z")
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()
                         .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	Class and Description
`static class`	`CfnCrawler.Builder` A fluent builder for `CfnCrawler`.
`static interface`	`CfnCrawler.CatalogTargetProperty` Specifies an AWS Glue Data Catalog target.
`static interface`	`CfnCrawler.DynamoDBTargetProperty` Specifies an Amazon DynamoDB table to crawl.
`static interface`	`CfnCrawler.JdbcTargetProperty` Specifies a JDBC data store to crawl.
`static interface`	`CfnCrawler.MongoDBTargetProperty` Specifies an Amazon DocumentDB or MongoDB data store to crawl.
`static interface`	`CfnCrawler.RecrawlPolicyProperty` When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
`static interface`	`CfnCrawler.S3TargetProperty` Specifies a data store in Amazon Simple Storage Service (Amazon S3).
`static interface`	`CfnCrawler.ScheduleProperty` A scheduling object using a `cron` statement to schedule an event.
`static interface`	`CfnCrawler.SchemaChangePolicyProperty` The policy that specifies update and delete behaviors for the crawler.
`static interface`	`CfnCrawler.TargetsProperty` Specifies data stores to crawl.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnCrawler(Construct scope, java.lang.String id, CfnCrawlerProps props)` Create a new `AWS::Glue::Crawler`.
`protected`	`CfnCrawler(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnCrawler(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.util.List<java.lang.String>`	`getClassifiers()` A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
`java.lang.String`	`getConfiguration()` Crawler configuration information.
`java.lang.String`	`getCrawlerSecurityConfiguration()` The name of the `SecurityConfiguration` structure to be used by this crawler.
`java.lang.String`	`getDatabaseName()` The name of the database in which the crawler's output is stored.
`java.lang.String`	`getDescription()` A description of the crawler.
`java.lang.String`	`getName()` The name of the crawler.
`java.lang.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.
`java.lang.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.
`java.lang.Object`	`getSchedule()` For scheduled crawlers, the schedule when the crawler runs.
`java.lang.Object`	`getSchemaChangePolicy()` The policy that specifies update and delete behaviors for the crawler.
`java.lang.String`	`getTablePrefix()` The prefix added to the names of tables that are created.
`TagManager`	`getTags()` The tags to use with this crawler.
`java.lang.Object`	`getTargets()` A collection of targets to crawl.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setClassifiers(java.util.List<java.lang.String> value)` A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
`void`	`setConfiguration(java.lang.String value)` Crawler configuration information.
`void`	`setCrawlerSecurityConfiguration(java.lang.String value)` The name of the `SecurityConfiguration` structure to be used by this crawler.
`void`	`setDatabaseName(java.lang.String value)` The name of the database in which the crawler's output is stored.
`void`	`setDescription(java.lang.String value)` A description of the crawler.
`void`	`setName(java.lang.String value)` The name of the crawler.
`void`	`setRecrawlPolicy(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.
`void`	`setRecrawlPolicy(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.
`void`	`setRole(java.lang.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.
`void`	`setSchedule(CfnCrawler.ScheduleProperty value)` For scheduled crawlers, the schedule when the crawler runs.
`void`	`setSchedule(IResolvable value)` For scheduled crawlers, the schedule when the crawler runs.
`void`	`setSchemaChangePolicy(CfnCrawler.SchemaChangePolicyProperty value)` The policy that specifies update and delete behaviors for the crawler.
`void`	`setSchemaChangePolicy(IResolvable value)` The policy that specifies update and delete behaviors for the crawler.
`void`	`setTablePrefix(java.lang.String value)` The prefix added to the names of tables that are created.
`void`	`setTargets(CfnCrawler.TargetsProperty value)` A collection of targets to crawl.
`void`	`setTargets(IResolvable value)` A collection of targets to crawl.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnCrawler
```
protected CfnCrawler(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnCrawler
```
protected CfnCrawler(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnCrawler
```
public CfnCrawler(Construct scope,
                  java.lang.String id,
                  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 Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The tags to use with this crawler.
  - getRole
```
public java.lang.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
```
public void setRole(java.lang.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
```
public java.lang.Object getTargets()
```
    A collection of targets to crawl.
  - setTargets
```
public void setTargets(IResolvable value)
```
    A collection of targets to crawl.
  - setTargets
```
public void setTargets(CfnCrawler.TargetsProperty value)
```
    A collection of targets to crawl.
  - getClassifiers
```
public java.util.List<java.lang.String> getClassifiers()
```
    A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
  - setClassifiers
```
public void setClassifiers(java.util.List<java.lang.String> value)
```
    A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
  - getConfiguration
```
public java.lang.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
```
public void setConfiguration(java.lang.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
```
public java.lang.String getCrawlerSecurityConfiguration()
```
    The name of the `SecurityConfiguration` structure to be used by this crawler.
  - setCrawlerSecurityConfiguration
```
public void setCrawlerSecurityConfiguration(java.lang.String value)
```
    The name of the `SecurityConfiguration` structure to be used by this crawler.
  - getDatabaseName
```
public java.lang.String getDatabaseName()
```
    The name of the database in which the crawler's output is stored.
  - setDatabaseName
```
public void setDatabaseName(java.lang.String value)
```
    The name of the database in which the crawler's output is stored.
  - getDescription
```
public java.lang.String getDescription()
```
    A description of the crawler.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    A description of the crawler.
  - getName
```
public java.lang.String getName()
```
    The name of the crawler.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the crawler.
  - getRecrawlPolicy
```
public java.lang.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
```
public void setRecrawlPolicy(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
```
public void setRecrawlPolicy(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
```
public java.lang.Object getSchedule()
```
    For scheduled crawlers, the schedule when the crawler runs.
  - setSchedule
```
public void setSchedule(IResolvable value)
```
    For scheduled crawlers, the schedule when the crawler runs.
  - setSchedule
```
public void setSchedule(CfnCrawler.ScheduleProperty value)
```
    For scheduled crawlers, the schedule when the crawler runs.
  - getSchemaChangePolicy
```
public java.lang.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
```
public void setSchemaChangePolicy(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
```
public void setSchemaChangePolicy(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
```
public java.lang.String getTablePrefix()
```
    The prefix added to the names of tables that are created.
  - setTablePrefix
```
public void setTablePrefix(java.lang.String value)
```
    The prefix added to the names of tables that are created.

Class CfnCrawler

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnCrawler

CfnCrawler

CfnCrawler

Method Detail

inspect

renderProperties

getCfnProperties

getTags

getRole

setRole

getTargets

setTargets

setTargets

getClassifiers

setClassifiers

getConfiguration

setConfiguration

getCrawlerSecurityConfiguration

setCrawlerSecurityConfiguration

getDatabaseName

setDatabaseName

getDescription

setDescription

getName

setName

getRecrawlPolicy

setRecrawlPolicy

setRecrawlPolicy

getSchedule

setSchedule

setSchedule

getSchemaChangePolicy

setSchemaChangePolicy

setSchemaChangePolicy

getTablePrefix

setTablePrefix