Skip to content
v2.277.0

TriggerConfigProperty Struct ​

The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appflow as appflow } from 'aws-cdk-lib';
const triggerConfigProperty: appflow.CfnFlow.TriggerConfigProperty = {
  triggerType: 'triggerType',

  // the properties below are optional
  triggerProperties: {
    scheduleExpression: 'scheduleExpression',

    // the properties below are optional
    dataPullMode: 'dataPullMode',
    firstExecutionFrom: 123,
    flowErrorDeactivationThreshold: 123,
    scheduleEndTime: 123,
    scheduleOffset: 123,
    scheduleStartTime: 123,
    timeZone: 'timeZone',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appflow as appflow

trigger_config_property = appflow.CfnFlow.TriggerConfigProperty(
    trigger_type="triggerType",

    # the properties below are optional
    trigger_properties=appflow.CfnFlow.ScheduledTriggerPropertiesProperty(
        schedule_expression="scheduleExpression",

        # the properties below are optional
        data_pull_mode="dataPullMode",
        first_execution_from=123,
        flow_error_deactivation_threshold=123,
        schedule_end_time=123,
        schedule_offset=123,
        schedule_start_time=123,
        time_zone="timeZone"
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.appflow.*;

TriggerConfigProperty triggerConfigProperty = TriggerConfigProperty.builder()
        .triggerType("triggerType")

        // the properties below are optional
        .triggerProperties(ScheduledTriggerPropertiesProperty.builder()
                .scheduleExpression("scheduleExpression")

                // the properties below are optional
                .dataPullMode("dataPullMode")
                .firstExecutionFrom(123)
                .flowErrorDeactivationThreshold(123)
                .scheduleEndTime(123)
                .scheduleOffset(123)
                .scheduleStartTime(123)
                .timeZone("timeZone")
                .build())
        .build();
csharp
// 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.AppFlow;

var triggerConfigProperty = new TriggerConfigProperty {
    TriggerType = "triggerType",

    // the properties below are optional
    TriggerProperties = new ScheduledTriggerPropertiesProperty {
        ScheduleExpression = "scheduleExpression",

        // the properties below are optional
        DataPullMode = "dataPullMode",
        FirstExecutionFrom = 123,
        FlowErrorDeactivationThreshold = 123,
        ScheduleEndTime = 123,
        ScheduleOffset = 123,
        ScheduleStartTime = 123,
        TimeZone = "timeZone"
    }
};
go
// 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"

triggerConfigProperty := &TriggerConfigProperty{
	TriggerType: jsii.String("triggerType"),

	// the properties below are optional
	TriggerProperties: &ScheduledTriggerPropertiesProperty{
		ScheduleExpression: jsii.String("scheduleExpression"),

		// the properties below are optional
		DataPullMode: jsii.String("dataPullMode"),
		FirstExecutionFrom: jsii.Number(123),
		FlowErrorDeactivationThreshold: jsii.Number(123),
		ScheduleEndTime: jsii.Number(123),
		ScheduleOffset: jsii.Number(123),
		ScheduleStartTime: jsii.Number(123),
		TimeZone: jsii.String("timeZone"),
	},
}

Properties ​

triggerPropertiesoptionalIResolvable | CfnFlow.ScheduledTriggerPropertiesPropertytrigger_propertiesoptionaltyping.Union[IResolvable, ScheduledTriggerPropertiesProperty]triggerPropertiesoptionalIResolvableTriggerPropertiesoptionalIResolvableTriggerPropertiesoptionalinterface{} #
Specifies the configuration details of a schedule-triggered flow as defined by the user.

Currently, these settings only apply to the Scheduled trigger type.

triggerTypestringtrigger_typestrtriggerTypeStringTriggerTypestringTriggerType*string required #
Specifies the type of flow trigger.

This can be OnDemand , Scheduled , or Event .