DatasourceFlowsDetailsDataflowConfig

pydantic model openapi_client.models.datasource_flows_details_dataflow_config.DatasourceFlowsDetailsDataflowConfig

Type-specific configuration for the dataflow.

Fields:

• additional_task_settings (Dict[str, Any] | None)

• additional_task_stats (str | None)

• advanced_filters (openapi_client.models.datasource_flows_details_dataflow_config_advanced_filters.DatasourceFlowsDetailsDataflowConfigAdvancedFilters | None)

• allocated_storage (openapi_client.models.datasource_flows_details_dataflow_config_allocated_storage.DatasourceFlowsDetailsDataflowConfigAllocatedStorage | None)

• api_version (str | None)

• cdc_start_time (str | None)

• cdc_stop_position (str | None)

• cluster_arn (str | None)

• connectors_role_arn (str | None)

• consumer_configuration (openapi_client.models.datasource_flows_details_dataflow_config_consumer_configuration.DatasourceFlowsDetailsDataflowConfigConsumerConfiguration | None)

• data_transformation_configuration (openapi_client.models.datasource_flows_details_dataflow_config_data_transformation_configuration.DatasourceFlowsDetailsDataflowConfigDataTransformationConfiguration | None)

• dms_version (str | None)

• enable_data_validation (bool | None)

• entity_id (str | None)

• entity_name (str | None)

• execution_arn (str | None)

• extra_connection_attributes (str | None)

• full_load_finish_date (str | None)

• full_load_start_date (str | None)

• iceberg_table_options (openapi_client.models.datasource_flows_details_dataflow_config_iceberg_table_options.DatasourceFlowsDetailsDataflowConfigIcebergTableOptions | None)

• incremental_pull_config (str | None)

• ingestion_type (str | None)

• instance_az (str | None)

• instance_class (str | None)

• instance_multi_az (bool | None)

• is_data_transformation_enabled (bool | None)

• log_group_name (str | None)

• max_dcu (int | None)

• min_dcu (int | None)

• multi_az (bool | None)

• publicly_accessible_instance (bool | None)

• replication_az (str | None)

• s3_presigned_url (str | None)

• serverless_replication (bool | None)

• shared_cluster (str | None)

• shared_instance (str | None)

• sink_connector_arn (str | None)

• sink_connector_config (Dict[str, str] | None)

• snapshot_progress (Dict[str, Any] | None)

• source_connector_arn (str | None)

• source_connector_config (Dict[str, str] | None)

• source_connector_properties (openapi_client.models.datasource_flows_details_dataflow_config_source_connector_properties.DatasourceFlowsDetailsDataflowConfigSourceConnectorProperties | None)

• source_extra_connection_attributes (str | None)

• start_time (str | None)

• sync_to_s3 (str | None)

• table_mappings (openapi_client.models.datasource_flows_details_dataflow_config_table_mappings.DatasourceFlowsDetailsDataflowConfigTableMappings | None)

• tags (Dict[str, Any] | None)

• target_endpoint_name (str | None)

• target_location (str | None)

• target_table_prep_mode (str | None)

• task_retry_config (openapi_client.models.datasource_flows_details_dataflow_config_task_retry_config.DatasourceFlowsDetailsDataflowConfigTaskRetryConfig | None)

• task_s3_payload (str | None)

• task_s3_payload_path (str | None)

• task_stats (List[openapi_client.models.dataflow_task_stats_entry.DataflowTaskStatsEntry] | None)

• task_stats_marker (str | None)

• tasks (List[openapi_client.models.app_flow_task.AppFlowTask] | None)

• trigger_properties (openapi_client.models.datasource_flows_details_dataflow_config_trigger_properties.DatasourceFlowsDetailsDataflowConfigTriggerProperties | None)

• trigger_type (str | None)

field ingestion_type: Optional[StrictStr] = None (alias 'IngestionType')

Ingestion mode nested under config. For ArcGIS, values include metadata-only and metadata-and-data.

field target_location: Optional[StrictStr] = None (alias 'TargetLocation')

Target location nested under config when stored there.

field advanced_filters: Optional[DatasourceFlowsDetailsDataflowConfigAdvancedFilters] = None (alias 'AdvancedFilters')

field shared_instance: Optional[StrictStr] = None (alias 'SharedInstance')

