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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.528Z")
 @Stability(value=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()
                         .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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCrawler(software.constructs.Construct scope, 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

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

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnCrawler(@NotNull
                                           software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to use with this crawler.

getRole

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

A collection of targets to crawl.

setTargets

@Stability(value=Stable)
public void setTargets(@NotNull
                                                CfnCrawler.TargetsProperty value)

A collection of targets to crawl.

setTargets

@Stability(value=Stable)
public void setTargets(@NotNull
                                                IResolvable value)

A collection of targets to crawl.

getClassifiers

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

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

setCrawlerSecurityConfiguration

@Stability(value=Stable)
public void setCrawlerSecurityConfiguration(@Nullable
                                                                     String value)

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

getDatabaseName

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

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

setDatabaseName

@Stability(value=Stable)
public void setDatabaseName(@Nullable
                                                     String value)

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

getDescription

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

A description of the crawler.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the crawler.

getName

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

The name of the crawler.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the crawler.

getRecrawlPolicy

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

setRecrawlPolicy

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

getSchedule

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

For scheduled crawlers, the schedule when the crawler runs.

setSchedule

@Stability(value=Stable)
public void setSchedule(@Nullable
                                                 CfnCrawler.ScheduleProperty value)

For scheduled crawlers, the schedule when the crawler runs.

setSchedule

@Stability(value=Stable)
public void setSchedule(@Nullable
                                                 IResolvable value)

For scheduled crawlers, the schedule when the crawler runs.

getSchemaChangePolicy

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

setSchemaChangePolicy

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

getTablePrefix

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

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

setTablePrefix

@Stability(value=Stable)
public void setTablePrefix(@Nullable
                                                    String value)

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