Class CfnCrawler
The AWS::Glue::Crawler
resource specifies an AWS Glue crawler.
Inherited Members
Namespace: Amazon.CDK.AWS.Glue
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCrawler : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnCrawler
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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
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 cfnCrawler = new CfnCrawler(this, "MyCfnCrawler", 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",
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
CfnCrawler(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCrawler(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnCrawler(Construct, String, ICfnCrawlerProps) |
Properties
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags to use with this crawler. |
Targets | A collection of targets to crawl. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCrawler(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCrawler(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCrawler(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCrawler(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnCrawler(Construct, String, ICfnCrawlerProps)
public CfnCrawler(Construct scope, string id, ICfnCrawlerProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnCrawlerProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Classifiers
A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
public virtual string[] Classifiers { get; set; }
Property Value
System.String[]
Configuration
Crawler configuration information.
public virtual string Configuration { get; set; }
Property Value
System.String
CrawlerSecurityConfiguration
The name of the SecurityConfiguration
structure to be used by this crawler.
public virtual string CrawlerSecurityConfiguration { get; set; }
Property Value
System.String
DatabaseName
The name of the database in which the crawler's output is stored.
public virtual string DatabaseName { get; set; }
Property Value
System.String
Description
A description of the crawler.
public virtual string Description { get; set; }
Property Value
System.String
LakeFormationConfiguration
Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.
public virtual object LakeFormationConfiguration { get; set; }
Property Value
System.Object
Name
The name of the crawler.
public virtual string Name { get; set; }
Property Value
System.String
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 virtual object RecrawlPolicy { get; set; }
Property Value
System.Object
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 virtual string Role { get; set; }
Property Value
System.String
Schedule
For scheduled crawlers, the schedule when the crawler runs.
public virtual object Schedule { get; set; }
Property Value
System.Object
SchemaChangePolicy
The policy that specifies update and delete behaviors for the crawler.
public virtual object SchemaChangePolicy { get; set; }
Property Value
System.Object
TablePrefix
The prefix added to the names of tables that are created.
public virtual string TablePrefix { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags to use with this crawler.
public virtual object TagsRaw { get; set; }
Property Value
System.Object
Targets
A collection of targets to crawl.
public virtual object Targets { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>