Module glue

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Functions

Others

Resources

Resource CatalogDatabase

class CatalogDatabase extends CustomResource

Provides a Glue Catalog Database Resource. You can refer to the Glue Developer Guide for a full explanation of the Glue Data Catalog functionality

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const awsGlueCatalogDatabase = new aws.glue.CatalogDatabase("aws_glue_catalog_database", {
    name: "MyCatalogDatabase",
});

constructor

new CatalogDatabase(name: string, args?: CatalogDatabaseArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CatalogDatabaseState, opts?: pulumi.CustomResourceOptions): CatalogDatabase

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CatalogDatabase

Returns true if the given object is an instance of CatalogDatabase. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property catalogId

public catalogId: pulumi.Output<string>;

ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.

property description

public description: pulumi.Output<string | undefined>;

Description of the database.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property locationUri

public locationUri: pulumi.Output<string | undefined>;

The location of the database (for example, an HDFS path).

property name

public name: pulumi.Output<string>;

The name of the database.

property parameters

public parameters: pulumi.Output<{[key: string]: string} | undefined>;

A list of key-value pairs that define parameters and properties of the database.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource CatalogTable

class CatalogTable extends CustomResource

Provides a Glue Catalog Table Resource. You can refer to the Glue Developer Guide for a full explanation of the Glue Data Catalog functionality.

Example Usage

Basic Table
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const awsGlueCatalogTable = new aws.glue.CatalogTable("aws_glue_catalog_table", {
    databaseName: "MyCatalogDatabase",
    name: "MyCatalogTable",
});
Parquet Table for Athena
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const awsGlueCatalogTable = new aws.glue.CatalogTable("aws_glue_catalog_table", {
    databaseName: "MyCatalogDatabase",
    name: "MyCatalogTable",
    parameters: {
        EXTERNAL: "TRUE",
        "parquet.compression": "SNAPPY",
    },
    storageDescriptor: {
        columns: [
            {
                name: "my_string",
                type: "string",
            },
            {
                name: "my_double",
                type: "double",
            },
            {
                comment: "",
                name: "my_date",
                type: "date",
            },
            {
                comment: "",
                name: "my_bigint",
                type: "bigint",
            },
            {
                comment: "",
                name: "my_struct",
                type: "struct<my_nested_string:string>",
            },
        ],
        inputFormat: "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
        location: "s3://my-bucket/event-streams/my-stream",
        outputFormat: "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
        serDeInfo: {
            name: "my-stream",
            parameters: {
                "serialization.format": 1,
            },
            serializationLibrary: "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
        },
    },
    tableType: "EXTERNAL_TABLE",
});

constructor

new CatalogTable(name: string, args: CatalogTableArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CatalogTableState, opts?: pulumi.CustomResourceOptions): CatalogTable

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CatalogTable

Returns true if the given object is an instance of CatalogTable. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property catalogId

public catalogId: pulumi.Output<string>;

ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.

property databaseName

public databaseName: pulumi.Output<string>;

Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

property description

public description: pulumi.Output<string | undefined>;

Description of the table.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the SerDe.

property owner

public owner: pulumi.Output<string | undefined>;

Owner of the table.

property parameters

public parameters: pulumi.Output<{[key: string]: string} | undefined>;

A map of initialization parameters for the SerDe, in key-value form.

property partitionKeys

public partitionKeys: pulumi.Output<CatalogTablePartitionKey[] | undefined>;

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

property retention

public retention: pulumi.Output<number | undefined>;

Retention time for this table.

property storageDescriptor

public storageDescriptor: pulumi.Output<CatalogTableStorageDescriptor | undefined>;

A storage descriptor object containing information about the physical storage of this table. You can refer to the Glue Developer Guide for a full explanation of this object.

property tableType

public tableType: pulumi.Output<string | undefined>;

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property viewExpandedText

public viewExpandedText: pulumi.Output<string | undefined>;

If the table is a view, the expanded text of the view; otherwise null.

property viewOriginalText

public viewOriginalText: pulumi.Output<string | undefined>;

If the table is a view, the original text of the view; otherwise null.

Resource Classifier

class Classifier extends CustomResource

Provides a Glue Classifier resource.

NOTE: It is only valid to create one type of classifier (csv, grok, JSON, or XML). Changing classifier types will recreate the classifier.

Example Usage

Csv Classifier
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Classifier("example", {
    csvClassifier: {
        allowSingleColumn: false,
        containsHeader: "PRESENT",
        delimiter: ",",
        disableValueTrimming: false,
        headers: [
            "example1",
            "example2",
        ],
        quoteSymbol: "'",
    },
});
Grok Classifier
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Classifier("example", {
    grokClassifier: {
        classification: "example",
        grokPattern: "example",
    },
});
JSON Classifier
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Classifier("example", {
    jsonClassifier: {
        jsonPath: "example",
    },
});
XML Classifier
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Classifier("example", {
    xmlClassifier: {
        classification: "example",
        rowTag: "example",
    },
});

constructor

new Classifier(name: string, args?: ClassifierArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClassifierState, opts?: pulumi.CustomResourceOptions): Classifier

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Classifier

Returns true if the given object is an instance of Classifier. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property csvClassifier

public csvClassifier: pulumi.Output<ClassifierCsvClassifier | undefined>;

A classifier for Csv content. Defined below.

property grokClassifier

public grokClassifier: pulumi.Output<ClassifierGrokClassifier | undefined>;

