1. Packages
  2. AWS Native
  3. API Docs
  4. databrew
  5. Job

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

aws-native.databrew.Job

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

    Resource schema for AWS::DataBrew::Job.

    Example Usage

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var myDataBrewProfileJob = new AwsNative.DataBrew.Job("myDataBrewProfileJob", new()
        {
            Type = AwsNative.DataBrew.JobType.Profile,
            Name = "job-test",
            DatasetName = "dataset-test",
            RoleArn = "arn:aws:iam::1234567891011:role/PassRoleAdmin",
            JobSample = new AwsNative.DataBrew.Inputs.JobSampleArgs
            {
                Mode = AwsNative.DataBrew.JobSampleMode.FullDataset,
            },
            OutputLocation = new AwsNative.DataBrew.Inputs.JobOutputLocationArgs
            {
                Bucket = "test-output",
                Key = "job-output.json",
            },
            Tags = new[]
            {
                new AwsNative.DataBrew.Inputs.JobTagArgs
                {
                    Key = "key00AtCreate",
                    Value = "value001AtCreate",
                },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/databrew"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
    _, err := databrew.NewJob(ctx, "myDataBrewProfileJob", &databrew.JobArgs{
    Type: databrew.JobTypeProfile,
    Name: pulumi.String("job-test"),
    DatasetName: pulumi.String("dataset-test"),
    RoleArn: pulumi.String("arn:aws:iam::1234567891011:role/PassRoleAdmin"),
    JobSample: &databrew.JobSampleArgs{
    Mode: databrew.JobSampleModeFullDataset,
    },
    OutputLocation: interface{}{
    Bucket: pulumi.String("test-output"),
    Key: pulumi.String("job-output.json"),
    },
    Tags: []databrew.JobTagArgs{
    {
    Key: pulumi.String("key00AtCreate"),
    Value: pulumi.String("value001AtCreate"),
    },
    },
    })
    if err != nil {
    return err
    }
    return nil
    })
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    my_data_brew_profile_job = aws_native.databrew.Job("myDataBrewProfileJob",
        type=aws_native.databrew.JobType.PROFILE,
        name="job-test",
        dataset_name="dataset-test",
        role_arn="arn:aws:iam::1234567891011:role/PassRoleAdmin",
        job_sample=aws_native.databrew.JobSampleArgs(
            mode=aws_native.databrew.JobSampleMode.FULL_DATASET,
        ),
        output_location=aws_native.databrew.JobOutputLocationArgs(
            bucket="test-output",
            key="job-output.json",
        ),
        tags=[aws_native.databrew.JobTagArgs(
            key="key00AtCreate",
            value="value001AtCreate",
        )])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const myDataBrewProfileJob = new aws_native.databrew.Job("myDataBrewProfileJob", {
        type: aws_native.databrew.JobType.Profile,
        name: "job-test",
        datasetName: "dataset-test",
        roleArn: "arn:aws:iam::1234567891011:role/PassRoleAdmin",
        jobSample: {
            mode: aws_native.databrew.JobSampleMode.FullDataset,
        },
        outputLocation: {
            bucket: "test-output",
            key: "job-output.json",
        },
        tags: [{
            key: "key00AtCreate",
            value: "value001AtCreate",
        }],
    });
    

    Coming soon!

    Create Job Resource

    new Job(name: string, args: JobArgs, opts?: CustomResourceOptions);
    @overload
    def Job(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            data_catalog_outputs: Optional[Sequence[JobDataCatalogOutputArgs]] = None,
            database_outputs: Optional[Sequence[JobDatabaseOutputArgs]] = None,
            dataset_name: Optional[str] = None,
            encryption_key_arn: Optional[str] = None,
            encryption_mode: Optional[JobEncryptionMode] = None,
            job_sample: Optional[JobSampleArgs] = None,
            log_subscription: Optional[JobLogSubscription] = None,
            max_capacity: Optional[int] = None,
            max_retries: Optional[int] = None,
            name: Optional[str] = None,
            output_location: Optional[JobOutputLocationArgs] = None,
            outputs: Optional[Sequence[JobOutputArgs]] = None,
            profile_configuration: Optional[JobProfileConfigurationArgs] = None,
            project_name: Optional[str] = None,
            recipe: Optional[JobRecipeArgs] = None,
            role_arn: Optional[str] = None,
            tags: Optional[Sequence[JobTagArgs]] = None,
            timeout: Optional[int] = None,
            type: Optional[JobType] = None,
            validation_configurations: Optional[Sequence[JobValidationConfigurationArgs]] = None)
    @overload
    def Job(resource_name: str,
            args: JobArgs,
            opts: Optional[ResourceOptions] = None)
    func NewJob(ctx *Context, name string, args JobArgs, opts ...ResourceOption) (*Job, error)
    public Job(string name, JobArgs args, CustomResourceOptions? opts = null)
    public Job(String name, JobArgs args)
    public Job(String name, JobArgs args, CustomResourceOptions options)
    
    type: aws-native:databrew:Job
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Job Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Job resource accepts the following input properties:

    RoleArn string
    Role arn
    Type Pulumi.AwsNative.DataBrew.JobType
    Job type
    DataCatalogOutputs List<Pulumi.AwsNative.DataBrew.Inputs.JobDataCatalogOutput>
    DatabaseOutputs List<Pulumi.AwsNative.DataBrew.Inputs.JobDatabaseOutput>
    DatasetName string
    Dataset name
    EncryptionKeyArn string
    Encryption Key Arn
    EncryptionMode Pulumi.AwsNative.DataBrew.JobEncryptionMode
    Encryption mode
    JobSample Pulumi.AwsNative.DataBrew.Inputs.JobSample
    Job Sample
    LogSubscription Pulumi.AwsNative.DataBrew.JobLogSubscription
    Log subscription
    MaxCapacity int
    Max capacity
    MaxRetries int
    Max retries
    Name string
    Job name
    OutputLocation Pulumi.AwsNative.DataBrew.Inputs.JobOutputLocation
    Output location
    Outputs List<Pulumi.AwsNative.DataBrew.Inputs.JobOutput>
    ProfileConfiguration Pulumi.AwsNative.DataBrew.Inputs.JobProfileConfiguration
    Profile Job configuration
    ProjectName string
    Project name
    Recipe Pulumi.AwsNative.DataBrew.Inputs.JobRecipe
    Tags List<Pulumi.AwsNative.DataBrew.Inputs.JobTag>
    Timeout int
    Timeout
    ValidationConfigurations List<Pulumi.AwsNative.DataBrew.Inputs.JobValidationConfiguration>
    Data quality rules configuration
    roleArn string
    Role arn
    type JobType
    Job type
    dataCatalogOutputs JobDataCatalogOutput[]
    databaseOutputs JobDatabaseOutput[]
    datasetName string
    Dataset name
    encryptionKeyArn string
    Encryption Key Arn
    encryptionMode JobEncryptionMode
    Encryption mode
    jobSample JobSample
    Job Sample
    logSubscription JobLogSubscription
    Log subscription
    maxCapacity number
    Max capacity
    maxRetries number
    Max retries
    name string
    Job name
    outputLocation JobOutputLocation
    Output location
    outputs JobOutput[]
    profileConfiguration JobProfileConfiguration
    Profile Job configuration
    projectName string
    Project name
    recipe JobRecipe
    tags JobTag[]
    timeout number
    Timeout
    validationConfigurations JobValidationConfiguration[]
    Data quality rules configuration

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Job resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    JobAllowedStatistics, JobAllowedStatisticsArgs

    Statistics List<string>
    Statistics []string
    statistics List<String>
    statistics string[]
    statistics Sequence[str]
    statistics List<String>

    JobColumnSelector, JobColumnSelectorArgs

    Name string
    Regex string
    Name string
    Regex string
    name String
    regex String
    name string
    regex string
    name str
    regex str
    name String
    regex String

    JobColumnStatisticsConfiguration, JobColumnStatisticsConfigurationArgs

    JobCsvOutputOptions, JobCsvOutputOptionsArgs

    Delimiter string
    Delimiter string
    delimiter String
    delimiter string
    delimiter String

    JobDataCatalogOutput, JobDataCatalogOutputArgs

    JobDatabaseOutput, JobDatabaseOutputArgs

    JobDatabaseOutputDatabaseOutputMode, JobDatabaseOutputDatabaseOutputModeArgs

    NewTable
    NEW_TABLE
    JobDatabaseOutputDatabaseOutputModeNewTable
    NEW_TABLE
    NewTable
    NEW_TABLE
    NewTable
    NEW_TABLE
    NEW_TABLE
    NEW_TABLE
    "NEW_TABLE"
    NEW_TABLE

    JobDatabaseTableOutputOptions, JobDatabaseTableOutputOptionsArgs

    JobEncryptionMode, JobEncryptionModeArgs

    SseKms
    SSE-KMS
    SseS3
    SSE-S3
    JobEncryptionModeSseKms
    SSE-KMS
    JobEncryptionModeSseS3
    SSE-S3
    SseKms
    SSE-KMS
    SseS3
    SSE-S3
    SseKms
    SSE-KMS
    SseS3
    SSE-S3
    SSE_KMS
    SSE-KMS
    SSE_S3
    SSE-S3
    "SSE-KMS"
    SSE-KMS
    "SSE-S3"
    SSE-S3

    JobEntityDetectorConfiguration, JobEntityDetectorConfigurationArgs

    JobLogSubscription, JobLogSubscriptionArgs

    Enable
    ENABLE
    Disable
    DISABLE
    JobLogSubscriptionEnable
    ENABLE
    JobLogSubscriptionDisable
    DISABLE
    Enable
    ENABLE
    Disable
    DISABLE
    Enable
    ENABLE
    Disable
    DISABLE
    ENABLE
    ENABLE
    DISABLE
    DISABLE
    "ENABLE"
    ENABLE
    "DISABLE"
    DISABLE

    JobOutput, JobOutputArgs

    JobOutputCompressionFormat, JobOutputCompressionFormatArgs

    Gzip
    GZIP
    Lz4
    LZ4
    Snappy
    SNAPPY
    Bzip2
    BZIP2
    Deflate
    DEFLATE
    Lzo
    LZO
    Brotli
    BROTLI
    Zstd
    ZSTD
    Zlib
    ZLIB
    JobOutputCompressionFormatGzip
    GZIP
    JobOutputCompressionFormatLz4
    LZ4
    JobOutputCompressionFormatSnappy
    SNAPPY
    JobOutputCompressionFormatBzip2
    BZIP2
    JobOutputCompressionFormatDeflate
    DEFLATE
    JobOutputCompressionFormatLzo
    LZO
    JobOutputCompressionFormatBrotli
    BROTLI
    JobOutputCompressionFormatZstd
    ZSTD
    JobOutputCompressionFormatZlib
    ZLIB
    Gzip
    GZIP
    Lz4
    LZ4
    Snappy
    SNAPPY
    Bzip2
    BZIP2
    Deflate
    DEFLATE
    Lzo
    LZO
    Brotli
    BROTLI
    Zstd
    ZSTD
    Zlib
    ZLIB
    Gzip
    GZIP
    Lz4
    LZ4
    Snappy
    SNAPPY
    Bzip2
    BZIP2
    Deflate
    DEFLATE
    Lzo
    LZO
    Brotli
    BROTLI
    Zstd
    ZSTD
    Zlib
    ZLIB
    GZIP
    GZIP
    LZ4
    LZ4
    SNAPPY
    SNAPPY
    BZIP2
    BZIP2
    DEFLATE
    DEFLATE
    LZO
    LZO
    BROTLI
    BROTLI
    ZSTD
    ZSTD
    ZLIB
    ZLIB
    "GZIP"
    GZIP
    "LZ4"
    LZ4
    "SNAPPY"
    SNAPPY
    "BZIP2"
    BZIP2
    "DEFLATE"
    DEFLATE
    "LZO"
    LZO
    "BROTLI"
    BROTLI
    "ZSTD"
    ZSTD
    "ZLIB"
    ZLIB

    JobOutputFormat, JobOutputFormatArgs

    Csv
    CSV
    Json
    JSON
    Parquet
    PARQUET
    Glueparquet
    GLUEPARQUET
    Avro
    AVRO
    Orc
    ORC
    Xml
    XML
    Tableauhyper
    TABLEAUHYPER
    JobOutputFormatCsv
    CSV
    JobOutputFormatJson
    JSON
    JobOutputFormatParquet
    PARQUET
    JobOutputFormatGlueparquet
    GLUEPARQUET
    JobOutputFormatAvro
    AVRO
    JobOutputFormatOrc
    ORC
    JobOutputFormatXml
    XML
    JobOutputFormatTableauhyper
    TABLEAUHYPER
    Csv
    CSV
    Json
    JSON
    Parquet
    PARQUET
    Glueparquet
    GLUEPARQUET
    Avro
    AVRO
    Orc
    ORC
    Xml
    XML
    Tableauhyper
    TABLEAUHYPER
    Csv
    CSV
    Json
    JSON
    Parquet
    PARQUET
    Glueparquet
    GLUEPARQUET
    Avro
    AVRO
    Orc
    ORC
    Xml
    XML
    Tableauhyper
    TABLEAUHYPER
    CSV
    CSV
    JSON
    JSON
    PARQUET
    PARQUET
    GLUEPARQUET
    GLUEPARQUET
    AVRO
    AVRO
    ORC
    ORC
    XML
    XML
    TABLEAUHYPER
    TABLEAUHYPER
    "CSV"
    CSV
    "JSON"
    JSON
    "PARQUET"
    PARQUET
    "GLUEPARQUET"
    GLUEPARQUET
    "AVRO"
    AVRO
    "ORC"
    ORC
    "XML"
    XML
    "TABLEAUHYPER"
    TABLEAUHYPER

    JobOutputFormatOptions, JobOutputFormatOptionsArgs

    JobOutputLocation, JobOutputLocationArgs

    Bucket string
    BucketOwner string
    Key string
    Bucket string
    BucketOwner string
    Key string
    bucket String
    bucketOwner String
    key String
    bucket string
    bucketOwner string
    key string
    bucket String
    bucketOwner String
    key String

    JobProfileConfiguration, JobProfileConfigurationArgs

    JobRecipe, JobRecipeArgs

    Name string
    Recipe name
    Version string
    Recipe version
    Name string
    Recipe name
    Version string
    Recipe version
    name String
    Recipe name
    version String
    Recipe version
    name string
    Recipe name
    version string
    Recipe version
    name str
    Recipe name
    version str
    Recipe version
    name String
    Recipe name
    version String
    Recipe version

    JobS3Location, JobS3LocationArgs

    Bucket string
    BucketOwner string
    Key string
    Bucket string
    BucketOwner string
    Key string
    bucket String
    bucketOwner String
    key String
    bucket string
    bucketOwner string
    key string
    bucket String
    bucketOwner String
    key String

    JobS3TableOutputOptions, JobS3TableOutputOptionsArgs

    JobSample, JobSampleArgs

    JobSampleMode, JobSampleModeArgs

    FullDataset
    FULL_DATASET
    CustomRows
    CUSTOM_ROWS
    JobSampleModeFullDataset
    FULL_DATASET
    JobSampleModeCustomRows
    CUSTOM_ROWS
    FullDataset
    FULL_DATASET
    CustomRows
    CUSTOM_ROWS
    FullDataset
    FULL_DATASET
    CustomRows
    CUSTOM_ROWS
    FULL_DATASET
    FULL_DATASET
    CUSTOM_ROWS
    CUSTOM_ROWS
    "FULL_DATASET"
    FULL_DATASET
    "CUSTOM_ROWS"
    CUSTOM_ROWS

    JobStatisticOverride, JobStatisticOverrideArgs

    JobStatisticsConfiguration, JobStatisticsConfigurationArgs

    JobTag, JobTagArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    JobType, JobTypeArgs

    Profile
    PROFILE
    Recipe
    RECIPE
    JobTypeProfile
    PROFILE
    JobTypeRecipe
    RECIPE
    Profile
    PROFILE
    Recipe
    RECIPE
    Profile
    PROFILE
    Recipe
    RECIPE
    PROFILE
    PROFILE
    RECIPE
    RECIPE
    "PROFILE"
    PROFILE
    "RECIPE"
    RECIPE

    JobValidationConfiguration, JobValidationConfigurationArgs

    rulesetArn String
    Arn of the Ruleset
    validationMode "CHECK_ALL"

    JobValidationMode, JobValidationModeArgs

    CheckAll
    CHECK_ALL
    JobValidationModeCheckAll
    CHECK_ALL
    CheckAll
    CHECK_ALL
    CheckAll
    CHECK_ALL
    CHECK_ALL
    CHECK_ALL
    "CHECK_ALL"
    CHECK_ALL

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi