@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:35.393Z")
public interface CfnFlowProps
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.*;
CfnFlowProps cfnFlowProps = CfnFlowProps.builder()
.destinationFlowConfigList(List.of(DestinationFlowConfigProperty.builder()
.connectorType("connectorType")
.destinationConnectorProperties(DestinationConnectorPropertiesProperty.builder()
.customConnector(CustomConnectorDestinationPropertiesProperty.builder()
.entityName("entityName")
// the properties below are optional
.customProperties(Map.of(
"customPropertiesKey", "customProperties"))
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.idFieldNames(List.of("idFieldNames"))
.writeOperationType("writeOperationType")
.build())
.eventBridge(EventBridgeDestinationPropertiesProperty.builder()
.object("object")
// the properties below are optional
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.build())
.lookoutMetrics(LookoutMetricsDestinationPropertiesProperty.builder()
.object("object")
.build())
.marketo(MarketoDestinationPropertiesProperty.builder()
.object("object")
// the properties below are optional
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.build())
.redshift(RedshiftDestinationPropertiesProperty.builder()
.intermediateBucketName("intermediateBucketName")
.object("object")
// the properties below are optional
.bucketPrefix("bucketPrefix")
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.build())
.s3(S3DestinationPropertiesProperty.builder()
.bucketName("bucketName")
// the properties below are optional
.bucketPrefix("bucketPrefix")
.s3OutputFormatConfig(S3OutputFormatConfigProperty.builder()
.aggregationConfig(AggregationConfigProperty.builder()
.aggregationType("aggregationType")
.targetFileSize(123)
.build())
.fileType("fileType")
.prefixConfig(PrefixConfigProperty.builder()
.pathPrefixHierarchy(List.of("pathPrefixHierarchy"))
.prefixFormat("prefixFormat")
.prefixType("prefixType")
.build())
.preserveSourceDataTyping(false)
.build())
.build())
.salesforce(SalesforceDestinationPropertiesProperty.builder()
.object("object")
// the properties below are optional
.dataTransferApi("dataTransferApi")
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.idFieldNames(List.of("idFieldNames"))
.writeOperationType("writeOperationType")
.build())
.sapoData(SAPODataDestinationPropertiesProperty.builder()
.objectPath("objectPath")
// the properties below are optional
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.idFieldNames(List.of("idFieldNames"))
.successResponseHandlingConfig(SuccessResponseHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.build())
.writeOperationType("writeOperationType")
.build())
.snowflake(SnowflakeDestinationPropertiesProperty.builder()
.intermediateBucketName("intermediateBucketName")
.object("object")
// the properties below are optional
.bucketPrefix("bucketPrefix")
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.build())
.upsolver(UpsolverDestinationPropertiesProperty.builder()
.bucketName("bucketName")
.s3OutputFormatConfig(UpsolverS3OutputFormatConfigProperty.builder()
.prefixConfig(PrefixConfigProperty.builder()
.pathPrefixHierarchy(List.of("pathPrefixHierarchy"))
.prefixFormat("prefixFormat")
.prefixType("prefixType")
.build())
// the properties below are optional
.aggregationConfig(AggregationConfigProperty.builder()
.aggregationType("aggregationType")
.targetFileSize(123)
.build())
.fileType("fileType")
.build())
// the properties below are optional
.bucketPrefix("bucketPrefix")
.build())
.zendesk(ZendeskDestinationPropertiesProperty.builder()
.object("object")
// the properties below are optional
.errorHandlingConfig(ErrorHandlingConfigProperty.builder()
.bucketName("bucketName")
.bucketPrefix("bucketPrefix")
.failOnFirstError(false)
.build())
.idFieldNames(List.of("idFieldNames"))
.writeOperationType("writeOperationType")
.build())
.build())
// the properties below are optional
.apiVersion("apiVersion")
.connectorProfileName("connectorProfileName")
.build()))
.flowName("flowName")
.sourceFlowConfig(SourceFlowConfigProperty.builder()
.connectorType("connectorType")
.sourceConnectorProperties(SourceConnectorPropertiesProperty.builder()
.amplitude(AmplitudeSourcePropertiesProperty.builder()
.object("object")
.build())
.customConnector(CustomConnectorSourcePropertiesProperty.builder()
.entityName("entityName")
// the properties below are optional
.customProperties(Map.of(
"customPropertiesKey", "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())
.pardot(PardotSourcePropertiesProperty.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
.dataTransferApi("dataTransferApi")
.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())
.tasks(List.of(TaskProperty.builder()
.sourceFields(List.of("sourceFields"))
.taskType("taskType")
// the properties below are optional
.connectorOperator(ConnectorOperatorProperty.builder()
.amplitude("amplitude")
.customConnector("customConnector")
.datadog("datadog")
.dynatrace("dynatrace")
.googleAnalytics("googleAnalytics")
.inforNexus("inforNexus")
.marketo("marketo")
.pardot("pardot")
.s3("s3")
.salesforce("salesforce")
.sapoData("sapoData")
.serviceNow("serviceNow")
.singular("singular")
.slack("slack")
.trendmicro("trendmicro")
.veeva("veeva")
.zendesk("zendesk")
.build())
.destinationField("destinationField")
.taskProperties(List.of(TaskPropertiesObjectProperty.builder()
.key("key")
.value("value")
.build()))
.build()))
.triggerConfig(TriggerConfigProperty.builder()
.triggerType("triggerType")
// the properties below are optional
.activateFlowOnCreate(false)
.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())
// the properties below are optional
.description("description")
.kmsArn("kmsArn")
.metadataCatalogConfig(MetadataCatalogConfigProperty.builder()
.glueDataCatalog(GlueDataCatalogProperty.builder()
.databaseName("databaseName")
.roleArn("roleArn")
.tablePrefix("tablePrefix")
.build())
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnFlowProps.Builder
A builder for
CfnFlowProps |
static class |
CfnFlowProps.Jsii$Proxy
An implementation for
CfnFlowProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnFlowProps.Builder |
builder() |
default java.lang.String |
getDescription()
A user-entered description of the flow.
|
java.lang.Object |
getDestinationFlowConfigList()
The configuration that controls how Amazon AppFlow places data in the destination connector.
|
java.lang.String |
getFlowName()
The specified name of the flow.
|
default java.lang.String |
getKmsArn()
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
|
default java.lang.Object |
getMetadataCatalogConfig()
`AWS::AppFlow::Flow.MetadataCatalogConfig`.
|
java.lang.Object |
getSourceFlowConfig()
Contains information about the configuration of the source connector used in the flow.
|
default java.util.List<CfnTag> |
getTags()
The tags used to organize, track, or control access for your flow.
|
java.lang.Object |
getTasks()
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
|
java.lang.Object |
getTriggerConfig()
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
|
java.lang.Object getDestinationFlowConfigList()
java.lang.String getFlowName()
Spaces are not allowed. Use underscores (_) or hyphens (-) only.
java.lang.Object getSourceFlowConfig()
java.lang.Object getTasks()
java.lang.Object getTriggerConfig()
default java.lang.String getDescription()
default java.lang.String getKmsArn()
This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
default java.lang.Object getMetadataCatalogConfig()
default java.util.List<CfnTag> getTags()
static CfnFlowProps.Builder builder()
CfnFlowProps.Builder of CfnFlowProps