aws_ddk_core.stages.DataBrewTransformStage

class aws_ddk_core.stages.DataBrewTransformStage(*args: Any, **kwargs)

Class that represents a DataBrew Transform DDK DataStage.

__init__(scope: constructs.Construct, id: str, environment_id: str, job_name: Optional[str] = None, job_role_arn: Optional[str] = None, job_type: Optional[str] = None, dataset_name: Optional[str] = None, recipe: Optional[aws_cdk.aws_databrew.CfnJob.RecipeProperty] = None, outputs: Optional[List[aws_cdk.aws_databrew.CfnJob.OutputProperty]] = None, state_machine_input: Optional[Dict[str, Any]] = None, additional_role_policy_statements: Optional[List[aws_cdk.aws_iam.PolicyStatement]] = None, state_machine_failed_executions_alarm_threshold: Optional[int] = 1, state_machine_failed_executions_alarm_evaluation_periods: Optional[int] = 1) None

DDK DataBrew Transform stage.

Stage that contains a step function that runs DataBrew job

Parameters
  • scope (Construct) – Scope within which this construct is defined

  • id (str) – Identifier of the stage

  • environment_id (str) – Identifier of the environment

  • job_name (Optional[str]) – The name of a preexisting DataBrew job to run. If None, a DataBrew job is created

  • job_role_arn (Optional[str]) – The Arn of the job execution role. Required if job_name is None.

  • job_type (Optional[str]) – The type of job to run. Required if job_name is None.

  • dataset_name (Optional[str]) – The name of the dataset to use for the job.

  • recipe (Optional[CfnJob.RecipeProperty]) – The recipe to be used by the DataBrew job which is a series of data transformation steps.

  • outputs (Optional[List[CfnJob.OutputProperty]]) – The output properties for the job.

  • state_machine_input (Optional[Dict[str, Any]]) – The input dict to the state machine

  • additional_role_policy_statements (Optional[List[PolicyStatement]]) – Additional IAM policy statements to add to the state machine role

  • state_machine_failed_executions_alarm_threshold (Optional[int]) – The number of failed state machine executions before triggering CW alarm. Defaults to 1

  • state_machine_failed_executions_alarm_evaluation_periods (Optional[int]) – The number of periods over which data is compared to the specified threshold. Defaults to 1

Methods

__init__(scope, id, environment_id[, ...])

DDK DataBrew Transform stage.

add_alarm(alarm_id, alarm_metric[, ...])

Add a CloudWatch alarm for the Data Stage

build_state_machine(id, environment_id, ...)

Build state machine.

get_event_pattern()

Get output event pattern of the stage.

get_targets()

Get input targets of the stage.

is_construct(x)

Checks if x is a construct.

to_string()

Returns a string representation of this construct.

Attributes

cloudwatch_alarms

List[Alarm] List of CloudWatch Alarms linked to the stage

job

Optional[CfnJob] The DataBrew job

node

The tree node.

state_machine

StateMachine The state machine

property job: Optional[aws_cdk.aws_databrew.CfnJob]

Optional[CfnJob] The DataBrew job

Type

Return