aws-native.databrew.Job
Resource schema for AWS::DataBrew::Job.
Example Usage
Example
using System.Collections.Generic;
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",
},
},
});
});
Coming soon!
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)
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:
- Role
Arn string Role arn
- Type
Pulumi.
Aws Native. Data Brew. Job Type Job type
- Data
Catalog List<Pulumi.Outputs Aws Native. Data Brew. Inputs. Job Data Catalog Output Args> - Database
Outputs List<Pulumi.Aws Native. Data Brew. Inputs. Job Database Output Args> - Dataset
Name string Dataset name
- Encryption
Key stringArn Encryption Key Arn
- Encryption
Mode Pulumi.Aws Native. Data Brew. Job Encryption Mode Encryption mode
- Job
Sample Pulumi.Aws Native. Data Brew. Inputs. Job Sample Args Job Sample
- Log
Subscription Pulumi.Aws Native. Data Brew. Job Log Subscription Log subscription
- Max
Capacity int Max capacity
- Max
Retries int Max retries
- Name string
Job name
- Output
Location Pulumi.Aws Native. Data Brew. Inputs. Job Output Location Args Output location
- Outputs
List<Pulumi.
Aws Native. Data Brew. Inputs. Job Output Args> - Profile
Configuration Pulumi.Aws Native. Data Brew. Inputs. Job Profile Configuration Args Profile Job configuration
- Project
Name string Project name
- Recipe
Pulumi.
Aws Native. Data Brew. Inputs. Job Recipe Args - List<Pulumi.
Aws Native. Data Brew. Inputs. Job Tag Args> - Timeout int
Timeout
- Validation
Configurations List<Pulumi.Aws Native. Data Brew. Inputs. Job Validation Configuration Args> Data quality rules configuration
- Role
Arn string Role arn
- Type
Job
Type Job type
- Data
Catalog []JobOutputs Data Catalog Output Args - Database
Outputs []JobDatabase Output Args - Dataset
Name string Dataset name
- Encryption
Key stringArn Encryption Key Arn
- Encryption
Mode JobEncryption Mode Encryption mode
- Job
Sample JobSample Args Job Sample
- Log
Subscription JobLog Subscription Log subscription
- Max
Capacity int Max capacity
- Max
Retries int Max retries
- Name string
Job name
- Output
Location JobOutput Location Args Output location
- Outputs
[]Job
Output Type Args - Profile
Configuration JobProfile Configuration Args Profile Job configuration
- Project
Name string Project name
- Recipe
Job
Recipe Args - []Job
Tag Args - Timeout int
Timeout
- Validation
Configurations []JobValidation Configuration Args Data quality rules configuration
- role
Arn String Role arn
- type
Job
Type Job type
- data
Catalog List<JobOutputs Data Catalog Output Args> - database
Outputs List<JobDatabase Output Args> - dataset
Name String Dataset name
- encryption
Key StringArn Encryption Key Arn
- encryption
Mode JobEncryption Mode Encryption mode
- job
Sample JobSample Args Job Sample
- log
Subscription JobLog Subscription Log subscription
- max
Capacity Integer Max capacity
- max
Retries Integer Max retries
- name String
Job name
- output
Location JobOutput Location Args Output location
- outputs
List<Job
Output Args> - profile
Configuration JobProfile Configuration Args Profile Job configuration
- project
Name String Project name
- recipe
Job
Recipe Args - List<Job
Tag Args> - timeout Integer
Timeout
- validation
Configurations List<JobValidation Configuration Args> Data quality rules configuration
- role
Arn string Role arn
- type
Job
Type Job type
- data
Catalog JobOutputs Data Catalog Output Args[] - database
Outputs JobDatabase Output Args[] - dataset
Name string Dataset name
- encryption
Key stringArn Encryption Key Arn
- encryption
Mode JobEncryption Mode Encryption mode
- job
Sample JobSample Args Job Sample
- log
Subscription JobLog Subscription Log subscription
- max
Capacity number Max capacity
- max
Retries number Max retries
- name string
Job name
- output
Location JobOutput Location Args Output location
- outputs
Job
Output Args[] - profile
Configuration JobProfile Configuration Args Profile Job configuration
- project
Name string Project name
- recipe
Job
Recipe Args - Job
Tag Args[] - timeout number
Timeout
- validation
Configurations JobValidation Configuration Args[] Data quality rules configuration
- role_
arn str Role arn
- type
Job
Type Job type
- data_
catalog_ Sequence[Joboutputs Data Catalog Output Args] - database_
outputs Sequence[JobDatabase Output Args] - dataset_
name str Dataset name
- encryption_
key_ strarn Encryption Key Arn
- encryption_
mode JobEncryption Mode Encryption mode
- job_
sample JobSample Args Job Sample
- log_
subscription JobLog Subscription Log subscription
- max_
capacity int Max capacity
- max_
retries int Max retries
- name str
Job name
- output_
location JobOutput Location Args Output location
- outputs
Sequence[Job
Output Args] - profile_
configuration JobProfile Configuration Args Profile Job configuration
- project_
name str Project name
- recipe
Job
Recipe Args - Sequence[Job
Tag Args] - timeout int
Timeout
- validation_
configurations Sequence[JobValidation Configuration Args] Data quality rules configuration
- role
Arn String Role arn
- type "PROFILE" | "RECIPE"
Job type
- data
Catalog List<Property Map>Outputs - database
Outputs List<Property Map> - dataset
Name String Dataset name
- encryption
Key StringArn Encryption Key Arn
- encryption
Mode "SSE-KMS" | "SSE-S3" Encryption mode
- job
Sample Property Map Job Sample
- log
Subscription "ENABLE" | "DISABLE" Log subscription
- max
Capacity Number Max capacity
- max
Retries Number Max retries
- name String
Job name
- output
Location Property Map Output location
- outputs List<Property Map>
- profile
Configuration Property Map Profile Job configuration
- project
Name String Project name
- recipe Property Map
- List<Property Map>
- timeout Number
Timeout
- validation
Configurations List<Property Map> 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
- Statistics List<string>
- Statistics []string
- statistics List<String>
- statistics string[]
- statistics Sequence[str]
- statistics List<String>
JobColumnSelector
JobColumnStatisticsConfiguration
JobCsvOutputOptions
- Delimiter string
- Delimiter string
- delimiter String
- delimiter string
- delimiter str
- delimiter String
JobDataCatalogOutput
- database
Name String - table
Name String - catalog
Id String - database
Options JobDatabase Table Output Options - overwrite Boolean
- s3Options
Job
S3Table Output Options
- database
Name string - table
Name string - catalog
Id string - database
Options JobDatabase Table Output Options - overwrite boolean
- s3Options
Job
S3Table Output Options
- database
Name String - table
Name String - catalog
Id String - database
Options Property Map - overwrite Boolean
- s3Options Property Map
JobDatabaseOutput
- Database
Options Pulumi.Aws Native. Data Brew. Inputs. Job Database Table Output Options - Glue
Connection stringName Glue connection name
- Database
Output Pulumi.Mode Aws Native. Data Brew. Job Database Output Database Output Mode Database table name
- Database
Options JobDatabase Table Output Options - Glue
Connection stringName Glue connection name
- Database
Output JobMode Database Output Database Output Mode Database table name
- database
Options JobDatabase Table Output Options - glue
Connection StringName Glue connection name
- database
Output JobMode Database Output Database Output Mode Database table name
- database
Options JobDatabase Table Output Options - glue
Connection stringName Glue connection name
- database
Output JobMode Database Output Database Output Mode Database table name
- database_
options JobDatabase Table Output Options - glue_
connection_ strname Glue connection name
- database_
output_ Jobmode Database Output Database Output Mode Database table name
- database
Options Property Map - glue
Connection StringName Glue connection name
- database
Output "NEW_TABLE"Mode Database table name
JobDatabaseOutputDatabaseOutputMode
- New
Table - NEW_TABLE
- Job
Database Output Database Output Mode New Table - NEW_TABLE
- New
Table - NEW_TABLE
- New
Table - NEW_TABLE
- NEW_TABLE
- NEW_TABLE
- "NEW_TABLE"
- NEW_TABLE
JobDatabaseTableOutputOptions
JobEncryptionMode
- Sse
Kms - SSE-KMS
- Sse
S3 - SSE-S3
- Job
Encryption Mode Sse Kms - SSE-KMS
- Job
Encryption Mode Sse S3 - SSE-S3
- Sse
Kms - SSE-KMS
- Sse
S3 - SSE-S3
- Sse
Kms - SSE-KMS
- Sse
S3 - SSE-S3
- SSE_KMS
- SSE-KMS
- SSE_S3
- SSE-S3
- "SSE-KMS"
- SSE-KMS
- "SSE-S3"
- SSE-S3
JobEntityDetectorConfiguration
- entity
Types List<String> - allowed
Statistics JobAllowed Statistics
- entity_
types Sequence[str] - allowed_
statistics JobAllowed Statistics
- entity
Types List<String> - allowed
Statistics Property Map
JobLogSubscription
- Enable
- ENABLE
- Disable
- DISABLE
- Job
Log Subscription Enable - ENABLE
- Job
Log Subscription Disable - DISABLE
- Enable
- ENABLE
- Disable
- DISABLE
- Enable
- ENABLE
- Disable
- DISABLE
- ENABLE
- ENABLE
- DISABLE
- DISABLE
- "ENABLE"
- ENABLE
- "DISABLE"
- DISABLE
JobOutput
- Location
Pulumi.
Aws Native. Data Brew. Inputs. Job S3Location - Compression
Format Pulumi.Aws Native. Data Brew. Job Output Compression Format - Format
Pulumi.
Aws Native. Data Brew. Job Output Format - Format
Options Pulumi.Aws Native. Data Brew. Inputs. Job Output Format Options - Max
Output intFiles - Overwrite bool
- Partition
Columns List<string>
- location Property Map
- compression
Format "GZIP" | "LZ4" | "SNAPPY" | "BZIP2" | "DEFLATE" | "LZO" | "BROTLI" | "ZSTD" | "ZLIB" - format "CSV" | "JSON" | "PARQUET" | "GLUEPARQUET" | "AVRO" | "ORC" | "XML" | "TABLEAUHYPER"
- format
Options Property Map - max
Output NumberFiles - overwrite Boolean
- partition
Columns List<String>
JobOutputCompressionFormat
- Gzip
- GZIP
- Lz4
- LZ4
- Snappy
- SNAPPY
- Bzip2
- BZIP2
- Deflate
- DEFLATE
- Lzo
- LZO
- Brotli
- BROTLI
- Zstd
- ZSTD
- Zlib
- ZLIB
- Job
Output Compression Format Gzip - GZIP
- Job
Output Compression Format Lz4 - LZ4
- Job
Output Compression Format Snappy - SNAPPY
- Job
Output Compression Format Bzip2 - BZIP2
- Job
Output Compression Format Deflate - DEFLATE
- Job
Output Compression Format Lzo - LZO
- Job
Output Compression Format Brotli - BROTLI
- Job
Output Compression Format Zstd - ZSTD
- Job
Output Compression Format 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
- "GZIP"
- GZIP
- "LZ4"
- LZ4
- "SNAPPY"
- SNAPPY
- "BZIP2"
- BZIP2
- "DEFLATE"
- DEFLATE
- "LZO"
- LZO
- "BROTLI"
- BROTLI
- "ZSTD"
- ZSTD
- "ZLIB"
- ZLIB
JobOutputFormat
- Csv
- CSV
- Json
- JSON
- Parquet
- PARQUET
- Glueparquet
- GLUEPARQUET
- Avro
- AVRO
- Orc
- ORC
- Xml
- XML
- Tableauhyper
- TABLEAUHYPER
- Job
Output Format Csv - CSV
- Job
Output Format Json - JSON
- Job
Output Format Parquet - PARQUET
- Job
Output Format Glueparquet - GLUEPARQUET
- Job
Output Format Avro - AVRO
- Job
Output Format Orc - ORC
- Job
Output Format Xml - XML
- Job
Output Format 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
- "CSV"
- CSV
- "JSON"
- JSON
- "PARQUET"
- PARQUET
- "GLUEPARQUET"
- GLUEPARQUET
- "AVRO"
- AVRO
- "ORC"
- ORC
- "XML"
- XML
- "TABLEAUHYPER"
- TABLEAUHYPER
JobOutputFormatOptions
JobOutputLocation
- Bucket string
- Bucket
Owner string - Key string
- Bucket string
- Bucket
Owner string - Key string
- bucket String
- bucket
Owner String - key String
- bucket string
- bucket
Owner string - key string
- bucket str
- bucket_
owner str - key str
- bucket String
- bucket
Owner String - key String
JobProfileConfiguration
- Column
Statistics List<Pulumi.Configurations Aws Native. Data Brew. Inputs. Job Column Statistics Configuration> - Dataset
Statistics Pulumi.Configuration Aws Native. Data Brew. Inputs. Job Statistics Configuration - Entity
Detector Pulumi.Configuration Aws Native. Data Brew. Inputs. Job Entity Detector Configuration - Profile
Columns List<Pulumi.Aws Native. Data Brew. Inputs. Job Column Selector>
JobRecipe
JobS3Location
- Bucket string
- Bucket
Owner string - Key string
- Bucket string
- Bucket
Owner string - Key string
- bucket String
- bucket
Owner String - key String
- bucket string
- bucket
Owner string - key string
- bucket str
- bucket_
owner str - key str
- bucket String
- bucket
Owner String - key String
JobS3TableOutputOptions
JobSample
- mode
Job
Sample Mode - size Integer
- mode
Job
Sample Mode - size number
JobSampleMode
- Full
Dataset - FULL_DATASET
- Custom
Rows - CUSTOM_ROWS
- Job
Sample Mode Full Dataset - FULL_DATASET
- Job
Sample Mode Custom Rows - CUSTOM_ROWS
- Full
Dataset - FULL_DATASET
- Custom
Rows - CUSTOM_ROWS
- Full
Dataset - FULL_DATASET
- Custom
Rows - CUSTOM_ROWS
- FULL_DATASET
- FULL_DATASET
- CUSTOM_ROWS
- CUSTOM_ROWS
- "FULL_DATASET"
- FULL_DATASET
- "CUSTOM_ROWS"
- CUSTOM_ROWS
JobStatisticOverride
- parameters Property Map
- statistic String
JobStatisticsConfiguration
- included
Statistics List<String> - overrides
List<Job
Statistic Override>
- included_
statistics Sequence[str] - overrides
Sequence[Job
Statistic Override]
- included
Statistics List<String> - overrides List<Property Map>
JobTag
JobType
- Profile
- PROFILE
- Recipe
- RECIPE
- Job
Type Profile - PROFILE
- Job
Type Recipe - RECIPE
- Profile
- PROFILE
- Recipe
- RECIPE
- Profile
- PROFILE
- Recipe
- RECIPE
- PROFILE
- PROFILE
- RECIPE
- RECIPE
- "PROFILE"
- PROFILE
- "RECIPE"
- RECIPE
JobValidationConfiguration
- Ruleset
Arn string Arn of the Ruleset
- Validation
Mode Pulumi.Aws Native. Data Brew. Job Validation Mode
- Ruleset
Arn string Arn of the Ruleset
- Validation
Mode JobValidation Mode
- ruleset
Arn String Arn of the Ruleset
- validation
Mode JobValidation Mode
- ruleset
Arn string Arn of the Ruleset
- validation
Mode JobValidation Mode
- ruleset_
arn str Arn of the Ruleset
- validation_
mode JobValidation Mode
- ruleset
Arn String Arn of the Ruleset
- validation
Mode "CHECK_ALL"
JobValidationMode
- Check
All - CHECK_ALL
- Job
Validation Mode Check All - CHECK_ALL
- Check
All - CHECK_ALL
- Check
All - CHECK_ALL
- CHECK_ALL
- CHECK_ALL
- "CHECK_ALL"
- CHECK_ALL
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0