software.amazon.awscdk.services.appflow

Interface CfnFlow.SourceFlowConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.SourceFlowConfigProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(value=Stable)
public static interface CfnFlow.SourceFlowConfigProperty
extends software.amazon.jsii.JsiiSerializable

Contains information about the configuration of the source connector used in the 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.*;
 Object customProperties;
 SourceFlowConfigProperty sourceFlowConfigProperty = SourceFlowConfigProperty.builder()
         .connectorType("connectorType")
         .sourceConnectorProperties(SourceConnectorPropertiesProperty.builder()
                 .amplitude(AmplitudeSourcePropertiesProperty.builder()
                         .object("object")
                         .build())
                 .customConnector(CustomConnectorSourcePropertiesProperty.builder()
                         .entityName("entityName")
                         // the properties below are optional
                         .customProperties(customProperties)
                         .build())
                 .datadog(DatadogSourcePropertiesProperty.builder()
                         .object("object")
                         .build())
                 .dynatrace(DynatraceSourcePropertiesProperty.builder()
                         .object("object")
                         .build())
                 .googleAnalytics(GoogleAnalyticsSourcePropertiesProperty.builder()
                         .object("object")
                         .build())
                 .inforNexus(InforNexusSourcePropertiesProperty.builder()
                         .object("object")
                         .build())
                 .marketo(MarketoSourcePropertiesProperty.builder()
                         .object("object")
                         .build())
                 .s3(S3SourcePropertiesProperty.builder()
                         .bucketName("bucketName")
                         .bucketPrefix("bucketPrefix")
                         // the properties below are optional
                         .s3InputFormatConfig(S3InputFormatConfigProperty.builder()
                                 .s3InputFileType("s3InputFileType")
                                 .build())
                         .build())
                 .salesforce(SalesforceSourcePropertiesProperty.builder()
                         .object("object")
                         // the properties below are optional
                         .enableDynamicFieldUpdate(false)
                         .includeDeletedRecords(false)
                         .build())
                 .sapoData(SAPODataSourcePropertiesProperty.builder()
                         .objectPath("objectPath")
                         .build())
                 .serviceNow(ServiceNowSourcePropertiesProperty.builder()
                         .object("object")
                         .build())
                 .singular(SingularSourcePropertiesProperty.builder()
                         .object("object")
                         .build())
                 .slack(SlackSourcePropertiesProperty.builder()
                         .object("object")
                         .build())
                 .trendmicro(TrendmicroSourcePropertiesProperty.builder()
                         .object("object")
                         .build())
                 .veeva(VeevaSourcePropertiesProperty.builder()
                         .object("object")
                         // the properties below are optional
                         .documentType("documentType")
                         .includeAllVersions(false)
                         .includeRenditions(false)
                         .includeSourceFiles(false)
                         .build())
                 .zendesk(ZendeskSourcePropertiesProperty.builder()
                         .object("object")
                         .build())
                 .build())
         // the properties below are optional
         .apiVersion("apiVersion")
         .connectorProfileName("connectorProfileName")
         .incrementalPullConfig(IncrementalPullConfigProperty.builder()
                 .datetimeTypeFieldName("datetimeTypeFieldName")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnFlow.SourceFlowConfigProperty.Builder	builder()
default String	getApiVersion() `CfnFlow.SourceFlowConfigProperty.ApiVersion`.
default String	getConnectorProfileName() The name of the connector profile.
String	getConnectorType() The type of source connector, such as Salesforce, Amplitude, and so on.
default Object	getIncrementalPullConfig() Defines the configuration for a scheduled incremental data pull.
Object	getSourceConnectorProperties() Specifies the information that is required to query a particular source connector.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConnectorType

@Stability(value=Stable)
 @NotNull
String getConnectorType()

The type of source connector, such as Salesforce, Amplitude, and so on.

Allowed Values : S3 | Amplitude | Datadog | Dynatrace | Googleanalytics | Infornexus | Salesforce | Servicenow | Singular | Slack | Trendmicro | Veeva | Zendesk

getSourceConnectorProperties

@Stability(value=Stable)
 @NotNull
Object getSourceConnectorProperties()

Specifies the information that is required to query a particular source connector.

getApiVersion

@Stability(value=Stable)
 @Nullable
default String getApiVersion()

`CfnFlow.SourceFlowConfigProperty.ApiVersion`.

getConnectorProfileName

@Stability(value=Stable)
 @Nullable
default String getConnectorProfileName()

The name of the connector profile.

This name must be unique for each connector profile in the AWS account .

getIncrementalPullConfig

@Stability(value=Stable)
 @Nullable
default Object getIncrementalPullConfig()

Defines the configuration for a scheduled incremental data pull.

If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.

builder

@Stability(value=Stable)
static CfnFlow.SourceFlowConfigProperty.Builder builder()

Returns:

a CfnFlow.SourceFlowConfigProperty.Builder of CfnFlow.SourceFlowConfigProperty