aws-cdk-lib.aws_databrew.CfnJob

CfnJob L1 construct

Specifies a new DataBrew job.

Construct›CfnElement›CfnRefElement›CfnResource›CfnJob

implements

• IInspectable,
• ITaggable,
• IEnvironmentAware,
• IJobRef,
• IConstruct,
• 1 more

  • IDependable

CloudFormation

AWS::DataBrew::Job

Source

Generated code

Type last changed

v2.252.0 · 30 Apr 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_databrew as databrew } from 'aws-cdk-lib';
const cfnJob = new databrew.CfnJob(this, 'MyCfnJob', {
  name: 'name',
  roleArn: 'roleArn',
  type: 'type',

  // the properties below are optional
  databaseOutputs: [{
    databaseOptions: {
      tableName: 'tableName',

      // the properties below are optional
      tempDirectory: {
        bucket: 'bucket',

        // the properties below are optional
        bucketOwner: 'bucketOwner',
        key: 'key',
      },
    },
    glueConnectionName: 'glueConnectionName',

    // the properties below are optional
    databaseOutputMode: 'databaseOutputMode',
  }],
  dataCatalogOutputs: [{
    databaseName: 'databaseName',
    tableName: 'tableName',

    // the properties below are optional
    catalogId: 'catalogId',
    databaseOptions: {
      tableName: 'tableName',

      // the properties below are optional
      tempDirectory: {
        bucket: 'bucket',

        // the properties below are optional
        bucketOwner: 'bucketOwner',
        key: 'key',
      },
    },
    overwrite: false,
    s3Options: {
      location: {
        bucket: 'bucket',

        // the properties below are optional
        bucketOwner: 'bucketOwner',
        key: 'key',
      },
    },
  }],
  datasetName: 'datasetName',
  encryptionKeyArn: 'encryptionKeyArn',
  encryptionMode: 'encryptionMode',
  jobSample: {
    mode: 'mode',
    size: 123,
  },
  logSubscription: 'logSubscription',
  maxCapacity: 123,
  maxRetries: 123,
  outputLocation: {
    bucket: 'bucket',

    // the properties below are optional
    bucketOwner: 'bucketOwner',
    key: 'key',
  },
  outputs: [{
    location: {
      bucket: 'bucket',

      // the properties below are optional
      bucketOwner: 'bucketOwner',
      key: 'key',
    },

    // the properties below are optional
    compressionFormat: 'compressionFormat',
    format: 'format',
    formatOptions: {
      csv: {
        delimiter: 'delimiter',
      },
    },
    maxOutputFiles: 123,
    overwrite: false,
    partitionColumns: ['partitionColumns'],
  }],
  profileConfiguration: {
    columnStatisticsConfigurations: [{
      statistics: {
        includedStatistics: ['includedStatistics'],
        overrides: [{
          parameters: {
            parametersKey: 'parameters',
          },
          statistic: 'statistic',
        }],
      },

      // the properties below are optional
      selectors: [{
        name: 'name',
        regex: 'regex',
      }],
    }],
    datasetStatisticsConfiguration: {
      includedStatistics: ['includedStatistics'],
      overrides: [{
        parameters: {
          parametersKey: 'parameters',
        },
        statistic: 'statistic',
      }],
    },
    entityDetectorConfiguration: {
      entityTypes: ['entityTypes'],

      // the properties below are optional
      allowedStatistics: {
        statistics: ['statistics'],
      },
    },
    profileColumns: [{
      name: 'name',
      regex: 'regex',
    }],
  },
  projectName: 'projectName',
  recipe: {
    name: 'name',

    // the properties below are optional
    version: 'version',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeout: 123,
  validationConfigurations: [{
    rulesetArn: 'rulesetArn',

    // the properties below are optional
    validationMode: 'validationMode',
  }],
});

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_databrew as databrew

cfn_job = databrew.CfnJob(self, "MyCfnJob",
    name="name",
    role_arn="roleArn",
    type="type",

    # the properties below are optional
    database_outputs=[databrew.CfnJob.DatabaseOutputProperty(
        database_options=databrew.CfnJob.DatabaseTableOutputOptionsProperty(
            table_name="tableName",

            # the properties below are optional
            temp_directory=databrew.CfnJob.S3LocationProperty(
                bucket="bucket",

                # the properties below are optional
                bucket_owner="bucketOwner",
                key="key"
            )
        ),
        glue_connection_name="glueConnectionName",

        # the properties below are optional
        database_output_mode="databaseOutputMode"
    )],
    data_catalog_outputs=[databrew.CfnJob.DataCatalogOutputProperty(
        database_name="databaseName",
        table_name="tableName",

        # the properties below are optional
        catalog_id="catalogId",
        database_options=databrew.CfnJob.DatabaseTableOutputOptionsProperty(
            table_name="tableName",

            # the properties below are optional
            temp_directory=databrew.CfnJob.S3LocationProperty(
                bucket="bucket",

                # the properties below are optional
                bucket_owner="bucketOwner",
                key="key"
            )
        ),
        overwrite=False,
        s3_options=databrew.CfnJob.S3TableOutputOptionsProperty(
            location=databrew.CfnJob.S3LocationProperty(
                bucket="bucket",

                # the properties below are optional
                bucket_owner="bucketOwner",
                key="key"
            )
        )
    )],
    dataset_name="datasetName",
    encryption_key_arn="encryptionKeyArn",
    encryption_mode="encryptionMode",
    job_sample=databrew.CfnJob.JobSampleProperty(
        mode="mode",
        size=123
    ),
    log_subscription="logSubscription",
    max_capacity=123,
    max_retries=123,
    output_location=databrew.CfnJob.OutputLocationProperty(
        bucket="bucket",

        # the properties below are optional
        bucket_owner="bucketOwner",
        key="key"
    ),
    outputs=[databrew.CfnJob.OutputProperty(
        location=databrew.CfnJob.S3LocationProperty(
            bucket="bucket",

            # the properties below are optional
            bucket_owner="bucketOwner",
            key="key"
        ),

        # the properties below are optional
        compression_format="compressionFormat",
        format="format",
        format_options=databrew.CfnJob.OutputFormatOptionsProperty(
            csv=databrew.CfnJob.CsvOutputOptionsProperty(
                delimiter="delimiter"
            )
        ),
        max_output_files=123,
        overwrite=False,
        partition_columns=["partitionColumns"]
    )],
    profile_configuration=databrew.CfnJob.ProfileConfigurationProperty(
        column_statistics_configurations=[databrew.CfnJob.ColumnStatisticsConfigurationProperty(
            statistics=databrew.CfnJob.StatisticsConfigurationProperty(
                included_statistics=["includedStatistics"],
                overrides=[databrew.CfnJob.StatisticOverrideProperty(
                    parameters={
                        "parameters_key": "parameters"
                    },
                    statistic="statistic"
                )]
            ),

            # the properties below are optional
            selectors=[databrew.CfnJob.ColumnSelectorProperty(
                name="name",
                regex="regex"
            )]
        )],
        dataset_statistics_configuration=databrew.CfnJob.StatisticsConfigurationProperty(
            included_statistics=["includedStatistics"],
            overrides=[databrew.CfnJob.StatisticOverrideProperty(
                parameters={
                    "parameters_key": "parameters"
                },
                statistic="statistic"
            )]
        ),
        entity_detector_configuration=databrew.CfnJob.EntityDetectorConfigurationProperty(
            entity_types=["entityTypes"],

            # the properties below are optional
            allowed_statistics=databrew.CfnJob.AllowedStatisticsProperty(
                statistics=["statistics"]
            )
        ),
        profile_columns=[databrew.CfnJob.ColumnSelectorProperty(
            name="name",
            regex="regex"
        )]
    ),
    project_name="projectName",
    recipe=databrew.CfnJob.RecipeProperty(
        name="name",

        # the properties below are optional
        version="version"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    timeout=123,
    validation_configurations=[databrew.CfnJob.ValidationConfigurationProperty(
        ruleset_arn="rulesetArn",

        # the properties below are optional
        validation_mode="validationMode"
    )]
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.databrew.*;

CfnJob cfnJob = CfnJob.Builder.create(this, "MyCfnJob")
        .name("name")
        .roleArn("roleArn")
        .type("type")

        // the properties below are optional
        .databaseOutputs(List.of(DatabaseOutputProperty.builder()
                .databaseOptions(DatabaseTableOutputOptionsProperty.builder()
                        .tableName("tableName")

                        // the properties below are optional
                        .tempDirectory(S3LocationProperty.builder()
                                .bucket("bucket")

                                // the properties below are optional
                                .bucketOwner("bucketOwner")
                                .key("key")
                                .build())
                        .build())
                .glueConnectionName("glueConnectionName")

                // the properties below are optional
                .databaseOutputMode("databaseOutputMode")
                .build()))
        .dataCatalogOutputs(List.of(DataCatalogOutputProperty.builder()
                .databaseName("databaseName")
                .tableName("tableName")

                // the properties below are optional
                .catalogId("catalogId")
                .databaseOptions(DatabaseTableOutputOptionsProperty.builder()
                        .tableName("tableName")

                        // the properties below are optional
                        .tempDirectory(S3LocationProperty.builder()
                                .bucket("bucket")

                                // the properties below are optional
                                .bucketOwner("bucketOwner")
                                .key("key")
                                .build())
                        .build())
                .overwrite(false)
                .s3Options(S3TableOutputOptionsProperty.builder()
                        .location(S3LocationProperty.builder()
                                .bucket("bucket")

                                // the properties below are optional
                                .bucketOwner("bucketOwner")
                                .key("key")
                                .build())
                        .build())
                .build()))
        .datasetName("datasetName")
        .encryptionKeyArn("encryptionKeyArn")
        .encryptionMode("encryptionMode")
        .jobSample(JobSampleProperty.builder()
                .mode("mode")
                .size(123)
                .build())
        .logSubscription("logSubscription")
        .maxCapacity(123)
        .maxRetries(123)
        .outputLocation(OutputLocationProperty.builder()
                .bucket("bucket")

                // the properties below are optional
                .bucketOwner("bucketOwner")
                .key("key")
                .build())
        .outputs(List.of(OutputProperty.builder()
                .location(S3LocationProperty.builder()
                        .bucket("bucket")

                        // the properties below are optional
                        .bucketOwner("bucketOwner")
                        .key("key")
                        .build())

                // the properties below are optional
                .compressionFormat("compressionFormat")
                .format("format")
                .formatOptions(OutputFormatOptionsProperty.builder()
                        .csv(CsvOutputOptionsProperty.builder()
                                .delimiter("delimiter")
                                .build())
                        .build())
                .maxOutputFiles(123)
                .overwrite(false)
                .partitionColumns(List.of("partitionColumns"))
                .build()))
        .profileConfiguration(ProfileConfigurationProperty.builder()
                .columnStatisticsConfigurations(List.of(ColumnStatisticsConfigurationProperty.builder()
                        .statistics(StatisticsConfigurationProperty.builder()
                                .includedStatistics(List.of("includedStatistics"))
                                .overrides(List.of(StatisticOverrideProperty.builder()
                                        .parameters(Map.of(
                                                "parametersKey", "parameters"))
                                        .statistic("statistic")
                                        .build()))
                                .build())

                        // the properties below are optional
                        .selectors(List.of(ColumnSelectorProperty.builder()
                                .name("name")
                                .regex("regex")
                                .build()))
                        .build()))
                .datasetStatisticsConfiguration(StatisticsConfigurationProperty.builder()
                        .includedStatistics(List.of("includedStatistics"))
                        .overrides(List.of(StatisticOverrideProperty.builder()
                                .parameters(Map.of(
                                        "parametersKey", "parameters"))
                                .statistic("statistic")
                                .build()))
                        .build())
                .entityDetectorConfiguration(EntityDetectorConfigurationProperty.builder()
                        .entityTypes(List.of("entityTypes"))

                        // the properties below are optional
                        .allowedStatistics(AllowedStatisticsProperty.builder()
                                .statistics(List.of("statistics"))
                                .build())
                        .build())
                .profileColumns(List.of(ColumnSelectorProperty.builder()
                        .name("name")
                        .regex("regex")
                        .build()))
                .build())
        .projectName("projectName")
        .recipe(RecipeProperty.builder()
                .name("name")

                // the properties below are optional
                .version("version")
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .timeout(123)
        .validationConfigurations(List.of(ValidationConfigurationProperty.builder()
                .rulesetArn("rulesetArn")

                // the properties below are optional
                .validationMode("validationMode")
                .build()))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataBrew;

var cfnJob = new CfnJob(this, "MyCfnJob", new CfnJobProps {
    Name = "name",
    RoleArn = "roleArn",
    Type = "type",

    // the properties below are optional
    DatabaseOutputs = new [] { new DatabaseOutputProperty {
        DatabaseOptions = new DatabaseTableOutputOptionsProperty {
            TableName = "tableName",

            // the properties below are optional
            TempDirectory = new S3LocationProperty {
                Bucket = "bucket",

                // the properties below are optional
                BucketOwner = "bucketOwner",
                Key = "key"
            }
        },
        GlueConnectionName = "glueConnectionName",

        // the properties below are optional
        DatabaseOutputMode = "databaseOutputMode"
    } },
    DataCatalogOutputs = new [] { new DataCatalogOutputProperty {
        DatabaseName = "databaseName",
        TableName = "tableName",

        // the properties below are optional
        CatalogId = "catalogId",
        DatabaseOptions = new DatabaseTableOutputOptionsProperty {
            TableName = "tableName",

            // the properties below are optional
            TempDirectory = new S3LocationProperty {
                Bucket = "bucket",

                // the properties below are optional
                BucketOwner = "bucketOwner",
                Key = "key"
            }
        },
        Overwrite = false,
        S3Options = new S3TableOutputOptionsProperty {
            Location = new S3LocationProperty {
                Bucket = "bucket",

                // the properties below are optional
                BucketOwner = "bucketOwner",
                Key = "key"
            }
        }
    } },
    DatasetName = "datasetName",
    EncryptionKeyArn = "encryptionKeyArn",
    EncryptionMode = "encryptionMode",
    JobSample = new JobSampleProperty {
        Mode = "mode",
        Size = 123
    },
    LogSubscription = "logSubscription",
    MaxCapacity = 123,
    MaxRetries = 123,
    OutputLocation = new OutputLocationProperty {
        Bucket = "bucket",

        // the properties below are optional
        BucketOwner = "bucketOwner",
        Key = "key"
    },
    Outputs = new [] { new OutputProperty {
        Location = new S3LocationProperty {
            Bucket = "bucket",

            // the properties below are optional
            BucketOwner = "bucketOwner",
            Key = "key"
        },

        // the properties below are optional
        CompressionFormat = "compressionFormat",
        Format = "format",
        FormatOptions = new OutputFormatOptionsProperty {
            Csv = new CsvOutputOptionsProperty {
                Delimiter = "delimiter"
            }
        },
        MaxOutputFiles = 123,
        Overwrite = false,
        PartitionColumns = new [] { "partitionColumns" }
    } },
    ProfileConfiguration = new ProfileConfigurationProperty {
        ColumnStatisticsConfigurations = new [] { new ColumnStatisticsConfigurationProperty {
            Statistics = new StatisticsConfigurationProperty {
                IncludedStatistics = new [] { "includedStatistics" },
                Overrides = new [] { new StatisticOverrideProperty {
                    Parameters = new Dictionary<string, string> {
                        { "parametersKey", "parameters" }
                    },
                    Statistic = "statistic"
                } }
            },

            // the properties below are optional
            Selectors = new [] { new ColumnSelectorProperty {
                Name = "name",
                Regex = "regex"
            } }
        } },
        DatasetStatisticsConfiguration = new StatisticsConfigurationProperty {
            IncludedStatistics = new [] { "includedStatistics" },
            Overrides = new [] { new StatisticOverrideProperty {
                Parameters = new Dictionary<string, string> {
                    { "parametersKey", "parameters" }
                },
                Statistic = "statistic"
            } }
        },
        EntityDetectorConfiguration = new EntityDetectorConfigurationProperty {
            EntityTypes = new [] { "entityTypes" },

            // the properties below are optional
            AllowedStatistics = new AllowedStatisticsProperty {
                Statistics = new [] { "statistics" }
            }
        },
        ProfileColumns = new [] { new ColumnSelectorProperty {
            Name = "name",
            Regex = "regex"
        } }
    },
    ProjectName = "projectName",
    Recipe = new RecipeProperty {
        Name = "name",

        // the properties below are optional
        Version = "version"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    Timeout = 123,
    ValidationConfigurations = new [] { new ValidationConfigurationProperty {
        RulesetArn = "rulesetArn",

        // the properties below are optional
        ValidationMode = "validationMode"
    } }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnJob := awscdk.Aws_databrew.NewCfnJob(this, jsii.String("MyCfnJob"), &CfnJobProps{
	Name: jsii.String("name"),
	RoleArn: jsii.String("roleArn"),
	Type: jsii.String("type"),

	// the properties below are optional
	DatabaseOutputs: []interface{}{
		&DatabaseOutputProperty{
			DatabaseOptions: &DatabaseTableOutputOptionsProperty{
				TableName: jsii.String("tableName"),

				// the properties below are optional
				TempDirectory: &S3LocationProperty{
					Bucket: jsii.String("bucket"),

					// the properties below are optional
					BucketOwner: jsii.String("bucketOwner"),
					Key: jsii.String("key"),
				},
			},
			GlueConnectionName: jsii.String("glueConnectionName"),

			// the properties below are optional
			DatabaseOutputMode: jsii.String("databaseOutputMode"),
		},
	},
	DataCatalogOutputs: []interface{}{
		&DataCatalogOutputProperty{
			DatabaseName: jsii.String("databaseName"),
			TableName: jsii.String("tableName"),

			// the properties below are optional
			CatalogId: jsii.String("catalogId"),
			DatabaseOptions: &DatabaseTableOutputOptionsProperty{
				TableName: jsii.String("tableName"),

				// the properties below are optional
				TempDirectory: &S3LocationProperty{
					Bucket: jsii.String("bucket"),

					// the properties below are optional
					BucketOwner: jsii.String("bucketOwner"),
					Key: jsii.String("key"),
				},
			},
			Overwrite: jsii.Boolean(false),
			S3Options: &S3TableOutputOptionsProperty{
				Location: &S3LocationProperty{
					Bucket: jsii.String("bucket"),

					// the properties below are optional
					BucketOwner: jsii.String("bucketOwner"),
					Key: jsii.String("key"),
				},
			},
		},
	},
	DatasetName: jsii.String("datasetName"),
	EncryptionKeyArn: jsii.String("encryptionKeyArn"),
	EncryptionMode: jsii.String("encryptionMode"),
	JobSample: &JobSampleProperty{
		Mode: jsii.String("mode"),
		Size: jsii.Number(123),
	},
	LogSubscription: jsii.String("logSubscription"),
	MaxCapacity: jsii.Number(123),
	MaxRetries: jsii.Number(123),
	OutputLocation: &OutputLocationProperty{
		Bucket: jsii.String("bucket"),

		// the properties below are optional
		BucketOwner: jsii.String("bucketOwner"),
		Key: jsii.String("key"),
	},
	Outputs: []interface{}{
		&OutputProperty{
			Location: &S3LocationProperty{
				Bucket: jsii.String("bucket"),

				// the properties below are optional
				BucketOwner: jsii.String("bucketOwner"),
				Key: jsii.String("key"),
			},

			// the properties below are optional
			CompressionFormat: jsii.String("compressionFormat"),
			Format: jsii.String("format"),
			FormatOptions: &OutputFormatOptionsProperty{
				Csv: &CsvOutputOptionsProperty{
					Delimiter: jsii.String("delimiter"),
				},
			},
			MaxOutputFiles: jsii.Number(123),
			Overwrite: jsii.Boolean(false),
			PartitionColumns: []*string{
				jsii.String("partitionColumns"),
			},
		},
	},
	ProfileConfiguration: &ProfileConfigurationProperty{
		ColumnStatisticsConfigurations: []interface{}{
			&ColumnStatisticsConfigurationProperty{
				Statistics: &StatisticsConfigurationProperty{
					IncludedStatistics: []*string{
						jsii.String("includedStatistics"),
					},
					Overrides: []interface{}{
						&StatisticOverrideProperty{
							Parameters: map[string]*string{
								"parametersKey": jsii.String("parameters"),
							},
							Statistic: jsii.String("statistic"),
						},
					},
				},

				// the properties below are optional
				Selectors: []interface{}{
					&ColumnSelectorProperty{
						Name: jsii.String("name"),
						Regex: jsii.String("regex"),
					},
				},
			},
		},
		DatasetStatisticsConfiguration: &StatisticsConfigurationProperty{
			IncludedStatistics: []*string{
				jsii.String("includedStatistics"),
			},
			Overrides: []interface{}{
				&StatisticOverrideProperty{
					Parameters: map[string]*string{
						"parametersKey": jsii.String("parameters"),
					},
					Statistic: jsii.String("statistic"),
				},
			},
		},
		EntityDetectorConfiguration: &EntityDetectorConfigurationProperty{
			EntityTypes: []*string{
				jsii.String("entityTypes"),
			},

			// the properties below are optional
			AllowedStatistics: &AllowedStatisticsProperty{
				Statistics: []*string{
					jsii.String("statistics"),
				},
			},
		},
		ProfileColumns: []interface{}{
			&ColumnSelectorProperty{
				Name: jsii.String("name"),
				Regex: jsii.String("regex"),
			},
		},
	},
	ProjectName: jsii.String("projectName"),
	Recipe: &RecipeProperty{
		Name: jsii.String("name"),

		// the properties below are optional
		Version: jsii.String("version"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	Timeout: jsii.Number(123),
	ValidationConfigurations: []interface{}{
		&ValidationConfigurationProperty{
			RulesetArn: jsii.String("rulesetArn"),

			// the properties below are optional
			ValidationMode: jsii.String("validationMode"),
		},
	},
})

Initializer

new CfnJob(scope: Construct, id: string, props: CfnJobProps)

CfnJob(scope: Construct, id: str, props: CfnJobProps)

new CfnJob(Construct scope, String id, CfnJobProps props)

new CfnJob(Construct scope, string id, CfnJobProps props)

NewCfnJob(Scope Construct, Id *string, Props CfnJobProps)

Construct Props

databaseOutputs?optionalIResolvable | IResolvable | CfnJob.DatabaseOutputProperty[]database_outputs?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DatabaseOutputProperty]]]databaseOutputs?optionalIResolvableDatabaseOutputs?optionalIResolvableDatabaseOutputs?optionalinterface{}#

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

dataCatalogOutputs?optionalIResolvable | IResolvable | CfnJob.DataCatalogOutputProperty[]data_catalog_outputs?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataCatalogOutputProperty]]]dataCatalogOutputs?optionalIResolvableDataCatalogOutputs?optionalIResolvableDataCatalogOutputs?optionalinterface{}#

One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

datasetName?optionalstringdataset_name?optionalstrdatasetName?optionalStringDatasetName?optionalstringDatasetName?optional*string#

A dataset that the job is to process.

encryptionKeyArn?optionalstringencryption_key_arn?optionalstrencryptionKeyArn?optionalStringEncryptionKeyArn?optionalstringEncryptionKeyArn?optional*string#

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.

For more information, see Encrypting data written by DataBrew jobs

encryptionMode?optionalstringencryption_mode?optionalstrencryptionMode?optionalStringEncryptionMode?optionalstringEncryptionMode?optional*string#

The encryption mode for the job, which can be one of the following:.

• SSE-KMS - Server-side encryption with keys managed by AWS .
• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

jobSample?optionalIResolvable | CfnJob.JobSamplePropertyjob_sample?optionaltyping.Union[IResolvable, JobSampleProperty]jobSample?optionalIResolvableJobSample?optionalIResolvableJobSample?optionalinterface{}#

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.

If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

logSubscription?optionalstringlog_subscription?optionalstrlogSubscription?optionalStringLogSubscription?optionalstringLogSubscription?optional*string#

The current status of Amazon CloudWatch logging for the job.

maxCapacity?optionalnumbermax_capacity?optionalint | floatmaxCapacity?optionalNumberMaxCapacity?optionaldoubleMaxCapacity?optional*float64#

The maximum number of nodes that can be consumed when the job processes data.

maxRetries?optionalnumbermax_retries?optionalint | floatmaxRetries?optionalNumberMaxRetries?optionaldoubleMaxRetries?optional*float64#

The maximum number of times to retry the job after a job run fails.

namestringnamestrnameStringNamestringName*stringrequired#

The unique name of the job.

outputLocation?optionalIResolvable | CfnJob.OutputLocationPropertyoutput_location?optionaltyping.Union[IResolvable, OutputLocationProperty]outputLocation?optionalIResolvableOutputLocation?optionalIResolvableOutputLocation?optionalinterface{}#

The location in Amazon S3 where the job writes its output.

outputs?optionalIResolvable | IResolvable | CfnJob.OutputProperty[]outputs?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, OutputProperty]]]outputs?optionalIResolvableOutputs?optionalIResolvableOutputs?optionalinterface{}#

