Class: Aws::Appflow::Types::CustomConnectorDestinationProperties

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

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

The properties that are applied when the custom connector is being used as a destination.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_propertiesHash<String,String>

The custom properties that are specific to the connector when it's used as a destination in the flow.

Returns:

  • (Hash<String,String>)


2442
2443
2444
2445
2446
2447
2448
2449
2450
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2442

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

#entity_nameString

The entity specified in the custom connector as a destination in the flow.

Returns:

  • (String)


2442
2443
2444
2445
2446
2447
2448
2449
2450
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2442

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

#error_handling_configTypes::ErrorHandlingConfig

The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination.



2442
2443
2444
2445
2446
2447
2448
2449
2450
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2442

class CustomConnectorDestinationProperties < Struct.new(
  :entity_name,
  :error_handling_config,
  :write_operation_type,
  :id_field_names,
  :custom_properties)
  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, delete, or upsert.

Returns:

  • (Array<String>)


2442
2443
2444
2445
2446
2447
2448
2449
2450
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2442

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

#write_operation_typeString

Specifies the type of write operation to be performed in the custom connector when it's used as destination.

Returns:

  • (String)


2442
2443
2444
2445
2446
2447
2448
2449
2450
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2442

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