Class CfnCrawlerProps.Builder
java.lang.Object
software.amazon.awscdk.services.glue.CfnCrawlerProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCrawlerProps>
- Enclosing interface:
CfnCrawlerProps
@Stability(Stable)
public static final class CfnCrawlerProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCrawlerProps>
A builder for
CfnCrawlerProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.classifiers
(List<String> classifiers) Sets the value ofCfnCrawlerProps.getClassifiers()
configuration
(String configuration) Sets the value ofCfnCrawlerProps.getConfiguration()
crawlerSecurityConfiguration
(String crawlerSecurityConfiguration) Sets the value ofCfnCrawlerProps.getCrawlerSecurityConfiguration()
databaseName
(String databaseName) Sets the value ofCfnCrawlerProps.getDatabaseName()
description
(String description) Sets the value ofCfnCrawlerProps.getDescription()
lakeFormationConfiguration
(IResolvable lakeFormationConfiguration) Sets the value ofCfnCrawlerProps.getLakeFormationConfiguration()
lakeFormationConfiguration
(CfnCrawler.LakeFormationConfigurationProperty lakeFormationConfiguration) Sets the value ofCfnCrawlerProps.getLakeFormationConfiguration()
Sets the value ofCfnCrawlerProps.getName()
recrawlPolicy
(IResolvable recrawlPolicy) Sets the value ofCfnCrawlerProps.getRecrawlPolicy()
recrawlPolicy
(CfnCrawler.RecrawlPolicyProperty recrawlPolicy) Sets the value ofCfnCrawlerProps.getRecrawlPolicy()
Sets the value ofCfnCrawlerProps.getRole()
schedule
(IResolvable schedule) Sets the value ofCfnCrawlerProps.getSchedule()
schedule
(CfnCrawler.ScheduleProperty schedule) Sets the value ofCfnCrawlerProps.getSchedule()
schemaChangePolicy
(IResolvable schemaChangePolicy) Sets the value ofCfnCrawlerProps.getSchemaChangePolicy()
schemaChangePolicy
(CfnCrawler.SchemaChangePolicyProperty schemaChangePolicy) Sets the value ofCfnCrawlerProps.getSchemaChangePolicy()
tablePrefix
(String tablePrefix) Sets the value ofCfnCrawlerProps.getTablePrefix()
Sets the value ofCfnCrawlerProps.getTags()
targets
(IResolvable targets) Sets the value ofCfnCrawlerProps.getTargets()
targets
(CfnCrawler.TargetsProperty targets) Sets the value ofCfnCrawlerProps.getTargets()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
role
Sets the value ofCfnCrawlerProps.getRole()
- Parameters:
role
- 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. This parameter is required.- Returns:
this
-
targets
Sets the value ofCfnCrawlerProps.getTargets()
- Parameters:
targets
- A collection of targets to crawl. This parameter is required.- Returns:
this
-
targets
Sets the value ofCfnCrawlerProps.getTargets()
- Parameters:
targets
- A collection of targets to crawl. This parameter is required.- Returns:
this
-
classifiers
Sets the value ofCfnCrawlerProps.getClassifiers()
- Parameters:
classifiers
- A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.- Returns:
this
-
configuration
Sets the value ofCfnCrawlerProps.getConfiguration()
- Parameters:
configuration
- Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler .- Returns:
this
-
crawlerSecurityConfiguration
@Stability(Stable) public CfnCrawlerProps.Builder crawlerSecurityConfiguration(String crawlerSecurityConfiguration) Sets the value ofCfnCrawlerProps.getCrawlerSecurityConfiguration()
- Parameters:
crawlerSecurityConfiguration
- The name of theSecurityConfiguration
structure to be used by this crawler.- Returns:
this
-
databaseName
Sets the value ofCfnCrawlerProps.getDatabaseName()
- Parameters:
databaseName
- The name of the database in which the crawler's output is stored.- Returns:
this
-
description
Sets the value ofCfnCrawlerProps.getDescription()
- Parameters:
description
- A description of the crawler.- Returns:
this
-
lakeFormationConfiguration
@Stability(Stable) public CfnCrawlerProps.Builder lakeFormationConfiguration(IResolvable lakeFormationConfiguration) Sets the value ofCfnCrawlerProps.getLakeFormationConfiguration()
- Parameters:
lakeFormationConfiguration
- Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.- Returns:
this
-
lakeFormationConfiguration
@Stability(Stable) public CfnCrawlerProps.Builder lakeFormationConfiguration(CfnCrawler.LakeFormationConfigurationProperty lakeFormationConfiguration) Sets the value ofCfnCrawlerProps.getLakeFormationConfiguration()
- Parameters:
lakeFormationConfiguration
- Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.- Returns:
this
-
name
Sets the value ofCfnCrawlerProps.getName()
- Parameters:
name
- The name of the crawler.- Returns:
this
-
recrawlPolicy
Sets the value ofCfnCrawlerProps.getRecrawlPolicy()
- Parameters:
recrawlPolicy
- A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.- Returns:
this
-
recrawlPolicy
@Stability(Stable) public CfnCrawlerProps.Builder recrawlPolicy(CfnCrawler.RecrawlPolicyProperty recrawlPolicy) Sets the value ofCfnCrawlerProps.getRecrawlPolicy()
- Parameters:
recrawlPolicy
- A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.- Returns:
this
-
schedule
Sets the value ofCfnCrawlerProps.getSchedule()
- Parameters:
schedule
- For scheduled crawlers, the schedule when the crawler runs.- Returns:
this
-
schedule
Sets the value ofCfnCrawlerProps.getSchedule()
- Parameters:
schedule
- For scheduled crawlers, the schedule when the crawler runs.- Returns:
this
-
schemaChangePolicy
@Stability(Stable) public CfnCrawlerProps.Builder schemaChangePolicy(IResolvable schemaChangePolicy) Sets the value ofCfnCrawlerProps.getSchemaChangePolicy()
- Parameters:
schemaChangePolicy
- 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. TheSchemaChangePolicy
does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of theSchemaChangePolicy
on a crawler.The SchemaChangePolicy consists of two components,
UpdateBehavior
andDeleteBehavior
.- Returns:
this
-
schemaChangePolicy
@Stability(Stable) public CfnCrawlerProps.Builder schemaChangePolicy(CfnCrawler.SchemaChangePolicyProperty schemaChangePolicy) Sets the value ofCfnCrawlerProps.getSchemaChangePolicy()
- Parameters:
schemaChangePolicy
- 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. TheSchemaChangePolicy
does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of theSchemaChangePolicy
on a crawler.The SchemaChangePolicy consists of two components,
UpdateBehavior
andDeleteBehavior
.- Returns:
this
-
tablePrefix
Sets the value ofCfnCrawlerProps.getTablePrefix()
- Parameters:
tablePrefix
- The prefix added to the names of tables that are created.- Returns:
this
-
tags
Sets the value ofCfnCrawlerProps.getTags()
- Parameters:
tags
- The tags to use with this crawler.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnCrawlerProps>
- Returns:
- a new instance of
CfnCrawlerProps
- Throws:
NullPointerException
- if any required attribute was not provided
-