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.103.1 (build bef2dea)",
date="2024-09-24T10:56:32.766Z")
@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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnCrawler
.static interface
Specifies an AWS Glue Data Catalog target.static interface
Specifies a Delta data store to crawl one or more Delta tables.static interface
Specifies an Amazon DynamoDB table to crawl.static interface
Specifies Apache Iceberg data store targets.static interface
Specifies a JDBC data store to crawl.static interface
Specifies AWS Lake Formation configuration settings for the crawler.static interface
Specifies an Amazon DocumentDB or MongoDB data store to crawl.static interface
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
Specifies a data store in Amazon Simple Storage Service (Amazon S3).static interface
A scheduling object using acron
statement to schedule an event.static interface
The policy that specifies update and delete behaviors for the crawler.static interface
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnCrawler
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnCrawler
(software.amazon.jsii.JsiiObjectRef objRef) CfnCrawler
(software.constructs.Construct scope, String id, CfnCrawlerProps props) -
Method Summary
Modifier and TypeMethodDescriptionA list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.Crawler configuration information.The name of theSecurityConfiguration
structure to be used by this crawler.The name of the database in which the crawler's output is stored.A description of the crawler.Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.getName()
The name of the crawler.A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.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.For scheduled crawlers, the schedule when the crawler runs.The policy that specifies update and delete behaviors for the crawler.The prefix added to the names of tables that are created.getTags()
Tag Manager which manages the tags for this resource.The tags to use with this crawler.A collection of targets to crawl.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
The name of theSecurityConfiguration
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
Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.void
Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.void
The name of the crawler.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
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
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
(IResolvable value) For scheduled crawlers, the schedule when the crawler runs.void
For scheduled crawlers, the schedule when the crawler runs.void
setSchemaChangePolicy
(IResolvable value) The policy that specifies update and delete behaviors for the crawler.void
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
setTagsRaw
(Object value) The tags to use with this crawler.void
setTargets
(IResolvable value) A collection of targets to crawl.void
A collection of targets to crawl.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
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
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
A collection of targets to crawl. -
setTargets
A collection of targets to crawl. -
setTargets
A collection of targets to crawl. -
getClassifiers
A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler. -
setClassifiers
A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler. -
getConfiguration
Crawler configuration information. -
setConfiguration
Crawler configuration information. -
getCrawlerSecurityConfiguration
The name of theSecurityConfiguration
structure to be used by this crawler. -
setCrawlerSecurityConfiguration
The name of theSecurityConfiguration
structure to be used by this crawler. -
getDatabaseName
The name of the database in which the crawler's output is stored. -
setDatabaseName
The name of the database in which the crawler's output is stored. -
getDescription
A description of the crawler. -
setDescription
A description of the crawler. -
getLakeFormationConfiguration
Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials. -
setLakeFormationConfiguration
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
The name of the crawler. -
setName
The name of the crawler. -
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
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
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
For scheduled crawlers, the schedule when the crawler runs. -
setSchedule
For scheduled crawlers, the schedule when the crawler runs. -
setSchedule
For scheduled crawlers, the schedule when the crawler runs. -
getSchemaChangePolicy
The policy that specifies update and delete behaviors for the crawler. -
setSchemaChangePolicy
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
The prefix added to the names of tables that are created. -
setTablePrefix
The prefix added to the names of tables that are created. -
getTagsRaw
The tags to use with this crawler. -
setTagsRaw
The tags to use with this crawler.
-