Class: AWSCDK::AppFlow::CfnFlow::SAPODataDestinationPropertiesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_flow/cfn_flow.rb

Overview

The properties that are applied when using SAPOData as a flow destination.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(object_path:, error_handling_config: nil, id_field_names: nil, success_response_handling_config: nil, write_operation_type: nil) ⇒ SAPODataDestinationPropertiesProperty

Returns a new instance of SAPODataDestinationPropertiesProperty.

Parameters:

  • object_path (String) —

    The object path specified in the SAPOData flow destination.

  • error_handling_config (AWSCDK::IResolvable, AWSCDK::AppFlow::CfnFlow::ErrorHandlingConfigProperty, nil) (defaults to: nil) —

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

  • id_field_names (Array<String>, nil) (defaults to: nil) —

    A list of field names that can be used as an ID field when performing a write operation.

  • success_response_handling_config (AWSCDK::IResolvable, AWSCDK::AppFlow::CfnFlow::SuccessResponseHandlingConfigProperty, nil) (defaults to: nil) —

    Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.

  • write_operation_type (String, nil) (defaults to: nil) —

    The possible write operations in the destination connector.



2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
 
# File 'app_flow/cfn_flow.rb', line 2139

def initialize(object_path:, error_handling_config: nil, id_field_names: nil, success_response_handling_config: nil, write_operation_type: nil)
  @object_path = object_path
  Jsii::Type.check_type(@object_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "objectPath")
  @error_handling_config = error_handling_config.is_a?(Hash) ? ::AWSCDK::AppFlow::CfnFlow::ErrorHandlingConfigProperty.new(**error_handling_config.transform_keys(&:to_sym)) : error_handling_config
  Jsii::Type.check_type(@error_handling_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkZsb3cuRXJyb3JIYW5kbGluZ0NvbmZpZ1Byb3BlcnR5In1dfX0=")), "errorHandlingConfig") unless @error_handling_config.nil?
  @id_field_names = id_field_names
  Jsii::Type.check_type(@id_field_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "idFieldNames") unless @id_field_names.nil?
  @success_response_handling_config = success_response_handling_config.is_a?(Hash) ? ::AWSCDK::AppFlow::CfnFlow::SuccessResponseHandlingConfigProperty.new(**success_response_handling_config.transform_keys(&:to_sym)) : success_response_handling_config
  Jsii::Type.check_type(@success_response_handling_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkZsb3cuU3VjY2Vzc1Jlc3BvbnNlSGFuZGxpbmdDb25maWdQcm9wZXJ0eSJ9XX19")), "successResponseHandlingConfig") unless @success_response_handling_config.nil?
  @write_operation_type = write_operation_type
  Jsii::Type.check_type(@write_operation_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "writeOperationType") unless @write_operation_type.nil?
end

Instance Attribute Details

#error_handling_config ⇒ AWSCDK::IResolvable, ... (readonly)

The settings that determine how Amazon AppFlow handles an error when placing data in the 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.

Returns:

See Also:



2163
2164
2165
 
# File 'app_flow/cfn_flow.rb', line 2163

def error_handling_config
  @error_handling_config
end

#id_field_names ⇒ Array<String>? (readonly)

A list of field names that can be used as an ID field when performing a write operation.

Returns:

  • (Array<String>, nil)

See Also:



2168
2169
2170
 
# File 'app_flow/cfn_flow.rb', line 2168

def id_field_names
  @id_field_names
end

#object_path ⇒ String (readonly)

The object path specified in the SAPOData flow destination.

Returns:

  • (String)

See Also:



2156
2157
2158
 
# File 'app_flow/cfn_flow.rb', line 2156

def object_path
  @object_path
end

#success_response_handling_config ⇒ AWSCDK::IResolvable, ... (readonly)

Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.

For example, this setting would determine where to write the response from a destination connector upon a successful insert operation.

Returns:

See Also:



2175
2176
2177
 
# File 'app_flow/cfn_flow.rb', line 2175

def success_response_handling_config
  @success_response_handling_config
end

#write_operation_type ⇒ String? (readonly)

The possible write operations in the destination connector.

When this value is not provided, this defaults to the INSERT operation.

Returns:

  • (String, nil)

See Also:



2182
2183
2184
 
# File 'app_flow/cfn_flow.rb', line 2182

def write_operation_type
  @write_operation_type
end

Class Method Details

.jsii_properties ⇒ Object 



2184
2185
2186
2187
2188
2189
2190
2191
2192
 
# File 'app_flow/cfn_flow.rb', line 2184

def self.jsii_properties
  {
    :object_path => "objectPath",
    :error_handling_config => "errorHandlingConfig",
    :id_field_names => "idFieldNames",
    :success_response_handling_config => "successResponseHandlingConfig",
    :write_operation_type => "writeOperationType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
 
# File 'app_flow/cfn_flow.rb', line 2194

def to_jsii
  result = {}
  result.merge!({
    "objectPath" => @object_path,
    "errorHandlingConfig" => @error_handling_config,
    "idFieldNames" => @id_field_names,
    "successResponseHandlingConfig" => @success_response_handling_config,
    "writeOperationType" => @write_operation_type,
  })
  result.compact
end