One or more artifacts that represent output from running the job.

profileConfiguration?optionalIResolvable | CfnJob.ProfileConfigurationPropertyprofile_configuration?optionaltyping.Union[IResolvable, ProfileConfigurationProperty]profileConfiguration?optionalIResolvableProfileConfiguration?optionalIResolvableProfileConfiguration?optionalinterface{}#

Configuration for profile jobs.

Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.

projectName?optionalstringproject_name?optionalstrprojectName?optionalStringProjectName?optionalstringProjectName?optional*string#

The name of the project that the job is associated with.

recipe?optionalIResolvable | CfnJob.RecipePropertyrecipe?optionaltyping.Union[IResolvable, RecipeProperty]recipe?optionalIResolvableRecipe?optionalIResolvableRecipe?optionalinterface{}#

A series of data transformation steps that the job runs.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#

The Amazon Resource Name (ARN) of the role to be assumed for this job.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

Metadata tags that have been applied to the job.

timeout?optionalnumbertimeout?optionalint | floattimeout?optionalNumberTimeout?optionaldoubleTimeout?optional*float64#

The job's timeout in minutes.

A job that attempts to run longer than this timeout period ends with a status of TIMEOUT .

typestringtypestrtypeStringTypestringType*stringrequired#

The job type of the job, which must be one of the following:.

• PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.
• RECIPE - A job to apply one or more transformations to a dataset.

validationConfigurations?optionalIResolvable | IResolvable | CfnJob.ValidationConfigurationProperty[]validation_configurations?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ValidationConfigurationProperty]]]validationConfigurations?optionalIResolvableValidationConfigurations?optionalIResolvableValidationConfigurations?optionalinterface{}#

List of validation configurations that are applied to the profile job.

Properties

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#

AWS resource type.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#

databaseOutputs?may be undefinedIResolvable | IResolvable | CfnJob.DatabaseOutputProperty[]database_outputs?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DatabaseOutputProperty]]]databaseOutputs?may be undefinedIResolvableDatabaseOutputs?may be undefinedIResolvableDatabaseOutputs?may be undefinedinterface{}#

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

dataCatalogOutputs?may be undefinedIResolvable | IResolvable | CfnJob.DataCatalogOutputProperty[]data_catalog_outputs?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataCatalogOutputProperty]]]dataCatalogOutputs?may be undefinedIResolvableDataCatalogOutputs?may be undefinedIResolvableDataCatalogOutputs?may be undefinedinterface{}#

One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

datasetName?may be undefinedstringdataset_name?may be undefinedstrdatasetName?may be undefinedStringDatasetName?may be undefinedstringDatasetName?may be undefined*string#

