Class CfnCrawlerProps
Properties for defining a CfnCrawler
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Glue
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCrawlerProps : Object, ICfnCrawlerProps
Syntax (vb)
Public Class CfnCrawlerProps
Inherits Object
Implements ICfnCrawlerProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Glue;
var tags;
var cfnCrawlerProps = new CfnCrawlerProps {
Role = "role",
Targets = new TargetsProperty {
CatalogTargets = new [] { new CatalogTargetProperty {
ConnectionName = "connectionName",
DatabaseName = "databaseName",
DlqEventQueueArn = "dlqEventQueueArn",
EventQueueArn = "eventQueueArn",
Tables = new [] { "tables" }
} },
DeltaTargets = new [] { new DeltaTargetProperty {
ConnectionName = "connectionName",
CreateNativeDeltaTable = false,
DeltaTables = new [] { "deltaTables" },
WriteManifest = false
} },
DynamoDbTargets = new [] { new DynamoDBTargetProperty {
Path = "path"
} },
IcebergTargets = new [] { new IcebergTargetProperty {
ConnectionName = "connectionName",
Exclusions = new [] { "exclusions" },
MaximumTraversalDepth = 123,
Paths = new [] { "paths" }
} },
JdbcTargets = new [] { new JdbcTargetProperty {
ConnectionName = "connectionName",
EnableAdditionalMetadata = new [] { "enableAdditionalMetadata" },
Exclusions = new [] { "exclusions" },
Path = "path"
} },
MongoDbTargets = new [] { new MongoDBTargetProperty {
ConnectionName = "connectionName",
Path = "path"
} },
S3Targets = new [] { new S3TargetProperty {
ConnectionName = "connectionName",
DlqEventQueueArn = "dlqEventQueueArn",
EventQueueArn = "eventQueueArn",
Exclusions = new [] { "exclusions" },
Path = "path",
SampleSize = 123
} }
},
// the properties below are optional
Classifiers = new [] { "classifiers" },
Configuration = "configuration",
CrawlerSecurityConfiguration = "crawlerSecurityConfiguration",
DatabaseName = "databaseName",
Description = "description",
LakeFormationConfiguration = new LakeFormationConfigurationProperty {
AccountId = "accountId",
UseLakeFormationCredentials = false
},
Name = "name",
RecrawlPolicy = new RecrawlPolicyProperty {
RecrawlBehavior = "recrawlBehavior"
},
Schedule = new ScheduleProperty {
ScheduleExpression = "scheduleExpression"
},
SchemaChangePolicy = new SchemaChangePolicyProperty {
DeleteBehavior = "deleteBehavior",
UpdateBehavior = "updateBehavior"
},
TablePrefix = "tablePrefix",
Tags = tags
};
Synopsis
Constructors
CfnCrawlerProps() |
Properties
Classifiers | A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler. |
Configuration | Crawler configuration information. |
CrawlerSecurityConfiguration | The name of the |
DatabaseName | The name of the database in which the crawler's output is stored. |
Description | A description of the crawler. |
LakeFormationConfiguration | Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials. |
Name | The name of the crawler. |
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. |
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. |
Schedule | For scheduled crawlers, the schedule when the crawler runs. |
SchemaChangePolicy | The policy that specifies update and delete behaviors for the crawler. |
TablePrefix | The prefix added to the names of tables that are created. |
Tags | The tags to use with this crawler. |
Targets | A collection of targets to crawl. |
Constructors
CfnCrawlerProps()
public CfnCrawlerProps()
Properties
Classifiers
A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
public string[] Classifiers { get; set; }
Property Value
System.String[]
Remarks
Configuration
Crawler configuration information.
public string Configuration { get; set; }
Property Value
System.String
Remarks
This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler .
CrawlerSecurityConfiguration
The name of the SecurityConfiguration
structure to be used by this crawler.
public string CrawlerSecurityConfiguration { get; set; }
Property Value
System.String
Remarks
DatabaseName
The name of the database in which the crawler's output is stored.
public string DatabaseName { get; set; }
Property Value
System.String
Remarks
Description
A description of the crawler.
public string Description { get; set; }
Property Value
System.String
Remarks
LakeFormationConfiguration
Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.
public object LakeFormationConfiguration { get; set; }
Property Value
System.Object
Remarks
Name
The name of the crawler.
public string Name { get; set; }
Property Value
System.String
Remarks
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.
public object RecrawlPolicy { get; set; }
Property Value
System.Object
Remarks
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.
public string Role { get; set; }
Property Value
System.String
Remarks
Schedule
For scheduled crawlers, the schedule when the crawler runs.
public object Schedule { get; set; }
Property Value
System.Object
Remarks
SchemaChangePolicy
The policy that specifies update and delete behaviors for the crawler.
public object SchemaChangePolicy { get; set; }
Property Value
System.Object
Remarks
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
The prefix added to the names of tables that are created.
public string TablePrefix { get; set; }
Property Value
System.String
Remarks
Tags
The tags to use with this crawler.
public object Tags { get; set; }
Property Value
System.Object
Remarks
Targets
A collection of targets to crawl.
public object Targets { get; set; }
Property Value
System.Object