A classifier that uses grok patterns. Defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property jsonClassifier

public jsonClassifier: pulumi.Output<ClassifierJsonClassifier | undefined>;

A classifier for JSON content. Defined below.

property name

public name: pulumi.Output<string>;

The name of the classifier.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property xmlClassifier

public xmlClassifier: pulumi.Output<ClassifierXmlClassifier | undefined>;

A classifier for XML content. Defined below.

Resource Connection

class Connection extends CustomResource

Provides a Glue Connection resource.

Example Usage

Non-VPC Connection
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Connection("example", {
    connectionProperties: {
        JDBC_CONNECTION_URL: "jdbc:mysql://example.com/exampledatabase",
        PASSWORD: "examplepassword",
        USERNAME: "exampleusername",
    },
});
VPC Connection
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Connection("example", {
    connectionProperties: {
        JDBC_CONNECTION_URL: pulumi.interpolate`jdbc:mysql://${aws_rds_cluster_example.endpoint}/exampledatabase`,
        PASSWORD: "examplepassword",
        USERNAME: "exampleusername",
    },
    physicalConnectionRequirements: {
        availabilityZone: aws_subnet_example.availabilityZone,
        securityGroupIdLists: [aws_security_group_example.id],
        subnetId: aws_subnet_example.id,
    },
});

constructor

new Connection(name: string, args: ConnectionArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConnectionState, opts?: pulumi.CustomResourceOptions): Connection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Connection

Returns true if the given object is an instance of Connection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the Glue Connection.

property catalogId

public catalogId: pulumi.Output<string>;

The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.

property connectionProperties

public connectionProperties: pulumi.Output<{[key: string]: any}>;

A map of key-value pairs used as parameters for this connection.

property connectionType

public connectionType: pulumi.Output<string | undefined>;

The type of the connection. Supported are: JDBC, MONGODB, KAFKA. Defaults to JBDC.

property description

public description: pulumi.Output<string | undefined>;

Description of the connection.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property matchCriterias

public matchCriterias: pulumi.Output<string[] | undefined>;

A list of criteria that can be used in selecting this connection.

property name

public name: pulumi.Output<string>;

The name of the connection.

property physicalConnectionRequirements

public physicalConnectionRequirements: pulumi.Output<ConnectionPhysicalConnectionRequirements | undefined>;

A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Crawler

class Crawler extends CustomResource

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

Example Usage