A dataset that the job is to process.

encryptionKeyArn?may be undefinedstringencryption_key_arn?may be undefinedstrencryptionKeyArn?may be undefinedStringEncryptionKeyArn?may be undefinedstringEncryptionKeyArn?may be undefined*string#

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.

encryptionMode?may be undefinedstringencryption_mode?may be undefinedstrencryptionMode?may be undefinedStringEncryptionMode?may be undefinedstringEncryptionMode?may be undefined*string#

The encryption mode for the job, which can be one of the following:.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

jobRefJobReferencejob_refJobReferencejobRefJobReferenceJobRefJobReferenceJobRefJobReferencerequired#

A reference to a Job resource.

jobSample?may be undefinedIResolvable | CfnJob.JobSamplePropertyjob_sample?may be undefinedtyping.Union[IResolvable, JobSampleProperty]jobSample?may be undefinedIResolvableJobSample?may be undefinedIResolvableJobSample?may be undefinedinterface{}#

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*stringrequired#

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

logSubscription?may be undefinedstringlog_subscription?may be undefinedstrlogSubscription?may be undefinedStringLogSubscription?may be undefinedstringLogSubscription?may be undefined*string#

The current status of Amazon CloudWatch logging for the job.

maxCapacity?may be undefinednumbermax_capacity?may be undefinedint | floatmaxCapacity?may be undefinedNumberMaxCapacity?may be undefineddoubleMaxCapacity?may be undefined*float64#

