Class: AWSCDK::AppFlow::CfnFlow::CustomConnectorDestinationPropertiesProperty

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

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(entity_name:, custom_properties: nil, error_handling_config: nil, id_field_names: nil, write_operation_type: nil) ⇒ CustomConnectorDestinationPropertiesProperty

Returns a new instance of CustomConnectorDestinationPropertiesProperty.

Parameters:

  • entity_name (String) —

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

  • custom_properties (AWSCDK::IResolvable, Hash{String => String}, nil) (defaults to: nil) —

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

  • 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 custom connector as destination.

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

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

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

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



942
943
944
945
946
947
948
949
950
951
952
953
 
# File 'app_flow/cfn_flow.rb', line 942

def initialize(entity_name:, custom_properties: nil, error_handling_config: nil, id_field_names: nil, write_operation_type: nil)
  @entity_name = entity_name
  Jsii::Type.check_type(@entity_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "entityName")
  @custom_properties = custom_properties
  Jsii::Type.check_type(@custom_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "customProperties") unless @custom_properties.nil?
  @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?
  @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

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

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

Returns:

See Also:



964
965
966
 
# File 'app_flow/cfn_flow.rb', line 964

def custom_properties
  @custom_properties
end

#entity_name ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



959
960
961
 
# File 'app_flow/cfn_flow.rb', line 959

def entity_name
  @entity_name
end

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

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

Returns:

See Also:



969
970
971
 
# File 'app_flow/cfn_flow.rb', line 969

def error_handling_config
  @error_handling_config
end

#id_field_names ⇒ Array<String>? (readonly)

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>, nil)

See Also:



974
975
976
 
# File 'app_flow/cfn_flow.rb', line 974

def id_field_names
  @id_field_names
end

#write_operation_type ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



979
980
981
 
# File 'app_flow/cfn_flow.rb', line 979

def write_operation_type
  @write_operation_type
end

Class Method Details

.jsii_properties ⇒ Object 



981
982
983
984
985
986
987
988
989
 
# File 'app_flow/cfn_flow.rb', line 981

def self.jsii_properties
  {
    :entity_name => "entityName",
    :custom_properties => "customProperties",
    :error_handling_config => "errorHandlingConfig",
    :id_field_names => "idFieldNames",
    :write_operation_type => "writeOperationType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'app_flow/cfn_flow.rb', line 991

def to_jsii
  result = {}
  result.merge!({
    "entityName" => @entity_name,
    "customProperties" => @custom_properties,
    "errorHandlingConfig" => @error_handling_config,
    "idFieldNames" => @id_field_names,
    "writeOperationType" => @write_operation_type,
  })
  result.compact
end