Class: Aws::Appflow::Types::SalesforceDestinationProperties

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 SalesforceDestinationProperties data as a hash:

{
  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
}

The properties that are applied when Salesforce is being used as a destination.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#error_handling_configTypes::ErrorHandlingConfig

The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.



3434
3435
3436
3437
3438
3439
3440
3441
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3434

class SalesforceDestinationProperties < Struct.new(
  :object,
  :id_field_names,
  :error_handling_config,
  :write_operation_type)
  SENSITIVE = []
  include Aws::Structure
end

#id_field_namesArray<String>

The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.

Returns:

  • (Array<String>)


3434
3435
3436
3437
3438
3439
3440
3441
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3434

class SalesforceDestinationProperties < Struct.new(
  :object,
  :id_field_names,
  :error_handling_config,
  :write_operation_type)
  SENSITIVE = []
  include Aws::Structure
end

#objectString

The object specified in the Salesforce flow destination.

Returns:

  • (String)


3434
3435
3436
3437
3438
3439
3440
3441
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3434

class SalesforceDestinationProperties < Struct.new(
  :object,
  :id_field_names,
  :error_handling_config,
  :write_operation_type)
  SENSITIVE = []
  include Aws::Structure
end

#write_operation_typeString

This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT, then idFieldNames is required.

Returns:

  • (String)


3434
3435
3436
3437
3438
3439
3440
3441
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3434

class SalesforceDestinationProperties < Struct.new(
  :object,
  :id_field_names,
  :error_handling_config,
  :write_operation_type)
  SENSITIVE = []
  include Aws::Structure
end