Class: Aws::Appflow::Types::DestinationFlowConfig

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 DestinationFlowConfig 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",
  destination_connector_properties: { # required
    redshift: {
      object: "Object", # required
      intermediate_bucket_name: "BucketName", # required
      bucket_prefix: "BucketPrefix",
      error_handling_config: {
        fail_on_first_destination_error: false,
        bucket_prefix: "BucketPrefix",
        bucket_name: "BucketName",
      },
    },
    s3: {
      bucket_name: "BucketName", # required
      bucket_prefix: "BucketPrefix",
      s3_output_format_config: {
        file_type: "CSV", # accepts CSV, JSON, PARQUET
        prefix_config: {
          prefix_type: "FILENAME", # accepts FILENAME, PATH, PATH_AND_FILENAME
          prefix_format: "YEAR", # accepts YEAR, MONTH, DAY, HOUR, MINUTE
        },
        aggregation_config: {
          aggregation_type: "None", # accepts None, SingleFile
        },
      },
    },
    salesforce: {
      object: "Object", # required
      id_field_names: ["Name"],
      error_handling_config: {
        fail_on_first_destination_error: false,
        bucket_prefix: "BucketPrefix",
        bucket_name: "BucketName",
      },
      write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
    },
    snowflake: {
      object: "Object", # required
      intermediate_bucket_name: "BucketName", # required
      bucket_prefix: "BucketPrefix",
      error_handling_config: {
        fail_on_first_destination_error: false,
        bucket_prefix: "BucketPrefix",
        bucket_name: "BucketName",
      },
    },
    event_bridge: {
      object: "Object", # required
      error_handling_config: {
        fail_on_first_destination_error: false,
        bucket_prefix: "BucketPrefix",
        bucket_name: "BucketName",
      },
    },
    lookout_metrics: {
    },
    upsolver: {
      bucket_name: "UpsolverBucketName", # required
      bucket_prefix: "BucketPrefix",
      s3_output_format_config: { # required
        file_type: "CSV", # accepts CSV, JSON, PARQUET
        prefix_config: { # required
          prefix_type: "FILENAME", # accepts FILENAME, PATH, PATH_AND_FILENAME
          prefix_format: "YEAR", # accepts YEAR, MONTH, DAY, HOUR, MINUTE
        },
        aggregation_config: {
          aggregation_type: "None", # accepts None, SingleFile
        },
      },
    },
    honeycode: {
      object: "Object", # required
      error_handling_config: {
        fail_on_first_destination_error: false,
        bucket_prefix: "BucketPrefix",
        bucket_name: "BucketName",
      },
    },
    customer_profiles: {
      domain_name: "DomainName", # required
      object_type_name: "ObjectTypeName",
    },
    zendesk: {
      object: "Object", # required
      id_field_names: ["Name"],
      error_handling_config: {
        fail_on_first_destination_error: false,
        bucket_prefix: "BucketPrefix",
        bucket_name: "BucketName",
      },
      write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
    },
    marketo: {
      object: "Object", # required
      error_handling_config: {
        fail_on_first_destination_error: false,
        bucket_prefix: "BucketPrefix",
        bucket_name: "BucketName",
      },
    },
    custom_connector: {
      entity_name: "EntityName", # required
      error_handling_config: {
        fail_on_first_destination_error: false,
        bucket_prefix: "BucketPrefix",
        bucket_name: "BucketName",
      },
      write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
      id_field_names: ["Name"],
      custom_properties: {
        "CustomPropertyKey" => "CustomPropertyValue",
      },
    },
    sapo_data: {
      object_path: "Object", # required
      success_response_handling_config: {
        bucket_prefix: "BucketPrefix",
        bucket_name: "BucketName",
      },
      id_field_names: ["Name"],
      error_handling_config: {
        fail_on_first_destination_error: false,
        bucket_prefix: "BucketPrefix",
        bucket_name: "BucketName",
      },
      write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
    },
  },
}

Contains information about the configuration of destination connectors present in the flow.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_version ⇒ String

The API version that the destination connector uses.

Returns:

  • (String) 


3515
3516
3517
3518
3519
3520
3521
3522
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3515

class DestinationFlowConfig < Struct.new(
  :connector_type,
  :api_version,
  :connector_profile_name,
  :destination_connector_properties)
  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) 


3515
3516
3517
3518
3519
3520
3521
3522
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3515

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

#connector_type ⇒ String

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

Returns:

  • (String) 


3515
3516
3517
3518
3519
3520
3521
3522
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3515

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

#destination_connector_properties ⇒ Types::DestinationConnectorProperties

This stores the information that is required to query a particular connector.

Returns:



3515
3516
3517
3518
3519
3520
3521
3522
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3515

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