aws_ddk_core.stages.AppFlowIngestionStage

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

Class that represents an AppFlow DDK DataStage.

__init__(scope: constructs.Construct, id: str, environment_id: str, flow_name: typing.Optional[str] = None, flow_execution_status_check_period: aws_cdk.Duration = <aws_cdk.Duration object>, destination_flow_config: typing.Optional[aws_cdk.aws_appflow.CfnFlow.DestinationFlowConfigProperty] = None, source_flow_config: typing.Optional[aws_cdk.aws_appflow.CfnFlow.SourceFlowConfigProperty] = None, tasks: typing.Optional[typing.List[aws_cdk.aws_appflow.CfnFlow.TaskProperty]] = None, state_machine_input: typing.Optional[typing.Dict[str, typing.Any]] = None, additional_role_policy_statements: typing.Optional[typing.List[aws_cdk.aws_iam.PolicyStatement]] = None, state_machine_failed_executions_alarm_threshold: typing.Optional[int] = 1, state_machine_failed_executions_alarm_evaluation_periods: typing.Optional[int] = 1) None

DDK AppFlow Ingestion stage.

Stage that contains a step function that runs an AppFlow flow ingestion. If the AppFlow flow name is not supplied, then it is created.

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

  • id (str) – Identifier of the stage

  • environment_id (str) – Identifier of the environment

  • flow_name (Optional[str]) – Name of the AppFlow flow to run. If None, an AppFlow flow is created

  • flow_execution_status_check_period (Duration) – Time to wait between flow execution status checks. aws_cdk.Duration.seconds(15) by default

  • destination_flow_config (Optional[CfnFlow.DestinationFlowConfigProperty]) – The flow destination_flow_config properties

  • source_flow_config (Optional[CfnFlow.SourceFlowConfigProperty]) – The flow source_flow_config properties

  • tasks (Optional[List[CfnFlow.TaskProperty]]) – The flow tasks properties

  • state_machine_input (Optional[Dict[str, Any]]) – Input of 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 AppFlow Ingestion stage.

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

Add a CloudWatch alarm for the Data Stage

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

flow

CfnFlow The AppFlow flow

node

The tree node.

state_machine

StateMachine The state machine

property flow: aws_cdk.aws_appflow.CfnFlow

CfnFlow The AppFlow flow

Type

Return

get_event_pattern() Optional[aws_cdk.aws_events.EventPattern]

Get output event pattern of the stage.

Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets.

Returns

event_pattern – Event pattern

Return type

Optional[EventPattern]

get_targets() Optional[List[aws_cdk.aws_events.IRuleTarget]]

Get input targets of the stage.

Targets are used by Event Rules to describe what should be invoked when a rule matches an event.

Returns

targets – List of targets

Return type

Optional[List[IRuleTarget]]

property state_machine: aws_cdk.aws_stepfunctions.StateMachine

StateMachine The state machine

Type

Return