Whether the dataflow uses a shared DMS replication instance. yes or no for JDBC Bulkload datasources.

field sync_to_s3: Optional[StrictStr] = None (alias 'SyncToS3')

Whether data is also synced to S3 for JDBC Bulkload datasources. yes or no.

field extra_connection_attributes: Optional[StrictStr] = None (alias 'ExtraConnectionAttributes')

Extra connection attributes for the DMS target endpoint.

field source_extra_connection_attributes: Optional[StrictStr] = None (alias 'SourceExtraConnectionAttributes')

Extra connection attributes for the DMS source endpoint.

field target_table_prep_mode: Optional[StrictStr] = None (alias 'TargetTablePrepMode')

How target tables are prepared.

field cdc_start_time: Optional[StrictStr] = None (alias 'CdcStartTime')

CDC start time for the replication task.

field cdc_stop_position: Optional[StrictStr] = None (alias 'CdcStopPosition')

CDC stop position for the replication task.

field instance_class: Optional[StrictStr] = None (alias 'InstanceClass')

DMS replication instance class for a dedicated instance.

field allocated_storage: Optional[DatasourceFlowsDetailsDataflowConfigAllocatedStorage] = None (alias 'AllocatedStorage')

field instance_az: Optional[StrictStr] = None (alias 'InstanceAZ')

Availability zone for a dedicated DMS replication instance.

field instance_multi_az: Optional[StrictBool] = None (alias 'InstanceMultiAZ')

Whether the dedicated DMS replication instance is multi-AZ.

field tasks: Optional[List[AppFlowTask]] = None (alias 'Tasks')

Field mapping tasks for SaaS datasource AppFlow flows.

field trigger_type: Optional[StrictStr] = None (alias 'TriggerType')

How the SaaS datasource flow is triggered. Supported values are ondemand, scheduled, and event.

field trigger_properties: Optional[DatasourceFlowsDetailsDataflowConfigTriggerProperties] = None (alias 'TriggerProperties')

field api_version: Optional[StrictStr] = None (alias 'ApiVersion')

API version used by the SaaS datasource connector.

field incremental_pull_config: Optional[StrictStr] = None (alias 'IncrementalPullConfig')

Datetime field name used for incremental pull on scheduled SaaS flows. Passed through to AppFlow incrementalPullConfig.datetimeTypeFieldName.

field source_connector_properties: Optional[DatasourceFlowsDetailsDataflowConfigSourceConnectorProperties] = None (alias 'SourceConnectorProperties')

field task_retry_config: Optional[DatasourceFlowsDetailsDataflowConfigTaskRetryConfig] = None (alias 'TaskRetryConfig')

field additional_task_settings: Optional[Dict[str, Any]] = None (alias 'AdditionalTaskSettings')

Additional DMS task settings for the dataflow.

field table_mappings: Optional[DatasourceFlowsDetailsDataflowConfigTableMappings] = None (alias 'TableMappings')

field consumer_configuration: Optional[DatasourceFlowsDetailsDataflowConfigConsumerConfiguration] = None (alias 'ConsumerConfiguration')

field entity_name: Optional[StrictStr] = None (alias 'EntityName')

Name of the shared instance or shared cluster entity.

field serverless_replication: Optional[StrictBool] = None (alias 'ServerlessReplication')

Whether DMS Serverless is used instead of a provisioned instance.

field max_dcu: Optional[StrictInt] = None (alias 'MaxDCU')

Maximum DMS Serverless capacity units.

field min_dcu: Optional[StrictInt] = None (alias 'MinDCU')

Minimum DMS Serverless capacity units.

field multi_az: Optional[StrictBool] = None (alias 'MultiAZ')

Whether the serverless replication is multi-AZ.

field replication_az: Optional[StrictStr] = None (alias 'ReplicationAZ')

Availability zone for serverless replication.

field publicly_accessible_instance: Optional[StrictBool] = None (alias 'PubliclyAccessibleInstance')

Whether the DMS replication instance is publicly accessible.

field task_s3_payload: Optional[StrictStr] = None (alias 'TaskS3Payload')

Whether a large task payload is stored in S3 instead of inline. yes or no.

field task_s3_payload_path: Optional[StrictStr] = None (alias 'TaskS3PayloadPath')

S3 key of the large task payload when TaskS3Payload is yes.

field execution_arn: Optional[StrictStr] = None (alias 'ExecutionArn')

Step Functions execution ARN for the dataflow run. Set on JDBC Bulkload and ArcGIS start; used for stop/terminate and status checks.

field entity_id: Optional[StrictStr] = None (alias 'EntityId')

ID of the shared instance or shared cluster entity.

field target_endpoint_name: Optional[StrictStr] = None (alias 'TargetEndpointName')

Name of the DMS target endpoint.

field is_data_transformation_enabled: Optional[StrictBool] = None (alias 'IsDataTransformationEnabled')

Whether a transform is enabled in the delivery path for Streams datasources.

field tags: Optional[Dict[str, Any]] = None (alias 'Tags')

Resource tags applied to the SaaS datasource AppFlow.

field start_time: Optional[StrictStr] = None (alias 'StartTime')

Start time recorded in the dataflow config for the current or last run.

field s3_presigned_url: Optional[StrictStr] = None (alias 'S3PresignedURL')

Short-lived URL to download the large task payload JSON when TaskS3Payload is yes.

field enable_data_validation: Optional[StrictBool] = None (alias 'EnableDataValidation')

Whether DMS data validation is enabled for JDBC Bulkload datasources.

field dms_version: Optional[StrictStr] = None (alias 'DmsVersion')

DMS engine version for the replication task or instance.

field iceberg_table_options: Optional[DatasourceFlowsDetailsDataflowConfigIcebergTableOptions] = None (alias 'IcebergTableOptions')

field shared_cluster: Optional[StrictStr] = None (alias 'SharedCluster')

Whether the dataflow uses a shared MSK Connect cluster. yes or no for JDBC Advanced Load datasources.

field log_group_name: Optional[StrictStr] = None (alias 'LogGroupName')

CloudWatch log group for Kafka Connect connectors. Returned for JDBC Advanced Load datasources.

field connectors_role_arn: Optional[StrictStr] = None (alias 'ConnectorsRoleArn')

IAM role ARN used by the source and sink connectors. Returned for JDBC Advanced Load datasources.

field source_connector_arn: Optional[StrictStr] = None (alias 'SourceConnectorArn')

ARN of the Kafka Connect source connector when the dataflow is running. Returned for JDBC Advanced Load datasources.

field sink_connector_arn: Optional[StrictStr] = None (alias 'SinkConnectorArn')

ARN of the Kafka Connect sink connector when the dataflow is running. Returned for JDBC Advanced Load datasources.

field cluster_arn: Optional[StrictStr] = None (alias 'ClusterArn')

MSK cluster ARN associated with the dataflow when using a dedicated cluster. Returned for JDBC Advanced Load datasources.

field task_stats: Optional[List[DataflowTaskStatsEntry]] = None (alias 'TaskStats')

Per-table statistics for a dataflow

field additional_task_stats: Optional[StrictStr] = None (alias 'AdditionalTaskStats')

Whether more Advanced Load table statistics are spilled beyond the DynamoDB page. yes when a full stats file exists in S3.

field snapshot_progress: Optional[Dict[str, Any]] = None (alias 'SnapshotProgress')

Snapshot progress metadata for JDBC Advanced Load full-load runs.

field source_connector_config: Optional[Dict[str, StrictStr]] = None (alias 'SourceConnectorConfig')

Extra Kafka Connect source connector properties for JDBC Advanced Load datasources. String keys and string values only. Platform-managed keys cannot be set here.

field sink_connector_config: Optional[Dict[str, StrictStr]] = None (alias 'SinkConnectorConfig')

Extra Kafka Connect sink connector properties for JDBC Advanced Load datasources. String keys and string values only. Platform-managed keys cannot be set here.

field data_transformation_configuration: Optional[DatasourceFlowsDetailsDataflowConfigDataTransformationConfiguration] = None (alias 'DataTransformationConfiguration')

field full_load_start_date: Optional[StrictStr] = None (alias 'FullLoadStartDate')

When full load started for the current or last run.

field full_load_finish_date: Optional[StrictStr] = None (alias 'FullLoadFinishDate')

When full load finished for the current or last run.

field task_stats_marker: Optional[StrictStr] = None (alias 'TaskStatsMarker')

Pagination marker for additional table statistics pages.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of DatasourceFlowsDetailsDataflowConfig from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of DatasourceFlowsDetailsDataflowConfig from a dict

Return type:

Optional[Self]