Package software.amazon.awscdk.services.appflow

Interface CfnFlow.TriggerConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.TriggerConfigProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(Stable)
public static interface CfnFlow.TriggerConfigProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlow.TriggerConfigProperty.Builder	A builder for CfnFlow.TriggerConfigProperty
static final class	CfnFlow.TriggerConfigProperty.Jsii$Proxy	An implementation for CfnFlow.TriggerConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnFlow.TriggerConfigProperty.Builder	builder()
default Object	getTriggerProperties()	Specifies the configuration details of a schedule-triggered flow as defined by the user.
String	getTriggerType()	Specifies the type of flow trigger.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTriggerType

@Stability(Stable)
@NotNull
String getTriggerType()

Specifies the type of flow trigger.

This can be OnDemand , Scheduled , or Event .

getTriggerProperties

@Stability(Stable)
@Nullable
default Object getTriggerProperties()

Specifies the configuration details of a schedule-triggered flow as defined by the user.

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

builder

@Stability(Stable)
static CfnFlow.TriggerConfigProperty.Builder builder()

Returns:

a CfnFlow.TriggerConfigProperty.Builder of CfnFlow.TriggerConfigProperty