DynamoDB Target
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Crawler("example", {
    databaseName: aws_glue_catalog_database_example.name,
    dynamodbTargets: [{
        path: "table-name",
    }],
    role: aws_iam_role_example.arn,
});
JDBC Target
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Crawler("example", {
    databaseName: aws_glue_catalog_database_example.name,
    jdbcTargets: [{
        connectionName: aws_glue_connection_example.name,
        path: "database-name/%",
    }],
    role: aws_iam_role_example.arn,
});
S3 Target
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Crawler("example", {
    databaseName: aws_glue_catalog_database_example.name,
    role: aws_iam_role_example.arn,
    s3Targets: [{
        path: pulumi.interpolate`s3://${aws_s3_bucket_example.bucket}`,
    }],
});
Catalog Target
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Crawler("example", {
    catalogTargets: [{
        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: {
        deleteBehavior: "LOG",
    },
});

constructor

new Crawler(name: string, args: CrawlerArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CrawlerState, opts?: pulumi.CustomResourceOptions): Crawler

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Crawler

Returns true if the given object is an instance of Crawler. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the crawler

property catalogTargets

public catalogTargets: pulumi.Output<CrawlerCatalogTarget[] | undefined>;

property classifiers

public classifiers: pulumi.Output<string[] | undefined>;

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.

property configuration

public configuration: pulumi.Output<string | undefined>;

JSON string of configuration information.

property databaseName

public databaseName: pulumi.Output<string>;

Glue database where results are written.

property description

public description: pulumi.Output<string | undefined>;

Description of the crawler.

property dynamodbTargets

public dynamodbTargets: pulumi.Output<CrawlerDynamodbTarget[] | undefined>;

List of nested DynamoDB target arguments. See below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property jdbcTargets

public jdbcTargets: pulumi.Output<CrawlerJdbcTarget[] | undefined>;

List of nested JBDC target arguments. See below.

property name

public name: pulumi.Output<string>;

Name of the crawler.

property role

public role: pulumi.Output<string>;

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

property s3Targets

public s3Targets: pulumi.Output<CrawlerS3Target[] | undefined>;

List nested Amazon S3 target arguments. See below.

property schedule

public schedule: pulumi.Output<string | undefined>;

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 * * ? *).

property schemaChangePolicy

public schemaChangePolicy: pulumi.Output<CrawlerSchemaChangePolicy | undefined>;

Policy for the crawler’s update and deletion behavior.

property securityConfiguration

public securityConfiguration: pulumi.Output<string | undefined>;

The name of Security Configuration to be used by the crawler

property tablePrefix

public tablePrefix: pulumi.Output<string | undefined>;

The table prefix used for catalog tables that are created.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Job

class Job extends CustomResource

Provides a Glue Job resource.

Glue functionality, such as monitoring and logging of jobs, is typically managed with the defaultArguments argument. See the Special Parameters Used by AWS Glue topic in the Glue developer guide for additional information.

Example Usage

Python Job
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Job("example", {
    command: {
        scriptLocation: pulumi.interpolate`s3://${aws_s3_bucket_example.bucket}/example.py`,
    },
    roleArn: aws_iam_role_example.arn,
});
Scala Job
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Job("example", {
    command: {
        scriptLocation: pulumi.interpolate`s3://${aws_s3_bucket_example.bucket}/example.scala`,
    },
    defaultArguments: {
        "--job-language": "scala",
    },
    roleArn: aws_iam_role_example.arn,
});
Enabling CloudWatch Logs and Metrics
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleLogGroup = new aws.cloudwatch.LogGroup("example", {
    retentionInDays: 14,
});
const exampleJob = new aws.glue.Job("example", {
    defaultArguments: {
        // ... potentially other arguments ...
        "--continuous-log-logGroup": exampleLogGroup.name,
        "--enable-continuous-cloudwatch-log": "true",
        "--enable-continuous-log-filter": "true",
        "--enable-metrics": "",
    },
});

constructor

new Job(name: string, args: JobArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: JobState, opts?: pulumi.CustomResourceOptions): Job

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Job

Returns true if the given object is an instance of Job. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allocatedCapacity

DEPRECATED Please use attribute `max_capacity' instead. This attribute might be removed in future releases.
public allocatedCapacity: pulumi.Output<number>;

DEPRECATED (Optional) The number of AWS Glue data processing units (DPUs) to allocate to this Job. At least 2 DPUs need to be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of Glue Job

property command

public command: pulumi.Output<JobCommand>;

The command of the job. Defined below.

property connections

public connections: pulumi.Output<string[] | undefined>;

The list of connections used for this job.

property defaultArguments

public defaultArguments: pulumi.Output<{[key: string]: any} | undefined>;

The map of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

property description

public description: pulumi.Output<string | undefined>;

Description of the job.

property executionProperty

public executionProperty: pulumi.Output<JobExecutionProperty>;

Execution property of the job. Defined below.

property glueVersion

public glueVersion: pulumi.Output<string>;

The version of glue to use, for example “1.0”. For information about available versions, see the AWS Glue Release Notes.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maxCapacity

public maxCapacity: pulumi.Output<number>;

The maximum number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. Required when pythonshell is set, accept either 0.0625 or 1.0.

property maxRetries

public maxRetries: pulumi.Output<number | undefined>;

The maximum number of times to retry this job if it fails.

property name

public name: pulumi.Output<string>;

The name you assign to this job. It must be unique in your account.

property notificationProperty

public notificationProperty: pulumi.Output<JobNotificationProperty>;

Notification property of the job. Defined below.

property numberOfWorkers

public numberOfWorkers: pulumi.Output<number | undefined>;

The number of workers of a defined workerType that are allocated when a job runs.

property roleArn

public roleArn: pulumi.Output<string>;

The ARN of the IAM role associated with this job.

property securityConfiguration

public securityConfiguration: pulumi.Output<string | undefined>;

The name of the Security Configuration to be associated with the job.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property timeout

public timeout: pulumi.Output<number | undefined>;

The job timeout in minutes. The default is 2880 minutes (48 hours).

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property workerType

public workerType: pulumi.Output<string | undefined>;

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

Resource SecurityConfiguration

class SecurityConfiguration extends CustomResource

Manages a Glue Security Configuration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.SecurityConfiguration("example", {
    encryptionConfiguration: {
        cloudwatchEncryption: {
            cloudwatchEncryptionMode: "DISABLED",
        },
        jobBookmarksEncryption: {
            jobBookmarksEncryptionMode: "DISABLED",
        },
        s3Encryption: {
            kmsKeyArn: aws_kms_key_example.arn,
            s3EncryptionMode: "SSE-KMS",
        },
    },
});

constructor

new SecurityConfiguration(name: string, args: SecurityConfigurationArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecurityConfigurationState, opts?: pulumi.CustomResourceOptions): SecurityConfiguration

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SecurityConfiguration

Returns true if the given object is an instance of SecurityConfiguration. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property encryptionConfiguration

public encryptionConfiguration: pulumi.Output<SecurityConfigurationEncryptionConfiguration>;

Configuration block containing encryption configuration. Detailed below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the security configuration.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Trigger

class Trigger extends CustomResource

Manages a Glue Trigger resource.

Example Usage

Conditional Trigger
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Trigger("example", {
    actions: [{
        jobName: aws_glue_job_example1.name,
    }],
    predicate: {
        conditions: [{
            jobName: aws_glue_job_example2.name,
            state: "SUCCEEDED",
        }],
    },
    type: "CONDITIONAL",
});
On-Demand Trigger
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Trigger("example", {
    actions: [{
        jobName: aws_glue_job_example.name,
    }],
    type: "ON_DEMAND",
});
Scheduled Trigger
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Trigger("example", {
    actions: [{
        jobName: aws_glue_job_example.name,
    }],
    schedule: "cron(15 12 * * ? *)",
    type: "SCHEDULED",
});
Conditional Trigger with Crawler Action
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Trigger("example", {
    actions: [{
        crawlerName: aws_glue_crawler_example1.name,
    }],
    predicate: {
        conditions: [{
            jobName: aws_glue_job_example2.name,
            state: "SUCCEEDED",
        }],
    },
    type: "CONDITIONAL",
});
Conditional Trigger with Crawler Condition
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Trigger("example", {
    actions: [{
        jobName: aws_glue_job_example1.name,
    }],
    predicate: {
        conditions: [{
            crawlState: "SUCCEEDED",
            crawlerName: aws_glue_crawler_example2.name,
        }],
    },
    type: "CONDITIONAL",
});

constructor

new Trigger(name: string, args: TriggerArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TriggerState, opts?: pulumi.CustomResourceOptions): Trigger

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Trigger

Returns true if the given object is an instance of Trigger. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property actions

public actions: pulumi.Output<TriggerAction[]>;

List of actions initiated by this trigger when it fires. Defined below.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of Glue Trigger

property description

public description: pulumi.Output<string | undefined>;

A description of the new trigger.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Start the trigger. Defaults to true. Not valid to disable for ON_DEMAND type.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the trigger.

property predicate

public predicate: pulumi.Output<TriggerPredicate | undefined>;

A predicate to specify when the new trigger should fire. Required when trigger type is CONDITIONAL. Defined below.

property schedule

public schedule: pulumi.Output<string | undefined>;

A cron expression used to specify the schedule. Time-Based Schedules for Jobs and Crawlers

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property type

public type: pulumi.Output<string>;

The type of trigger. Valid values are CONDITIONAL, ON_DEMAND, and SCHEDULED.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property workflowName

public workflowName: pulumi.Output<string | undefined>;

A workflow to which the trigger should be associated to. Every workflow graph (DAG) needs a starting trigger (ON_DEMAND or SCHEDULED type) and can contain multiple additional CONDITIONAL triggers.

Resource Workflow

class Workflow extends CustomResource

Provides a Glue Workflow resource. The workflow graph (DAG) can be build using the aws.glue.Trigger resource. See the example below for creating a graph with four nodes (two triggers and two jobs).

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Workflow("example", {});
const example_start = new aws.glue.Trigger("example-start", {
    actions: [{
        jobName: "example-job",
    }],
    type: "ON_DEMAND",
    workflowName: example.name,
});
const example_inner = new aws.glue.Trigger("example-inner", {
    actions: [{
        jobName: "another-example-job",
    }],
    predicate: {
        conditions: [{
            jobName: "example-job",
            state: "SUCCEEDED",
        }],
    },
    type: "CONDITIONAL",
    workflowName: example.name,
});

constructor

new Workflow(name: string, args?: WorkflowArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WorkflowState, opts?: pulumi.CustomResourceOptions): Workflow

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Workflow

Returns true if the given object is an instance of Workflow. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property defaultRunProperties

public defaultRunProperties: pulumi.Output<{[key: string]: any} | undefined>;

A map of default run properties for this workflow. These properties are passed to all jobs associated to the workflow.

property description

public description: pulumi.Output<string | undefined>;

Description of the workflow.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name you assign to this workflow.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getScript

getScript(args: GetScriptArgs, opts?: pulumi.InvokeOptions): Promise<GetScriptResult>

Use this data source to generate a Glue script from a Directed Acyclic Graph (DAG).

Example Usage

Generate Python Script
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.all([aws_glue_catalog_database_source.name, aws_glue_catalog_table_source.name, aws_glue_catalog_database_destination.name, aws_glue_catalog_table_destination.name, aws_glue_catalog_database_destination.name, aws_glue_catalog_table_destination.name]).apply(([aws_glue_catalog_database_sourceName, aws_glue_catalog_table_sourceName, aws_glue_catalog_database_destinationName, aws_glue_catalog_table_destinationName, aws_glue_catalog_database_destinationName1, aws_glue_catalog_table_destinationName1]) => aws.glue.getScript({
    dagEdges: [
        {
            source: "datasource0",
            target: "applymapping1",
        },
        {
            source: "applymapping1",
            target: "selectfields2",
        },
        {
            source: "selectfields2",
            target: "resolvechoice3",
        },
        {
            source: "resolvechoice3",
            target: "datasink4",
        },
    ],
    dagNodes: [
        {
            args: [
                {
                    name: "database",
                    value: `"${aws_glue_catalog_database_sourceName}"`,
                },
                {
                    name: "table_name",
                    value: `"${aws_glue_catalog_table_sourceName}"`,
                },
            ],
            id: "datasource0",
            nodeType: "DataSource",
        },
        {
            args: [{
                name: "mapping",
                value: "[(\"column1\", \"string\", \"column1\", \"string\")]",
            }],
            id: "applymapping1",
            nodeType: "ApplyMapping",
        },
        {
            args: [{
                name: "paths",
                value: "[\"column1\"]",
            }],
            id: "selectfields2",
            nodeType: "SelectFields",
        },
        {
            args: [
                {
                    name: "choice",
                    value: "\"MATCH_CATALOG\"",
                },
                {
                    name: "database",
                    value: `"${aws_glue_catalog_database_destinationName}"`,
                },
                {
                    name: "table_name",
                    value: `"${aws_glue_catalog_table_destinationName}"`,
                },
            ],
            id: "resolvechoice3",
            nodeType: "ResolveChoice",
        },
        {
            args: [
                {
                    name: "database",
                    value: `"${aws_glue_catalog_database_destinationName1}"`,
                },
                {
                    name: "table_name",
                    value: `"${aws_glue_catalog_table_destinationName1}"`,
                },
            ],
            id: "datasink4",
            nodeType: "DataSink",
        },
    ],
    language: "PYTHON",
}, { async: true }));

export const pythonScript = example.pythonScript;
Generate Scala Code
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.all([aws_glue_catalog_database_source.name, aws_glue_catalog_table_source.name, aws_glue_catalog_database_destination.name, aws_glue_catalog_table_destination.name, aws_glue_catalog_database_destination.name, aws_glue_catalog_table_destination.name]).apply(([aws_glue_catalog_database_sourceName, aws_glue_catalog_table_sourceName, aws_glue_catalog_database_destinationName, aws_glue_catalog_table_destinationName, aws_glue_catalog_database_destinationName1, aws_glue_catalog_table_destinationName1]) => aws.glue.getScript({
    dagEdges: [
        {
            source: "datasource0",
            target: "applymapping1",
        },
        {
            source: "applymapping1",
            target: "selectfields2",
        },
        {
            source: "selectfields2",
            target: "resolvechoice3",
        },
        {
            source: "resolvechoice3",
            target: "datasink4",
        },
    ],
    dagNodes: [
        {
            args: [
                {
                    name: "database",
                    value: `"${aws_glue_catalog_database_sourceName}"`,
                },
                {
                    name: "table_name",
                    value: `"${aws_glue_catalog_table_sourceName}"`,
                },
            ],
            id: "datasource0",
            nodeType: "DataSource",
        },
        {
            args: [{
                name: "mappings",
                value: "[(\"column1\", \"string\", \"column1\", \"string\")]",
            }],
            id: "applymapping1",
            nodeType: "ApplyMapping",
        },
        {
            args: [{
                name: "paths",
                value: "[\"column1\"]",
            }],
            id: "selectfields2",
            nodeType: "SelectFields",
        },
        {
            args: [
                {
                    name: "choice",
                    value: "\"MATCH_CATALOG\"",
                },
                {
                    name: "database",
                    value: `"${aws_glue_catalog_database_destinationName}"`,
                },
                {
                    name: "table_name",
                    value: `"${aws_glue_catalog_table_destinationName}"`,
                },
            ],
            id: "resolvechoice3",
            nodeType: "ResolveChoice",
        },
        {
            args: [
                {
                    name: "database",
                    value: `"${aws_glue_catalog_database_destinationName1}"`,
                },
                {
                    name: "table_name",
                    value: `"${aws_glue_catalog_table_destinationName1}"`,
                },
            ],
            id: "datasink4",
            nodeType: "DataSink",
        },
    ],
    language: "SCALA",
}, { async: true }));

export const scalaCode = example.scalaCode;

Others

interface CatalogDatabaseArgs

interface CatalogDatabaseArgs

The set of arguments for constructing a CatalogDatabase resource.

property catalogId

catalogId?: pulumi.Input<string>;

ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.

property description

description?: pulumi.Input<string>;

Description of the database.

property locationUri

locationUri?: pulumi.Input<string>;

The location of the database (for example, an HDFS path).

property name

name?: pulumi.Input<string>;

The name of the database.

property parameters

parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A list of key-value pairs that define parameters and properties of the database.

interface CatalogDatabaseState

interface CatalogDatabaseState

Input properties used for looking up and filtering CatalogDatabase resources.

property catalogId

catalogId?: pulumi.Input<string>;

ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID.

property description

description?: pulumi.Input<string>;

Description of the database.

property locationUri

locationUri?: pulumi.Input<string>;

The location of the database (for example, an HDFS path).

property name

name?: pulumi.Input<string>;

The name of the database.

property parameters

parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A list of key-value pairs that define parameters and properties of the database.

interface CatalogTableArgs

interface CatalogTableArgs

The set of arguments for constructing a CatalogTable resource.

property catalogId

catalogId?: pulumi.Input<string>;

ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.

property databaseName

databaseName: pulumi.Input<string>;

Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

property description

description?: pulumi.Input<string>;

Description of the table.

property name

name?: pulumi.Input<string>;

Name of the SerDe.

property owner

owner?: pulumi.Input<string>;

Owner of the table.

property parameters

parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A map of initialization parameters for the SerDe, in key-value form.

property partitionKeys

partitionKeys?: pulumi.Input<pulumi.Input<CatalogTablePartitionKey>[]>;

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

property retention

retention?: pulumi.Input<number>;

Retention time for this table.

property storageDescriptor

storageDescriptor?: pulumi.Input<CatalogTableStorageDescriptor>;

A storage descriptor object containing information about the physical storage of this table. You can refer to the Glue Developer Guide for a full explanation of this object.

property tableType

tableType?: pulumi.Input<string>;

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

property viewExpandedText

viewExpandedText?: pulumi.Input<string>;

If the table is a view, the expanded text of the view; otherwise null.

property viewOriginalText

viewOriginalText?: pulumi.Input<string>;

If the table is a view, the original text of the view; otherwise null.

interface CatalogTableState

interface CatalogTableState

Input properties used for looking up and filtering CatalogTable resources.

property catalogId

catalogId?: pulumi.Input<string>;

ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.

property databaseName

databaseName?: pulumi.Input<string>;

Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

property description

description?: pulumi.Input<string>;

Description of the table.

property name

name?: pulumi.Input<string>;

Name of the SerDe.

property owner

owner?: pulumi.Input<string>;

Owner of the table.

property parameters

parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A map of initialization parameters for the SerDe, in key-value form.

property partitionKeys

partitionKeys?: pulumi.Input<pulumi.Input<CatalogTablePartitionKey>[]>;

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

property retention

retention?: pulumi.Input<number>;

Retention time for this table.

property storageDescriptor

storageDescriptor?: pulumi.Input<CatalogTableStorageDescriptor>;

A storage descriptor object containing information about the physical storage of this table. You can refer to the Glue Developer Guide for a full explanation of this object.

property tableType

tableType?: pulumi.Input<string>;

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

property viewExpandedText

viewExpandedText?: pulumi.Input<string>;

If the table is a view, the expanded text of the view; otherwise null.

property viewOriginalText

viewOriginalText?: pulumi.Input<string>;

If the table is a view, the original text of the view; otherwise null.

interface ClassifierArgs

interface ClassifierArgs

The set of arguments for constructing a Classifier resource.

property csvClassifier

csvClassifier?: pulumi.Input<ClassifierCsvClassifier>;

A classifier for Csv content. Defined below.

property grokClassifier

grokClassifier?: pulumi.Input<ClassifierGrokClassifier>;

A classifier that uses grok patterns. Defined below.

property jsonClassifier

jsonClassifier?: pulumi.Input<ClassifierJsonClassifier>;

A classifier for JSON content. Defined below.

property name

name?: pulumi.Input<string>;

The name of the classifier.

property xmlClassifier

xmlClassifier?: pulumi.Input<ClassifierXmlClassifier>;

A classifier for XML content. Defined below.

interface ClassifierState

interface ClassifierState

Input properties used for looking up and filtering Classifier resources.

property csvClassifier

csvClassifier?: pulumi.Input<ClassifierCsvClassifier>;

A classifier for Csv content. Defined below.

property grokClassifier

grokClassifier?: pulumi.Input<ClassifierGrokClassifier>;

A classifier that uses grok patterns. Defined below.

property jsonClassifier

jsonClassifier?: pulumi.Input<ClassifierJsonClassifier>;

A classifier for JSON content. Defined below.

property name

name?: pulumi.Input<string>;

The name of the classifier.

property xmlClassifier

xmlClassifier?: pulumi.Input<ClassifierXmlClassifier>;

A classifier for XML content. Defined below.

interface ConnectionArgs

interface ConnectionArgs

The set of arguments for constructing a Connection resource.

property catalogId

catalogId?: pulumi.Input<string>;

The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.

property connectionProperties

connectionProperties: pulumi.Input<{[key: string]: any}>;

A map of key-value pairs used as parameters for this connection.

property connectionType

connectionType?: pulumi.Input<string>;

The type of the connection. Supported are: JDBC, MONGODB, KAFKA. Defaults to JBDC.

property description

description?: pulumi.Input<string>;

Description of the connection.

property matchCriterias

matchCriterias?: pulumi.Input<pulumi.Input<string>[]>;

A list of criteria that can be used in selecting this connection.

property name

name?: pulumi.Input<string>;

The name of the connection.

property physicalConnectionRequirements

physicalConnectionRequirements?: pulumi.Input<ConnectionPhysicalConnectionRequirements>;

A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.

interface ConnectionState

interface ConnectionState

Input properties used for looking up and filtering Connection resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the Glue Connection.

property catalogId

catalogId?: pulumi.Input<string>;

The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.

property connectionProperties

connectionProperties?: pulumi.Input<{[key: string]: any}>;

A map of key-value pairs used as parameters for this connection.

property connectionType

connectionType?: pulumi.Input<string>;

The type of the connection. Supported are: JDBC, MONGODB, KAFKA. Defaults to JBDC.

property description

description?: pulumi.Input<string>;

Description of the connection.

property matchCriterias

matchCriterias?: pulumi.Input<pulumi.Input<string>[]>;

A list of criteria that can be used in selecting this connection.

property name

name?: pulumi.Input<string>;

The name of the connection.

property physicalConnectionRequirements

physicalConnectionRequirements?: pulumi.Input<ConnectionPhysicalConnectionRequirements>;

A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.

interface CrawlerArgs

interface CrawlerArgs

The set of arguments for constructing a Crawler resource.

property catalogTargets

catalogTargets?: pulumi.Input<pulumi.Input<CrawlerCatalogTarget>[]>;

property classifiers

classifiers?: pulumi.Input<pulumi.Input<string>[]>;

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.

property configuration

configuration?: pulumi.Input<string>;

JSON string of configuration information.

property databaseName

databaseName: pulumi.Input<string>;

Glue database where results are written.

property description

description?: pulumi.Input<string>;

Description of the crawler.

property dynamodbTargets

dynamodbTargets?: pulumi.Input<pulumi.Input<CrawlerDynamodbTarget>[]>;

List of nested DynamoDB target arguments. See below.

property jdbcTargets

jdbcTargets?: pulumi.Input<pulumi.Input<CrawlerJdbcTarget>[]>;

List of nested JBDC target arguments. See below.

property name

name?: pulumi.Input<string>;

Name of the crawler.

property role

role: pulumi.Input<string>;

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

property s3Targets

s3Targets?: pulumi.Input<pulumi.Input<CrawlerS3Target>[]>;

List nested Amazon S3 target arguments. See below.

property schedule

schedule?: pulumi.Input<string>;

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 * * ? *).

property schemaChangePolicy

schemaChangePolicy?: pulumi.Input<CrawlerSchemaChangePolicy>;

Policy for the crawler’s update and deletion behavior.

property securityConfiguration

securityConfiguration?: pulumi.Input<string>;

The name of Security Configuration to be used by the crawler

property tablePrefix

tablePrefix?: pulumi.Input<string>;

The table prefix used for catalog tables that are created.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface CrawlerState

interface CrawlerState

Input properties used for looking up and filtering Crawler resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the crawler

property catalogTargets

catalogTargets?: pulumi.Input<pulumi.Input<CrawlerCatalogTarget>[]>;

property classifiers

classifiers?: pulumi.Input<pulumi.Input<string>[]>;

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.

property configuration

configuration?: pulumi.Input<string>;

JSON string of configuration information.

property databaseName

databaseName?: pulumi.Input<string>;

Glue database where results are written.

property description

description?: pulumi.Input<string>;

Description of the crawler.

property dynamodbTargets

dynamodbTargets?: pulumi.Input<pulumi.Input<CrawlerDynamodbTarget>[]>;

List of nested DynamoDB target arguments. See below.

property jdbcTargets

jdbcTargets?: pulumi.Input<pulumi.Input<CrawlerJdbcTarget>[]>;

List of nested JBDC target arguments. See below.

property name

name?: pulumi.Input<string>;

Name of the crawler.

property role

role?: pulumi.Input<string>;

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

property s3Targets

s3Targets?: pulumi.Input<pulumi.Input<CrawlerS3Target>[]>;

List nested Amazon S3 target arguments. See below.

property schedule

schedule?: pulumi.Input<string>;

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 * * ? *).

property schemaChangePolicy

schemaChangePolicy?: pulumi.Input<CrawlerSchemaChangePolicy>;

Policy for the crawler’s update and deletion behavior.

property securityConfiguration

securityConfiguration?: pulumi.Input<string>;

The name of Security Configuration to be used by the crawler

property tablePrefix

tablePrefix?: pulumi.Input<string>;

The table prefix used for catalog tables that are created.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface GetScriptArgs

interface GetScriptArgs

A collection of arguments for invoking getScript.

property dagEdges

dagEdges: GetScriptDagEdge[];

A list of the edges in the DAG. Defined below.

property dagNodes

dagNodes: GetScriptDagNode[];

A list of the nodes in the DAG. Defined below.

property language

language?: undefined | string;

The programming language of the resulting code from the DAG. Defaults to PYTHON. Valid values are PYTHON and SCALA.

interface GetScriptResult

interface GetScriptResult

A collection of values returned by getScript.

property dagEdges

dagEdges: GetScriptDagEdge[];

property dagNodes

dagNodes: GetScriptDagNode[];

property id

id: string;

The provider-assigned unique ID for this managed resource.

property language

language?: undefined | string;

property pythonScript

pythonScript: string;

The Python script generated from the DAG when the language argument is set to PYTHON.

property scalaCode

scalaCode: string;

The Scala code generated from the DAG when the language argument is set to SCALA.

interface JobArgs

interface JobArgs

The set of arguments for constructing a Job resource.

property allocatedCapacity

DEPRECATED Please use attribute `max_capacity' instead. This attribute might be removed in future releases.
allocatedCapacity?: pulumi.Input<number>;

DEPRECATED (Optional) The number of AWS Glue data processing units (DPUs) to allocate to this Job. At least 2 DPUs need to be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.

property command

command: pulumi.Input<JobCommand>;

The command of the job. Defined below.

property connections

connections?: pulumi.Input<pulumi.Input<string>[]>;

The list of connections used for this job.

property defaultArguments

defaultArguments?: pulumi.Input<{[key: string]: any}>;

The map of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

property description

description?: pulumi.Input<string>;

Description of the job.

property executionProperty

executionProperty?: pulumi.Input<JobExecutionProperty>;

Execution property of the job. Defined below.

property glueVersion

glueVersion?: pulumi.Input<string>;

The version of glue to use, for example “1.0”. For information about available versions, see the AWS Glue Release Notes.

property maxCapacity

maxCapacity?: pulumi.Input<number>;

The maximum number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. Required when pythonshell is set, accept either 0.0625 or 1.0.

property maxRetries

maxRetries?: pulumi.Input<number>;

The maximum number of times to retry this job if it fails.

property name

name?: pulumi.Input<string>;

The name you assign to this job. It must be unique in your account.

property notificationProperty

notificationProperty?: pulumi.Input<JobNotificationProperty>;

Notification property of the job. Defined below.

property numberOfWorkers

numberOfWorkers?: pulumi.Input<number>;

The number of workers of a defined workerType that are allocated when a job runs.

property roleArn

roleArn: pulumi.Input<string>;

The ARN of the IAM role associated with this job.

property securityConfiguration

securityConfiguration?: pulumi.Input<string>;

The name of the Security Configuration to be associated with the job.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property timeout

timeout?: pulumi.Input<number>;

The job timeout in minutes. The default is 2880 minutes (48 hours).

property workerType

workerType?: pulumi.Input<string>;

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

interface JobState

interface JobState

Input properties used for looking up and filtering Job resources.

property allocatedCapacity

DEPRECATED Please use attribute `max_capacity' instead. This attribute might be removed in future releases.
allocatedCapacity?: pulumi.Input<number>;

DEPRECATED (Optional) The number of AWS Glue data processing units (DPUs) to allocate to this Job. At least 2 DPUs need to be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of Glue Job

property command

command?: pulumi.Input<JobCommand>;

The command of the job. Defined below.

property connections

connections?: pulumi.Input<pulumi.Input<string>[]>;

The list of connections used for this job.

property defaultArguments

defaultArguments?: pulumi.Input<{[key: string]: any}>;

The map of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

property description

description?: pulumi.Input<string>;

Description of the job.

property executionProperty

executionProperty?: pulumi.Input<JobExecutionProperty>;

Execution property of the job. Defined below.

property glueVersion

glueVersion?: pulumi.Input<string>;

The version of glue to use, for example “1.0”. For information about available versions, see the AWS Glue Release Notes.

property maxCapacity

maxCapacity?: pulumi.Input<number>;

The maximum number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. Required when pythonshell is set, accept either 0.0625 or 1.0.

property maxRetries

maxRetries?: pulumi.Input<number>;

The maximum number of times to retry this job if it fails.

property name

name?: pulumi.Input<string>;

The name you assign to this job. It must be unique in your account.

property notificationProperty

notificationProperty?: pulumi.Input<JobNotificationProperty>;

Notification property of the job. Defined below.

property numberOfWorkers

numberOfWorkers?: pulumi.Input<number>;

The number of workers of a defined workerType that are allocated when a job runs.

property roleArn

roleArn?: pulumi.Input<string>;

The ARN of the IAM role associated with this job.

property securityConfiguration

securityConfiguration?: pulumi.Input<string>;

The name of the Security Configuration to be associated with the job.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property timeout

timeout?: pulumi.Input<number>;

The job timeout in minutes. The default is 2880 minutes (48 hours).

property workerType

workerType?: pulumi.Input<string>;

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

interface SecurityConfigurationArgs

interface SecurityConfigurationArgs

The set of arguments for constructing a SecurityConfiguration resource.

property encryptionConfiguration

encryptionConfiguration: pulumi.Input<SecurityConfigurationEncryptionConfiguration>;

Configuration block containing encryption configuration. Detailed below.

property name

name?: pulumi.Input<string>;

Name of the security configuration.

interface SecurityConfigurationState

interface SecurityConfigurationState

Input properties used for looking up and filtering SecurityConfiguration resources.

property encryptionConfiguration

encryptionConfiguration?: pulumi.Input<SecurityConfigurationEncryptionConfiguration>;

Configuration block containing encryption configuration. Detailed below.

property name

name?: pulumi.Input<string>;

Name of the security configuration.

interface TriggerArgs

interface TriggerArgs

The set of arguments for constructing a Trigger resource.

property actions

actions: pulumi.Input<pulumi.Input<TriggerAction>[]>;

List of actions initiated by this trigger when it fires. Defined below.

property description

description?: pulumi.Input<string>;

A description of the new trigger.

property enabled

enabled?: pulumi.Input<boolean>;

Start the trigger. Defaults to true. Not valid to disable for ON_DEMAND type.

property name

name?: pulumi.Input<string>;

The name of the trigger.

property predicate

predicate?: pulumi.Input<TriggerPredicate>;

A predicate to specify when the new trigger should fire. Required when trigger type is CONDITIONAL. Defined below.

property schedule

schedule?: pulumi.Input<string>;

A cron expression used to specify the schedule. Time-Based Schedules for Jobs and Crawlers

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property type

type: pulumi.Input<string>;

The type of trigger. Valid values are CONDITIONAL, ON_DEMAND, and SCHEDULED.

property workflowName

workflowName?: pulumi.Input<string>;

A workflow to which the trigger should be associated to. Every workflow graph (DAG) needs a starting trigger (ON_DEMAND or SCHEDULED type) and can contain multiple additional CONDITIONAL triggers.

interface TriggerState

interface TriggerState

Input properties used for looking up and filtering Trigger resources.

property actions

actions?: pulumi.Input<pulumi.Input<TriggerAction>[]>;

List of actions initiated by this trigger when it fires. Defined below.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of Glue Trigger

property description

description?: pulumi.Input<string>;

A description of the new trigger.

property enabled

enabled?: pulumi.Input<boolean>;

Start the trigger. Defaults to true. Not valid to disable for ON_DEMAND type.

property name

name?: pulumi.Input<string>;

The name of the trigger.

property predicate

predicate?: pulumi.Input<TriggerPredicate>;

A predicate to specify when the new trigger should fire. Required when trigger type is CONDITIONAL. Defined below.

property schedule

schedule?: pulumi.Input<string>;

A cron expression used to specify the schedule. Time-Based Schedules for Jobs and Crawlers

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property type

type?: pulumi.Input<string>;

The type of trigger. Valid values are CONDITIONAL, ON_DEMAND, and SCHEDULED.

property workflowName

workflowName?: pulumi.Input<string>;

A workflow to which the trigger should be associated to. Every workflow graph (DAG) needs a starting trigger (ON_DEMAND or SCHEDULED type) and can contain multiple additional CONDITIONAL triggers.

interface WorkflowArgs

interface WorkflowArgs

The set of arguments for constructing a Workflow resource.

property defaultRunProperties

defaultRunProperties?: pulumi.Input<{[key: string]: any}>;

A map of default run properties for this workflow. These properties are passed to all jobs associated to the workflow.

property description

description?: pulumi.Input<string>;

Description of the workflow.

property name

name?: pulumi.Input<string>;

The name you assign to this workflow.

interface WorkflowState

interface WorkflowState

Input properties used for looking up and filtering Workflow resources.

property defaultRunProperties

defaultRunProperties?: pulumi.Input<{[key: string]: any}>;

A map of default run properties for this workflow. These properties are passed to all jobs associated to the workflow.

property description

description?: pulumi.Input<string>;

Description of the workflow.

property name

name?: pulumi.Input<string>;

The name you assign to this workflow.