The object specified in the Amplitude flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Amplitude_Object |
Amazon.PowerShell.Cmdlets.AF.AmazonAppflowClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The clientToken parameter is an idempotency token. It ensures that your CreateFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token is active for 8 hours.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Custom properties that are required to use the custom connector as a source. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_CustomConnector_CustomProperties |
-CustomConnector_EntityName <
String>
The entity specified in the custom connector as a source in the flow.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_CustomConnector_EntityName |
The object specified in the Datadog flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Datadog_Object |
-DataTransferApi_Name <
String>
The name of the connector application API.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_CustomConnector_DataTransferApi_Name |
You can specify one of the following types:
- AUTOMATIC
- The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.
- SYNC
- A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.
- ASYNC
- An asynchronous API. This type of API optimizes a flow for large datasets.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_CustomConnector_DataTransferApi_Type |
A description of the flow you want to create.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The configuration that controls how Amazon AppFlow places data in the destination connector. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The object specified in the Dynatrace flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Dynatrace_Object |
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-GlueDataCatalog_DatabaseName <
String>
The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow that you configure with this parameter.When you configure a new flow with this parameter, you must specify an existing database.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | MetadataCatalogConfig_GlueDataCatalog_DatabaseName |
-GlueDataCatalog_RoleArn <
String>
The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.For an example IAM policy that has the required permissions, see
Identity-based policy examples for Amazon AppFlow.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | MetadataCatalogConfig_GlueDataCatalog_RoleArn |
-GlueDataCatalog_TablePrefix <
String>
A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | MetadataCatalogConfig_GlueDataCatalog_TablePrefix |
-GoogleAnalytics_Object <
String>
The object specified in the Google Analytics flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_GoogleAnalytics_Object |
-IncrementalPullConfig_DatetimeTypeFieldName <
String>
A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_IncrementalPullConfig_DatetimeTypeFieldName |
The object specified in the Infor Nexus flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_InforNexus_Object |
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. 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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The object specified in the Marketo flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Marketo_Object |
-PaginationConfig_MaxPageSize <
Int32>
The maximum number of records that Amazon AppFlow receives in each page of the response from your SAP application. For transfers of OData records, the maximum page size is 3,000. For transfers of data that comes from an ODP provider, the maximum page size is 10,000.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_SAPOData_PaginationConfig_MaxPageSize |
-ParallelismConfig_MaxParallelism <
Int32>
The maximum number of processes that Amazon AppFlow runs at the same time when it retrieves your data from your SAP application.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_SAPOData_ParallelismConfig_MaxParallelism |
The object specified in the Salesforce Pardot flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Pardot_Object |
The Amazon S3 bucket name where the source files are stored.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_S3_BucketName |
The object key for the Amazon S3 bucket in which the source files are stored.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_S3_BucketPrefix |
The file type that Amazon AppFlow gets from your Amazon S3 bucket.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_S3_S3InputFormatConfig_S3InputFileType |
Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.
- AUTOMATIC
- The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.
- BULKV2
- Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.Note that Bulk API 2.0 does not transfer Salesforce compound fields.
- REST_SYNC
- Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Salesforce_DataTransferApi |
-Salesforce_EnableDynamicFieldUpdate <
Boolean>
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Salesforce_EnableDynamicFieldUpdate |
-Salesforce_IncludeDeletedRecord <
Boolean>
Indicates whether Amazon AppFlow includes deleted files in the flow run.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Salesforce_IncludeDeletedRecords |
The object specified in the Salesforce flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Salesforce_Object |
The object path specified in the SAPOData flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_SAPOData_ObjectPath |
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TriggerConfig_TriggerProperties_Scheduled_DataPullMode |
-Scheduled_FirstExecutionFrom <DateTime>
Specifies the date range for the records to import from the connector in the first flow run.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TriggerConfig_TriggerProperties_Scheduled_FirstExecutionFrom |
-Scheduled_FlowErrorDeactivationThreshold <
Int32>
Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TriggerConfig_TriggerProperties_Scheduled_FlowErrorDeactivationThreshold |
-Scheduled_ScheduleEndTime <DateTime>
The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TriggerConfig_TriggerProperties_Scheduled_ScheduleEndTime |
-Scheduled_ScheduleExpression <
String>
The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TriggerConfig_TriggerProperties_Scheduled_ScheduleExpression |
-Scheduled_ScheduleOffset <Int64>
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TriggerConfig_TriggerProperties_Scheduled_ScheduleOffset |
-Scheduled_ScheduleStartTime <DateTime>
The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TriggerConfig_TriggerProperties_Scheduled_ScheduleStartTime |
Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | TriggerConfig_TriggerProperties_Scheduled_Timezone |
Use the -Select parameter to control the cmdlet output. The default value is 'FlowArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Appflow.Model.CreateFlowResponse). Specifying the name of a property of type Amazon.Appflow.Model.CreateFlowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The object specified in the ServiceNow flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_ServiceNow_Object |
The object specified in the Singular flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Singular_Object |
The object specified in the Slack flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Slack_Object |
-SourceFlowConfig_ApiVersion <
String>
The API version of the connector when it's used as a source in the flow.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-SourceFlowConfig_ConnectorProfileName <
String>
The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The type of connector, such as Salesforce, Amplitude, and so on.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The tags used to organize, track, or control access for your flow. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tasks |
The object specified in the Trend Micro flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Trendmicro_Object |
Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The document type specified in the Veeva document extract flow.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Veeva_DocumentType |
Boolean value to include All Versions of files in Veeva document extract flow.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Veeva_IncludeAllVersions |
Boolean value to include file renditions in Veeva document extract flow.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Veeva_IncludeRenditions |
Boolean value to include source files in Veeva document extract flow.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Veeva_IncludeSourceFiles |
The object specified in the Veeva flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Veeva_Object |
The object specified in the Zendesk flow source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SourceFlowConfig_SourceConnectorProperties_Zendesk_Object |