CfnCrawlerProps

class aws_cdk.aws_glue.CfnCrawlerProps(*, classifiers=None, configuration=None, crawler_security_configuration=None, database_name=None, description=None, name=None, recrawl_policy=None, role, schedule=None, schema_change_policy=None, table_prefix=None, tags=None, targets)

Bases: object

Properties for defining a AWS::Glue::Crawler.

Parameters
  • classifiers (Optional[Sequence[str]]) – AWS::Glue::Crawler.Classifiers.

  • configuration (Optional[str]) – AWS::Glue::Crawler.Configuration.

  • crawler_security_configuration (Optional[str]) – AWS::Glue::Crawler.CrawlerSecurityConfiguration.

  • database_name (Optional[str]) – AWS::Glue::Crawler.DatabaseName.

  • description (Optional[str]) – AWS::Glue::Crawler.Description.

  • name (Optional[str]) – AWS::Glue::Crawler.Name.

  • recrawl_policy (Union[IResolvable, RecrawlPolicyProperty, None]) – AWS::Glue::Crawler.RecrawlPolicy.

  • role (str) – AWS::Glue::Crawler.Role.

  • schedule (Union[IResolvable, ScheduleProperty, None]) – AWS::Glue::Crawler.Schedule.

  • schema_change_policy (Union[IResolvable, SchemaChangePolicyProperty, None]) – AWS::Glue::Crawler.SchemaChangePolicy.

  • table_prefix (Optional[str]) – AWS::Glue::Crawler.TablePrefix.

  • tags (Optional[Any]) – AWS::Glue::Crawler.Tags.

  • targets (Union[IResolvable, TargetsProperty]) – AWS::Glue::Crawler.Targets.

Link

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

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_glue as glue

# tags is of type object

cfn_crawler_props = glue.CfnCrawlerProps(
    role="role",
    targets=glue.CfnCrawler.TargetsProperty(
        catalog_targets=[glue.CfnCrawler.CatalogTargetProperty(
            database_name="databaseName",
            tables=["tables"]
        )],
        dynamo_db_targets=[glue.CfnCrawler.DynamoDBTargetProperty(
            path="path"
        )],
        jdbc_targets=[glue.CfnCrawler.JdbcTargetProperty(
            connection_name="connectionName",
            exclusions=["exclusions"],
            path="path"
        )],
        s3_targets=[glue.CfnCrawler.S3TargetProperty(
            connection_name="connectionName",
            exclusions=["exclusions"],
            path="path"
        )]
    ),

    # the properties below are optional
    classifiers=["classifiers"],
    configuration="configuration",
    crawler_security_configuration="crawlerSecurityConfiguration",
    database_name="databaseName",
    description="description",
    name="name",
    recrawl_policy=glue.CfnCrawler.RecrawlPolicyProperty(
        recrawl_behavior="recrawlBehavior"
    ),
    schedule=glue.CfnCrawler.ScheduleProperty(
        schedule_expression="scheduleExpression"
    ),
    schema_change_policy=glue.CfnCrawler.SchemaChangePolicyProperty(
        delete_behavior="deleteBehavior",
        update_behavior="updateBehavior"
    ),
    table_prefix="tablePrefix",
    tags=tags
)

Attributes

classifiers

AWS::Glue::Crawler.Classifiers.

Link

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

Return type

Optional[List[str]]

configuration

AWS::Glue::Crawler.Configuration.

Link

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

Return type

Optional[str]

crawler_security_configuration

AWS::Glue::Crawler.CrawlerSecurityConfiguration.

Link

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

Return type

Optional[str]

database_name

AWS::Glue::Crawler.DatabaseName.

Link

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

Return type

Optional[str]

description

AWS::Glue::Crawler.Description.

Link

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

Return type

Optional[str]

name

AWS::Glue::Crawler.Name.

Link

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

Return type

Optional[str]

recrawl_policy

AWS::Glue::Crawler.RecrawlPolicy.

Link

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

Return type

Union[IResolvable, RecrawlPolicyProperty, None]

role

AWS::Glue::Crawler.Role.

Link

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

Return type

str

schedule

AWS::Glue::Crawler.Schedule.

Link

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

Return type

Union[IResolvable, ScheduleProperty, None]

schema_change_policy

AWS::Glue::Crawler.SchemaChangePolicy.

Link

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

Return type

Union[IResolvable, SchemaChangePolicyProperty, None]

table_prefix

AWS::Glue::Crawler.TablePrefix.

Link

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

Return type

Optional[str]

tags

AWS::Glue::Crawler.Tags.

Link

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

Return type

Any

targets

AWS::Glue::Crawler.Targets.

Link

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

Return type

Union[IResolvable, TargetsProperty]