The maximum number of nodes that can be consumed when the job processes data.

maxRetries?may be undefinednumbermax_retries?may be undefinedint | floatmaxRetries?may be undefinedNumberMaxRetries?may be undefineddoubleMaxRetries?may be undefined*float64#

The maximum number of times to retry the job after a job run fails.

namestringnamestrnameStringNamestringName*stringrequired#

The unique name of the job.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

outputLocation?may be undefinedIResolvable | CfnJob.OutputLocationPropertyoutput_location?may be undefinedtyping.Union[IResolvable, OutputLocationProperty]outputLocation?may be undefinedIResolvableOutputLocation?may be undefinedIResolvableOutputLocation?may be undefinedinterface{}#

The location in Amazon S3 where the job writes its output.

outputs?may be undefinedIResolvable | IResolvable | CfnJob.OutputProperty[]outputs?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, OutputProperty]]]outputs?may be undefinedIResolvableOutputs?may be undefinedIResolvableOutputs?may be undefinedinterface{}#

One or more artifacts that represent output from running the job.

profileConfiguration?may be undefinedIResolvable | CfnJob.ProfileConfigurationPropertyprofile_configuration?may be undefinedtyping.Union[IResolvable, ProfileConfigurationProperty]profileConfiguration?may be undefinedIResolvableProfileConfiguration?may be undefinedIResolvableProfileConfiguration?may be undefinedinterface{}#

