Package software.amazon.awscdk.services.glue

Class CfnCrawler.Builder

java.lang.Object

software.amazon.awscdk.services.glue.CfnCrawler.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCrawler>

Enclosing class:

CfnCrawler

@Stability(Stable)
public static final class CfnCrawler.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCrawler>

A fluent builder for CfnCrawler.

Method Summary

Modifier and Type	Method	Description
CfnCrawler	build()
CfnCrawler.Builder	classifiers(List<String> classifiers)	A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
CfnCrawler.Builder	configuration(String configuration)	Crawler configuration information.
CfnCrawler.Builder	crawlerSecurityConfiguration(String crawlerSecurityConfiguration)	The name of the SecurityConfiguration structure to be used by this crawler.
static CfnCrawler.Builder	create(software.constructs.Construct scope, String id)
CfnCrawler.Builder	databaseName(String databaseName)	The name of the database in which the crawler's output is stored.
CfnCrawler.Builder	description(String description)	A description of the crawler.
CfnCrawler.Builder	lakeFormationConfiguration(IResolvable lakeFormationConfiguration)	Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.
CfnCrawler.Builder	lakeFormationConfiguration(CfnCrawler.LakeFormationConfigurationProperty lakeFormationConfiguration)	Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.
CfnCrawler.Builder	name(String name)	The name of the crawler.
CfnCrawler.Builder	recrawlPolicy(IResolvable 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.
CfnCrawler.Builder	recrawlPolicy(CfnCrawler.RecrawlPolicyProperty 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.
CfnCrawler.Builder	role(String 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.
CfnCrawler.Builder	schedule(IResolvable schedule)	For scheduled crawlers, the schedule when the crawler runs.
CfnCrawler.Builder	schedule(CfnCrawler.ScheduleProperty schedule)	For scheduled crawlers, the schedule when the crawler runs.
CfnCrawler.Builder	schemaChangePolicy(IResolvable schemaChangePolicy)	The policy that specifies update and delete behaviors for the crawler.
CfnCrawler.Builder	schemaChangePolicy(CfnCrawler.SchemaChangePolicyProperty schemaChangePolicy)	The policy that specifies update and delete behaviors for the crawler.
CfnCrawler.Builder	tablePrefix(String tablePrefix)	The prefix added to the names of tables that are created.
CfnCrawler.Builder	tags(Object tags)	The tags to use with this crawler.
CfnCrawler.Builder	targets(IResolvable targets)	A collection of targets to crawl.
CfnCrawler.Builder	targets(CfnCrawler.TargetsProperty targets)	A collection of targets to crawl.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnCrawler.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnCrawler.Builder.

role

@Stability(Stable)
public CfnCrawler.Builder role(String 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.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-role

targets

@Stability(Stable)
public CfnCrawler.Builder targets(IResolvable targets)

A collection of targets to crawl.

Parameters:

targets - A collection of targets to crawl. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-targets

targets

@Stability(Stable)
public CfnCrawler.Builder targets(CfnCrawler.TargetsProperty targets)

A collection of targets to crawl.

Parameters:

targets - A collection of targets to crawl. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-targets

classifiers

@Stability(Stable)
public CfnCrawler.Builder classifiers(List<String> classifiers)

A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.

Parameters:

classifiers - A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-classifiers

configuration

@Stability(Stable)
public CfnCrawler.Builder configuration(String 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 .

Parameters:

configuration - Crawler configuration information. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-configuration

crawlerSecurityConfiguration

@Stability(Stable)
public CfnCrawler.Builder crawlerSecurityConfiguration(String crawlerSecurityConfiguration)

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

Parameters:

crawlerSecurityConfiguration - The name of the SecurityConfiguration structure to be used by this crawler. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-crawlersecurityconfiguration

databaseName

@Stability(Stable)
public CfnCrawler.Builder databaseName(String databaseName)

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

Parameters:

databaseName - The name of the database in which the crawler's output is stored. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-databasename

description

@Stability(Stable)
public CfnCrawler.Builder description(String description)

A description of the crawler.

Parameters:

description - A description of the crawler. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-description

lakeFormationConfiguration

@Stability(Stable)
public CfnCrawler.Builder lakeFormationConfiguration(IResolvable lakeFormationConfiguration)

Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.

Parameters:

lakeFormationConfiguration - Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-lakeformationconfiguration

lakeFormationConfiguration

@Stability(Stable)
public CfnCrawler.Builder lakeFormationConfiguration(CfnCrawler.LakeFormationConfigurationProperty lakeFormationConfiguration)

Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.

Parameters:

lakeFormationConfiguration - Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-lakeformationconfiguration

name

@Stability(Stable)
public CfnCrawler.Builder name(String name)

The name of the crawler.

Parameters:

name - The name of the crawler. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-name

recrawlPolicy

@Stability(Stable)
public CfnCrawler.Builder recrawlPolicy(IResolvable 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.

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-recrawlpolicy

recrawlPolicy

@Stability(Stable)
public CfnCrawler.Builder recrawlPolicy(CfnCrawler.RecrawlPolicyProperty 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.

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-recrawlpolicy

schedule

@Stability(Stable)
public CfnCrawler.Builder schedule(IResolvable schedule)

For scheduled crawlers, the schedule when the crawler runs.

Parameters:

schedule - For scheduled crawlers, the schedule when the crawler runs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schedule

schedule

@Stability(Stable)
public CfnCrawler.Builder schedule(CfnCrawler.ScheduleProperty schedule)

For scheduled crawlers, the schedule when the crawler runs.

Parameters:

schedule - For scheduled crawlers, the schedule when the crawler runs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schedule

schemaChangePolicy

@Stability(Stable)
public CfnCrawler.Builder schemaChangePolicy(IResolvable 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. 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 .

Parameters:

schemaChangePolicy - The policy that specifies update and delete behaviors for the crawler. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schemachangepolicy

schemaChangePolicy

@Stability(Stable)
public CfnCrawler.Builder schemaChangePolicy(CfnCrawler.SchemaChangePolicyProperty 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. 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 .

Parameters:

schemaChangePolicy - The policy that specifies update and delete behaviors for the crawler. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schemachangepolicy

tablePrefix

@Stability(Stable)
public CfnCrawler.Builder tablePrefix(String tablePrefix)

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

Parameters:

tablePrefix - The prefix added to the names of tables that are created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-tableprefix

tags

@Stability(Stable)
public CfnCrawler.Builder tags(Object tags)

The tags to use with this crawler.

Parameters:

tags - The tags to use with this crawler. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-tags

build

@Stability(Stable)
public CfnCrawler build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCrawler>

Returns:

a newly built instance of CfnCrawler.