Class: Aws::Appflow::Types::SourceFlowConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb

Overview

Note:

When making an API call, you may pass SourceFlowConfig data as a hash:

{
  connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
  api_version: "ApiVersion",
  connector_profile_name: "ConnectorProfileName",
  source_connector_properties: { # required
    amplitude: {
      object: "Object", # required
    },
    datadog: {
      object: "Object", # required
    },
    dynatrace: {
      object: "Object", # required
    },
    google_analytics: {
      object: "Object", # required
    },
    infor_nexus: {
      object: "Object", # required
    },
    marketo: {
      object: "Object", # required
    },
    s3: {
      bucket_name: "BucketName", # required
      bucket_prefix: "BucketPrefix",
      s3_input_format_config: {
        s3_input_file_type: "CSV", # accepts CSV, JSON
      },
    },
    salesforce: {
      object: "Object", # required
      enable_dynamic_field_update: false,
      include_deleted_records: false,
    },
    service_now: {
      object: "Object", # required
    },
    singular: {
      object: "Object", # required
    },
    slack: {
      object: "Object", # required
    },
    trendmicro: {
      object: "Object", # required
    },
    veeva: {
      object: "Object", # required
      document_type: "DocumentType",
      include_source_files: false,
      include_renditions: false,
      include_all_versions: false,
    },
    zendesk: {
      object: "Object", # required
    },
    sapo_data: {
      object_path: "Object",
    },
    custom_connector: {
      entity_name: "EntityName", # required
      custom_properties: {
        "CustomPropertyKey" => "CustomPropertyValue",
      },
    },
  },
  incremental_pull_config: {
    datetime_type_field_name: "DatetimeTypeFieldName",
  },
}

Contains information about the configuration of the source connector used in the flow.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_version ⇒ String

The API version of the connector when it's used as a source in the flow.

Returns:

  • (String) 


6411
6412
6413
6414
6415
6416
6417
6418
6419
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 6411

class SourceFlowConfig < Struct.new(
  :connector_type,
  :api_version,
  :connector_profile_name,
  :source_connector_properties,
  :incremental_pull_config)
  SENSITIVE = []
  include Aws::Structure
end

#connector_profile_name ⇒ String

The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account.

Returns:

  • (String) 


6411
6412
6413
6414
6415
6416
6417
6418
6419
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 6411

class SourceFlowConfig < Struct.new(
  :connector_type,
  :api_version,
  :connector_profile_name,
  :source_connector_properties,
  :incremental_pull_config)
  SENSITIVE = []
  include Aws::Structure
end

#connector_type ⇒ String

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

Returns:

  • (String) 


6411
6412
6413
6414
6415
6416
6417
6418
6419
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 6411

class SourceFlowConfig < Struct.new(
  :connector_type,
  :api_version,
  :connector_profile_name,
  :source_connector_properties,
  :incremental_pull_config)
  SENSITIVE = []
  include Aws::Structure
end

#incremental_pull_config ⇒ Types::IncrementalPullConfig

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.

Returns:



6411
6412
6413
6414
6415
6416
6417
6418
6419
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 6411

class SourceFlowConfig < Struct.new(
  :connector_type,
  :api_version,
  :connector_profile_name,
  :source_connector_properties,
  :incremental_pull_config)
  SENSITIVE = []
  include Aws::Structure
end

#source_connector_properties ⇒ Types::SourceConnectorProperties

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

Returns:



6411
6412
6413
6414
6415
6416
6417
6418
6419
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 6411

class SourceFlowConfig < Struct.new(
  :connector_type,
  :api_version,
  :connector_profile_name,
  :source_connector_properties,
  :incremental_pull_config)
  SENSITIVE = []
  include Aws::Structure
end