Class Crawler

Manages a Glue Crawler. More information can be found in the AWS Glue Developer Guide

Example Usage

DynamoDB Target

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Glue.Crawler("example", new Aws.Glue.CrawlerArgs
    {
        DatabaseName = aws_glue_catalog_database.Example.Name,
        DynamodbTargets = 
        {
            new Aws.Glue.Inputs.CrawlerDynamodbTargetArgs
            {
                Path = "table-name",
            },
        },
        Role = aws_iam_role.Example.Arn,
    });
}

}

JDBC Target

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Glue.Crawler("example", new Aws.Glue.CrawlerArgs
    {
        DatabaseName = aws_glue_catalog_database.Example.Name,
        JdbcTargets = 
        {
            new Aws.Glue.Inputs.CrawlerJdbcTargetArgs
            {
                ConnectionName = aws_glue_connection.Example.Name,
                Path = "database-name/%",
            },
        },
        Role = aws_iam_role.Example.Arn,
    });
}

}

S3 Target

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Glue.Crawler("example", new Aws.Glue.CrawlerArgs
    {
        DatabaseName = aws_glue_catalog_database.Example.Name,
        Role = aws_iam_role.Example.Arn,
        S3Targets = 
        {
            new Aws.Glue.Inputs.CrawlerS3TargetArgs
            {
                Path = $"s3://{aws_s3_bucket.Example.Bucket}",
            },
        },
    });
}

}

Catalog Target

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Glue.Crawler("example", new Aws.Glue.CrawlerArgs
    {
        CatalogTargets = 
        {
            new Aws.Glue.Inputs.CrawlerCatalogTargetArgs
            {
                DatabaseName = aws_glue_catalog_database.Example.Name,
                Tables = 
                {
                    aws_glue_catalog_table.Example.Name,
                },
            },
        },
        Configuration = @"{
""Version"":1.0,
""Grouping"": {
""TableGroupingPolicy"": ""CombineCompatibleSchemas""
}
}

",
        DatabaseName = aws_glue_catalog_database.Example.Name,
        Role = aws_iam_role.Example.Arn,
        SchemaChangePolicy = new Aws.Glue.Inputs.CrawlerSchemaChangePolicyArgs
        {
            DeleteBehavior = "LOG",
        },
    });
}

}
Inheritance
System.Object
Resource
CustomResource
Crawler
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.Glue
Assembly: Pulumi.Aws.dll
Syntax
public class Crawler : CustomResource

Constructors

View Source

Crawler(String, CrawlerArgs, CustomResourceOptions)

Create a Crawler resource with the given unique name, arguments, and options.

Declaration
public Crawler(string name, CrawlerArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
CrawlerArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

Arn

The ARN of the crawler

Declaration
public Output<string> Arn { get; }
Property Value
Type Description
Output<System.String>
View Source

CatalogTargets

Declaration
public Output<ImmutableArray<CrawlerCatalogTarget>> CatalogTargets { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<CrawlerCatalogTarget>>
View Source

Classifiers

List of custom classifiers. By default, all AWS classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

Declaration
public Output<ImmutableArray<string>> Classifiers { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Configuration

JSON string of configuration information.

Declaration
public Output<string> Configuration { get; }
Property Value
Type Description
Output<System.String>
View Source

DatabaseName

Glue database where results are written.

Declaration
public Output<string> DatabaseName { get; }
Property Value
Type Description
Output<System.String>
View Source

Description

Description of the crawler.

Declaration
public Output<string> Description { get; }
Property Value
Type Description
Output<System.String>
View Source

DynamodbTargets

List of nested DynamoDB target arguments. See below.

Declaration
public Output<ImmutableArray<CrawlerDynamodbTarget>> DynamodbTargets { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<CrawlerDynamodbTarget>>
View Source

JdbcTargets

List of nested JBDC target arguments. See below.

Declaration
public Output<ImmutableArray<CrawlerJdbcTarget>> JdbcTargets { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<CrawlerJdbcTarget>>
View Source

Name

Name of the crawler.

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

Role

The IAM role friendly name (including path without leading slash), or ARN of an IAM role, used by the crawler to access other resources.

Declaration
public Output<string> Role { get; }
Property Value
Type Description
Output<System.String>
View Source

S3Targets

List nested Amazon S3 target arguments. See below.

Declaration
public Output<ImmutableArray<CrawlerS3Target>> S3Targets { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<CrawlerS3Target>>
View Source

Schedule

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, you would specify: cron(15 12 * * ? *).

Declaration
public Output<string> Schedule { get; }
Property Value
Type Description
Output<System.String>
View Source

SchemaChangePolicy

Policy for the crawler's update and deletion behavior.

Declaration
public Output<CrawlerSchemaChangePolicy> SchemaChangePolicy { get; }
Property Value
Type Description
Output<CrawlerSchemaChangePolicy>
View Source

SecurityConfiguration

The name of Security Configuration to be used by the crawler

Declaration
public Output<string> SecurityConfiguration { get; }
Property Value
Type Description
Output<System.String>
View Source

TablePrefix

The table prefix used for catalog tables that are created.

Declaration
public Output<string> TablePrefix { get; }
Property Value
Type Description
Output<System.String>
View Source

Tags

Key-value map of resource tags

Declaration
public Output<ImmutableDictionary<string, object>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

View Source

Get(String, Input<String>, CrawlerState, CustomResourceOptions)

Get an existing Crawler resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static Crawler Get(string name, Input<string> id, CrawlerState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
CrawlerState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Crawler