Configuration for profile jobs.

projectName?may be undefinedstringproject_name?may be undefinedstrprojectName?may be undefinedStringProjectName?may be undefinedstringProjectName?may be undefined*string#

The name of the project that the job is associated with.

recipe?may be undefinedIResolvable | CfnJob.RecipePropertyrecipe?may be undefinedtyping.Union[IResolvable, RecipeProperty]recipe?may be undefinedIResolvableRecipe?may be undefinedIResolvableRecipe?may be undefinedinterface{}#

A series of data transformation steps that the job runs.

refstringrefstrrefStringRefstringRef*stringrequired#

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#

The Amazon Resource Name (ARN) of the role to be assumed for this job.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tagsTagManagertagsTagManagertagsTagManagerTagsTagManagerTagsTagManagerrequired#

Tag Manager which manages the tags for this resource.

tagsRaw?may be undefinedCfnTag[]tags_raw?may be undefinedtyping.List[CfnTag]tagsRaw?may be undefinedList<CfnTag>TagsRaw?may be undefinedCfnTag[]TagsRaw?may be undefined*[]CfnTag#

Metadata tags that have been applied to the job.

timeout?may be undefinednumbertimeout?may be undefinedint | floattimeout?may be undefinedNumberTimeout?may be undefineddoubleTimeout?may be undefined*float64#

The job's timeout in minutes.

typestringtypestrtypeStringTypestringType*stringrequired#

The job type of the job, which must be one of the following:.

validationConfigurations?may be undefinedIResolvable | IResolvable | CfnJob.ValidationConfigurationProperty[]validation_configurations?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ValidationConfigurationProperty]]]validationConfigurations?may be undefinedIResolvableValidationConfigurations?may be undefinedIResolvableValidationConfigurations?may be undefinedinterface{}#

List of validation configurations that are applied to the profile job.

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

• pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
• valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnJob(x: any): boolean@staticmethod def is_cfn_job(x: Any) -> boolpublic static Boolean isCfnJob(Object x)public static bool IsCfnJob(object x)func IsCfnJob(X interface{}) *boolstatic#

Checks whether the given object is a CfnJob.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.