aws-cdk-lib.aws_glue.CfnCrawler

class CfnCrawler (construct)

LanguageType name
.NETAmazon.CDK.AWS.Glue.CfnCrawler
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsglue#CfnCrawler
Javasoftware.amazon.awscdk.services.glue.CfnCrawler
Pythonaws_cdk.aws_glue.CfnCrawler
TypeScript aws-cdk-lib » aws_glue » CfnCrawler

Implements IConstruct, IDependable, IInspectable

A CloudFormation AWS::Glue::Crawler.

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 { aws_glue as glue } from 'aws-cdk-lib';

declare const tags: any;
const cfnCrawler = new glue.CfnCrawler(this, 'MyCfnCrawler', {
  role: 'role',
  targets: {
    catalogTargets: [{
      connectionName: 'connectionName',
      databaseName: 'databaseName',
      dlqEventQueueArn: 'dlqEventQueueArn',
      eventQueueArn: 'eventQueueArn',
      tables: ['tables'],
    }],
    deltaTargets: [{
      connectionName: 'connectionName',
      createNativeDeltaTable: false,
      deltaTables: ['deltaTables'],
      writeManifest: false,
    }],
    dynamoDbTargets: [{
      path: 'path',
    }],
    jdbcTargets: [{
      connectionName: 'connectionName',
      exclusions: ['exclusions'],
      path: 'path',
    }],
    mongoDbTargets: [{
      connectionName: 'connectionName',
      path: 'path',
    }],
    s3Targets: [{
      connectionName: 'connectionName',
      dlqEventQueueArn: 'dlqEventQueueArn',
      eventQueueArn: 'eventQueueArn',
      exclusions: ['exclusions'],
      path: 'path',
      sampleSize: 123,
    }],
  },

  // the properties below are optional
  classifiers: ['classifiers'],
  configuration: 'configuration',
  crawlerSecurityConfiguration: 'crawlerSecurityConfiguration',
  databaseName: 'databaseName',
  description: 'description',
  name: 'name',
  recrawlPolicy: {
    recrawlBehavior: 'recrawlBehavior',
  },
  schedule: {
    scheduleExpression: 'scheduleExpression',
  },
  schemaChangePolicy: {
    deleteBehavior: 'deleteBehavior',
    updateBehavior: 'updateBehavior',
  },
  tablePrefix: 'tablePrefix',
  tags: tags,
});

Initializer

new CfnCrawler(scope: Construct, id: string, props: CfnCrawlerProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnCrawlerProps — - resource properties.

Create a new AWS::Glue::Crawler.

Construct Props

NameTypeDescription
rolestringThe Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
targetsIResolvable | TargetsPropertyA collection of targets to crawl.
classifiers?string[]A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
configuration?stringCrawler configuration information.
crawlerSecurityConfiguration?stringThe name of the SecurityConfiguration structure to be used by this crawler.
databaseName?stringThe name of the database in which the crawler's output is stored.
description?stringA description of the crawler.
name?stringThe name of the crawler.
recrawlPolicy?IResolvable | RecrawlPolicyPropertyA policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
schedule?IResolvable | SchedulePropertyFor scheduled crawlers, the schedule when the crawler runs.
schemaChangePolicy?IResolvable | SchemaChangePolicyPropertyThe policy that specifies update and delete behaviors for the crawler.
tablePrefix?stringThe prefix added to the names of tables that are created.
tags?anyThe tags to use with this crawler.

role

Type: string

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.


targets

Type: IResolvable | TargetsProperty

A collection of targets to crawl.


classifiers?

Type: string[] (optional)

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


configuration?

Type: string (optional)

Crawler configuration information.

This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler .


crawlerSecurityConfiguration?

Type: string (optional)

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


databaseName?

Type: string (optional)

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


description?

Type: string (optional)

A description of the crawler.


name?

Type: string (optional)

The name of the crawler.


recrawlPolicy?

Type: IResolvable | RecrawlPolicyProperty (optional)

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.


schedule?

Type: IResolvable | ScheduleProperty (optional)

For scheduled crawlers, the schedule when the crawler runs.


schemaChangePolicy?

Type: IResolvable | SchemaChangePolicyProperty (optional)

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 .


tablePrefix?

Type: string (optional)

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


tags?

Type: any (optional)

The tags to use with this crawler.

Properties

NameTypeDescription
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
rolestringThe Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
stackStackThe stack in which this element is defined.
tagsTagManagerThe tags to use with this crawler.
targetsIResolvable | TargetsPropertyA collection of targets to crawl.
classifiers?string[]A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
configuration?stringCrawler configuration information.
crawlerSecurityConfiguration?stringThe name of the SecurityConfiguration structure to be used by this crawler.
databaseName?stringThe name of the database in which the crawler's output is stored.
description?stringA description of the crawler.
name?stringThe name of the crawler.
recrawlPolicy?IResolvable | RecrawlPolicyPropertyA policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
schedule?IResolvable | SchedulePropertyFor scheduled crawlers, the schedule when the crawler runs.
schemaChangePolicy?IResolvable | SchemaChangePolicyPropertyThe policy that specifies update and delete behaviors for the crawler.
tablePrefix?stringThe prefix added to the names of tables that are created.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


role

Type: string

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.


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


tags

Type: TagManager

The tags to use with this crawler.


targets

Type: IResolvable | TargetsProperty

A collection of targets to crawl.


classifiers?

Type: string[] (optional)

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


configuration?

Type: string (optional)

Crawler configuration information.

This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler .


crawlerSecurityConfiguration?

Type: string (optional)

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


databaseName?

Type: string (optional)

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


description?

Type: string (optional)

A description of the crawler.


name?

Type: string (optional)

The name of the crawler.


recrawlPolicy?

Type: IResolvable | RecrawlPolicyProperty (optional)

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.


schedule?

Type: IResolvable | ScheduleProperty (optional)

For scheduled crawlers, the schedule when the crawler runs.


schemaChangePolicy?

Type: IResolvable | SchemaChangePolicyProperty (optional)

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 .


tablePrefix?

Type: string (optional)

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


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }