CfnCrawlerPropsMixin

class aws_cdk.mixins_preview.aws_glue.mixins.CfnCrawlerPropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html
CloudformationResource:: AWS::Glue::Crawler
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# tags: Any

cfn_crawler_props_mixin = glue_mixins.CfnCrawlerPropsMixin(glue_mixins.CfnCrawlerMixinProps(
    classifiers=["classifiers"],
    configuration="configuration",
    crawler_security_configuration="crawlerSecurityConfiguration",
    database_name="databaseName",
    description="description",
    lake_formation_configuration=glue_mixins.CfnCrawlerPropsMixin.LakeFormationConfigurationProperty(
        account_id="accountId",
        use_lake_formation_credentials=False
    ),
    name="name",
    recrawl_policy=glue_mixins.CfnCrawlerPropsMixin.RecrawlPolicyProperty(
        recrawl_behavior="recrawlBehavior"
    ),
    role="role",
    schedule=glue_mixins.CfnCrawlerPropsMixin.ScheduleProperty(
        schedule_expression="scheduleExpression"
    ),
    schema_change_policy=glue_mixins.CfnCrawlerPropsMixin.SchemaChangePolicyProperty(
        delete_behavior="deleteBehavior",
        update_behavior="updateBehavior"
    ),
    table_prefix="tablePrefix",
    tags=tags,
    targets=glue_mixins.CfnCrawlerPropsMixin.TargetsProperty(
        catalog_targets=[glue_mixins.CfnCrawlerPropsMixin.CatalogTargetProperty(
            connection_name="connectionName",
            database_name="databaseName",
            dlq_event_queue_arn="dlqEventQueueArn",
            event_queue_arn="eventQueueArn",
            tables=["tables"]
        )],
        delta_targets=[glue_mixins.CfnCrawlerPropsMixin.DeltaTargetProperty(
            connection_name="connectionName",
            create_native_delta_table=False,
            delta_tables=["deltaTables"],
            write_manifest=False
        )],
        dynamo_db_targets=[glue_mixins.CfnCrawlerPropsMixin.DynamoDBTargetProperty(
            path="path",
            scan_all=False,
            scan_rate=123
        )],
        hudi_targets=[glue_mixins.CfnCrawlerPropsMixin.HudiTargetProperty(
            connection_name="connectionName",
            exclusions=["exclusions"],
            maximum_traversal_depth=123,
            paths=["paths"]
        )],
        iceberg_targets=[glue_mixins.CfnCrawlerPropsMixin.IcebergTargetProperty(
            connection_name="connectionName",
            exclusions=["exclusions"],
            maximum_traversal_depth=123,
            paths=["paths"]
        )],
        jdbc_targets=[glue_mixins.CfnCrawlerPropsMixin.JdbcTargetProperty(
            connection_name="connectionName",
            enable_additional_metadata=["enableAdditionalMetadata"],
            exclusions=["exclusions"],
            path="path"
        )],
        mongo_db_targets=[glue_mixins.CfnCrawlerPropsMixin.MongoDBTargetProperty(
            connection_name="connectionName",
            path="path"
        )],
        s3_targets=[glue_mixins.CfnCrawlerPropsMixin.S3TargetProperty(
            connection_name="connectionName",
            dlq_event_queue_arn="dlqEventQueueArn",
            event_queue_arn="eventQueueArn",
            exclusions=["exclusions"],
            path="path",
            sample_size=123
        )]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Glue::Crawler.

Parameters:

props (Union[CfnCrawlerMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['classifiers', 'configuration', 'crawlerSecurityConfiguration', 'databaseName', 'description', 'lakeFormationConfiguration', 'name', 'recrawlPolicy', 'role', 'schedule', 'schemaChangePolicy', 'tablePrefix', 'tags', 'targets']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CatalogTargetProperty

class CfnCrawlerPropsMixin.CatalogTargetProperty(*, connection_name=None, database_name=None, dlq_event_queue_arn=None, event_queue_arn=None, tables=None)

Bases: object

Specifies an AWS Glue Data Catalog target.

Parameters:

connection_name (Optional[str]) – The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.
database_name (Optional[str]) – The name of the database to be synchronized.
dlq_event_queue_arn (Optional[str]) – A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue .
event_queue_arn (Optional[str]) – A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs .
tables (Optional[Sequence[str]]) – A list of the tables to be synchronized.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

catalog_target_property = glue_mixins.CfnCrawlerPropsMixin.CatalogTargetProperty(
    connection_name="connectionName",
    database_name="databaseName",
    dlq_event_queue_arn="dlqEventQueueArn",
    event_queue_arn="eventQueueArn",
    tables=["tables"]
)

Attributes

connection_name

The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-connectionname

database_name

The name of the database to be synchronized.

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

dlq_event_queue_arn

A valid Amazon dead-letter SQS ARN.

For example, arn:aws:sqs:region:account:deadLetterQueue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-dlqeventqueuearn

event_queue_arn

A valid Amazon SQS ARN.

For example, arn:aws:sqs:region:account:sqs .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-eventqueuearn

tables

A list of the tables to be synchronized.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-tables

DeltaTargetProperty

class CfnCrawlerPropsMixin.DeltaTargetProperty(*, connection_name=None, create_native_delta_table=None, delta_tables=None, write_manifest=None)

Bases: object

Specifies a Delta data store to crawl one or more Delta tables.

Parameters:

connection_name (Optional[str]) – The name of the connection to use to connect to the Delta table target.
create_native_delta_table (Union[bool, IResolvable, None]) – Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
delta_tables (Optional[Sequence[str]]) – A list of the Amazon S3 paths to the Delta tables.
write_manifest (Union[bool, IResolvable, None]) – Specifies whether to write the manifest files to the Delta table path.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

delta_target_property = glue_mixins.CfnCrawlerPropsMixin.DeltaTargetProperty(
    connection_name="connectionName",
    create_native_delta_table=False,
    delta_tables=["deltaTables"],
    write_manifest=False
)

Attributes

connection_name

The name of the connection to use to connect to the Delta table target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-connectionname

create_native_delta_table

Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-createnativedeltatable

delta_tables

A list of the Amazon S3 paths to the Delta tables.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-deltatables

write_manifest

Specifies whether to write the manifest files to the Delta table path.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-writemanifest

DynamoDBTargetProperty

class CfnCrawlerPropsMixin.DynamoDBTargetProperty(*, path=None, scan_all=None, scan_rate=None)

Bases: object

Specifies an Amazon DynamoDB table to crawl.

Parameters:

path (Optional[str]) – The name of the DynamoDB table to crawl.
scan_all (Union[bool, IResolvable, None]) – Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table. A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .
scan_rate (Union[int, float, None]) – The percentage of the configured read capacity units to use by the AWS Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second. The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

dynamo_dBTarget_property = glue_mixins.CfnCrawlerPropsMixin.DynamoDBTargetProperty(
    path="path",
    scan_all=False,
    scan_rate=123
)

Attributes

path

The name of the DynamoDB table to crawl.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-dynamodbtarget.html#cfn-glue-crawler-dynamodbtarget-path

scan_all

Indicates whether to scan all the records, or to sample rows from the table.

Scanning all the records can take a long time when the table is not a high throughput table.

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-dynamodbtarget.html#cfn-glue-crawler-dynamodbtarget-scanall

scan_rate

The percentage of the configured read capacity units to use by the AWS Glue crawler.

Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-dynamodbtarget.html#cfn-glue-crawler-dynamodbtarget-scanrate

HudiTargetProperty

class CfnCrawlerPropsMixin.HudiTargetProperty(*, connection_name=None, exclusions=None, maximum_traversal_depth=None, paths=None)

Bases: object

Specifies an Apache Hudi data source.

Parameters:

connection_name (Optional[str]) – The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
exclusions (Optional[Sequence[str]]) – A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
maximum_traversal_depth (Union[int, float, None]) – The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
paths (Optional[Sequence[str]]) – An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder. The crawler will scan all folders underneath a path for a Hudi folder.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

hudi_target_property = glue_mixins.CfnCrawlerPropsMixin.HudiTargetProperty(
    connection_name="connectionName",
    exclusions=["exclusions"],
    maximum_traversal_depth=123,
    paths=["paths"]
)

Attributes

connection_name

The name of the connection to use to connect to the Hudi target.

If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-huditarget.html#cfn-glue-crawler-huditarget-connectionname

exclusions

A list of glob patterns used to exclude from the crawl.

For more information, see Catalog Tables with a Crawler .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-huditarget.html#cfn-glue-crawler-huditarget-exclusions

maximum_traversal_depth

The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path.

Used to limit the crawler run time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-huditarget.html#cfn-glue-crawler-huditarget-maximumtraversaldepth

paths

An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides.

The Hudi folder may be located in a child folder of the root folder.

The crawler will scan all folders underneath a path for a Hudi folder.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-huditarget.html#cfn-glue-crawler-huditarget-paths

IcebergTargetProperty

class CfnCrawlerPropsMixin.IcebergTargetProperty(*, connection_name=None, exclusions=None, maximum_traversal_depth=None, paths=None)

Bases: object

Specifies Apache Iceberg data store targets.

Parameters:

connection_name (Optional[str]) – The name of the connection to use to connect to the Iceberg target.
exclusions (Optional[Sequence[str]]) – A list of global patterns used to exclude from the crawl.
maximum_traversal_depth (Union[int, float, None]) – The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
paths (Optional[Sequence[str]]) – One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

iceberg_target_property = glue_mixins.CfnCrawlerPropsMixin.IcebergTargetProperty(
    connection_name="connectionName",
    exclusions=["exclusions"],
    maximum_traversal_depth=123,
    paths=["paths"]
)

Attributes

connection_name

The name of the connection to use to connect to the Iceberg target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-connectionname

exclusions

A list of global patterns used to exclude from the crawl.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-exclusions

maximum_traversal_depth

The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path.

Used to limit the crawler run time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-maximumtraversaldepth

paths

//bucket/prefix .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-paths
Type:: One or more Amazon S3 paths that contains Iceberg metadata folders as s3

JdbcTargetProperty

class CfnCrawlerPropsMixin.JdbcTargetProperty(*, connection_name=None, enable_additional_metadata=None, exclusions=None, path=None)

Bases: object

Specifies a JDBC data store to crawl.

Parameters:

connection_name (Optional[str]) – The name of the connection to use to connect to the JDBC target.
enable_additional_metadata (Optional[Sequence[str]]) – Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database. If you do not need additional metadata, keep the field empty.
exclusions (Optional[Sequence[str]]) –
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
path (Optional[str]) – The path of the JDBC target.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

jdbc_target_property = glue_mixins.CfnCrawlerPropsMixin.JdbcTargetProperty(
    connection_name="connectionName",
    enable_additional_metadata=["enableAdditionalMetadata"],
    exclusions=["exclusions"],
    path="path"
)

Attributes

connection_name

The name of the connection to use to connect to the JDBC target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-connectionname

enable_additional_metadata

Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses.

RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.

If you do not need additional metadata, keep the field empty.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-enableadditionalmetadata

exclusions

A list of glob patterns used to exclude from the crawl.

For more information, see Catalog Tables with a Crawler .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-exclusions

path

The path of the JDBC target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-path

LakeFormationConfigurationProperty

class CfnCrawlerPropsMixin.LakeFormationConfigurationProperty(*, account_id=None, use_lake_formation_credentials=None)

Bases: object

Specifies AWS Lake Formation configuration settings for the crawler.

Parameters:

account_id (Optional[str]) – Required for cross account crawls. For same account crawls as the target data, this can be left as null.
use_lake_formation_credentials (Union[bool, IResolvable, None]) – Specifies whether to use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

lake_formation_configuration_property = glue_mixins.CfnCrawlerPropsMixin.LakeFormationConfigurationProperty(
    account_id="accountId",
    use_lake_formation_credentials=False
)

Attributes

account_id

Required for cross account crawls.

For same account crawls as the target data, this can be left as null.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-lakeformationconfiguration.html#cfn-glue-crawler-lakeformationconfiguration-accountid

use_lake_formation_credentials

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-lakeformationconfiguration.html#cfn-glue-crawler-lakeformationconfiguration-uselakeformationcredentials

MongoDBTargetProperty

class CfnCrawlerPropsMixin.MongoDBTargetProperty(*, connection_name=None, path=None)

Bases: object

Specifies an Amazon DocumentDB or MongoDB data store to crawl.

Parameters:

connection_name (Optional[str]) – The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
path (Optional[str]) – The path of the Amazon DocumentDB or MongoDB target (database/collection).

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

mongo_dBTarget_property = glue_mixins.CfnCrawlerPropsMixin.MongoDBTargetProperty(
    connection_name="connectionName",
    path="path"
)

Attributes

connection_name

The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-mongodbtarget.html#cfn-glue-crawler-mongodbtarget-connectionname

path

The path of the Amazon DocumentDB or MongoDB target (database/collection).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-mongodbtarget.html#cfn-glue-crawler-mongodbtarget-path

RecrawlPolicyProperty

class CfnCrawlerPropsMixin.RecrawlPolicyProperty(*, recrawl_behavior=None)

Bases: object

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.

For more information, see Incremental Crawls in AWS Glue in the developer guide.

Parameters:: recrawl_behavior (Optional[str]) – Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. A value of CRAWL_EVERYTHING specifies crawling the entire dataset again. A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run. A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-recrawlpolicy.html
ExampleMetadata:: fixture=_generated

Example:

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

recrawl_policy_property = glue_mixins.CfnCrawlerPropsMixin.RecrawlPolicyProperty(
    recrawl_behavior="recrawlBehavior"
)

Attributes

recrawl_behavior

Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.

A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.

A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.

A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.

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

S3TargetProperty

class CfnCrawlerPropsMixin.S3TargetProperty(*, connection_name=None, dlq_event_queue_arn=None, event_queue_arn=None, exclusions=None, path=None, sample_size=None)

Bases: object

Specifies a data store in Amazon Simple Storage Service (Amazon S3).

Parameters:

connection_name (Optional[str]) – The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
dlq_event_queue_arn (Optional[str]) – A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue .
event_queue_arn (Optional[str]) – A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs .
exclusions (Optional[Sequence[str]]) –
A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler .
path (Optional[str]) – The path to the Amazon S3 target.
sample_size (Union[int, float, None]) – Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

s3_target_property = glue_mixins.CfnCrawlerPropsMixin.S3TargetProperty(
    connection_name="connectionName",
    dlq_event_queue_arn="dlqEventQueueArn",
    event_queue_arn="eventQueueArn",
    exclusions=["exclusions"],
    path="path",
    sample_size=123
)

Attributes

connection_name

The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-connectionname

dlq_event_queue_arn

A valid Amazon dead-letter SQS ARN.

For example, arn:aws:sqs:region:account:deadLetterQueue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-dlqeventqueuearn

event_queue_arn

A valid Amazon SQS ARN.

For example, arn:aws:sqs:region:account:sqs .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-eventqueuearn

exclusions

A list of glob patterns used to exclude from the crawl.

For more information, see Catalog Tables with a Crawler .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-exclusions

path

The path to the Amazon S3 target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-path

sample_size

Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset.

If not set, all the files are crawled. A valid value is an integer between 1 and 249.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-samplesize

ScheduleProperty

class CfnCrawlerPropsMixin.ScheduleProperty(*, schedule_expression=None)

Bases: object

A scheduling object using a cron statement to schedule an event.

Parameters:: schedule_expression (Optional[str]) – A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *) .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schedule.html
ExampleMetadata:: fixture=_generated

Example:

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

schedule_property = glue_mixins.CfnCrawlerPropsMixin.ScheduleProperty(
    schedule_expression="scheduleExpression"
)

Attributes

schedule_expression

A cron expression used to specify the schedule.

For more information, see Time-Based Schedules for Jobs and Crawlers . For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *) .

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

SchemaChangePolicyProperty

class CfnCrawlerPropsMixin.SchemaChangePolicyProperty(*, delete_behavior=None, update_behavior=None)

Bases: object

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:

delete_behavior (Optional[str]) – The deletion behavior when the crawler finds a deleted object. A value of LOG specifies that if a table or partition is found to no longer exist, do not delete it, only log that it was found to no longer exist. A value of DELETE_FROM_DATABASE specifies that if a table or partition is found to have been removed, delete it from the database. A value of DEPRECATE_IN_DATABASE specifies that if a table has been found to no longer exist, to add a property to the table that says “DEPRECATED” and includes a timestamp with the time of deprecation.
update_behavior (Optional[str]) – The update behavior when the crawler finds a changed schema. A value of LOG specifies that if a table or a partition already exists, and a change is detected, do not update it, only log that a change was detected. Add new tables and new partitions (including on existing tables). A value of UPDATE_IN_DATABASE specifies that if a table or partition already exists, and a change is detected, update it. Add new tables and partitions.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

schema_change_policy_property = glue_mixins.CfnCrawlerPropsMixin.SchemaChangePolicyProperty(
    delete_behavior="deleteBehavior",
    update_behavior="updateBehavior"
)

Attributes

delete_behavior

The deletion behavior when the crawler finds a deleted object.

A value of LOG specifies that if a table or partition is found to no longer exist, do not delete it, only log that it was found to no longer exist.

A value of DELETE_FROM_DATABASE specifies that if a table or partition is found to have been removed, delete it from the database.

A value of DEPRECATE_IN_DATABASE specifies that if a table has been found to no longer exist, to add a property to the table that says “DEPRECATED” and includes a timestamp with the time of deprecation.

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

update_behavior

The update behavior when the crawler finds a changed schema.

A value of LOG specifies that if a table or a partition already exists, and a change is detected, do not update it, only log that a change was detected. Add new tables and new partitions (including on existing tables).

A value of UPDATE_IN_DATABASE specifies that if a table or partition already exists, and a change is detected, update it. Add new tables and partitions.

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

TargetsProperty

class CfnCrawlerPropsMixin.TargetsProperty(*, catalog_targets=None, delta_targets=None, dynamo_db_targets=None, hudi_targets=None, iceberg_targets=None, jdbc_targets=None, mongo_db_targets=None, s3_targets=None)

Bases: object

Specifies data stores to crawl.

Parameters:

catalog_targets (Union[IResolvable, Sequence[Union[IResolvable, CatalogTargetProperty, Dict[str, Any]]], None]) – Specifies AWS Glue Data Catalog targets.
delta_targets (Union[IResolvable, Sequence[Union[IResolvable, DeltaTargetProperty, Dict[str, Any]]], None]) – Specifies an array of Delta data store targets.
dynamo_db_targets (Union[IResolvable, Sequence[Union[IResolvable, DynamoDBTargetProperty, Dict[str, Any]]], None]) – Specifies Amazon DynamoDB targets.
hudi_targets (Union[IResolvable, Sequence[Union[IResolvable, HudiTargetProperty, Dict[str, Any]]], None]) – Specifies Apache Hudi data store targets.
iceberg_targets (Union[IResolvable, Sequence[Union[IResolvable, IcebergTargetProperty, Dict[str, Any]]], None]) – Specifies Apache Iceberg data store targets.
jdbc_targets (Union[IResolvable, Sequence[Union[IResolvable, JdbcTargetProperty, Dict[str, Any]]], None]) – Specifies JDBC targets.
mongo_db_targets (Union[IResolvable, Sequence[Union[IResolvable, MongoDBTargetProperty, Dict[str, Any]]], None]) – A list of Mongo DB targets.
s3_targets (Union[IResolvable, Sequence[Union[IResolvable, S3TargetProperty, Dict[str, Any]]], None]) – Specifies Amazon Simple Storage Service (Amazon S3) targets.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

targets_property = glue_mixins.CfnCrawlerPropsMixin.TargetsProperty(
    catalog_targets=[glue_mixins.CfnCrawlerPropsMixin.CatalogTargetProperty(
        connection_name="connectionName",
        database_name="databaseName",
        dlq_event_queue_arn="dlqEventQueueArn",
        event_queue_arn="eventQueueArn",
        tables=["tables"]
    )],
    delta_targets=[glue_mixins.CfnCrawlerPropsMixin.DeltaTargetProperty(
        connection_name="connectionName",
        create_native_delta_table=False,
        delta_tables=["deltaTables"],
        write_manifest=False
    )],
    dynamo_db_targets=[glue_mixins.CfnCrawlerPropsMixin.DynamoDBTargetProperty(
        path="path",
        scan_all=False,
        scan_rate=123
    )],
    hudi_targets=[glue_mixins.CfnCrawlerPropsMixin.HudiTargetProperty(
        connection_name="connectionName",
        exclusions=["exclusions"],
        maximum_traversal_depth=123,
        paths=["paths"]
    )],
    iceberg_targets=[glue_mixins.CfnCrawlerPropsMixin.IcebergTargetProperty(
        connection_name="connectionName",
        exclusions=["exclusions"],
        maximum_traversal_depth=123,
        paths=["paths"]
    )],
    jdbc_targets=[glue_mixins.CfnCrawlerPropsMixin.JdbcTargetProperty(
        connection_name="connectionName",
        enable_additional_metadata=["enableAdditionalMetadata"],
        exclusions=["exclusions"],
        path="path"
    )],
    mongo_db_targets=[glue_mixins.CfnCrawlerPropsMixin.MongoDBTargetProperty(
        connection_name="connectionName",
        path="path"
    )],
    s3_targets=[glue_mixins.CfnCrawlerPropsMixin.S3TargetProperty(
        connection_name="connectionName",
        dlq_event_queue_arn="dlqEventQueueArn",
        event_queue_arn="eventQueueArn",
        exclusions=["exclusions"],
        path="path",
        sample_size=123
    )]
)