Class: AWSCDK::AppFlow::CfnFlow::ZendeskDestinationPropertiesProperty

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

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(object:, error_handling_config: nil, id_field_names: nil, write_operation_type: nil) ⇒ ZendeskDestinationPropertiesProperty

Returns a new instance of ZendeskDestinationPropertiesProperty.

Parameters:

  • object (String) —

    The object specified in the Zendesk 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.

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

    The possible write operations in the destination connector.



3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
 
# File 'app_flow/cfn_flow.rb', line 3481

def initialize(object:, error_handling_config: nil, id_field_names: nil, write_operation_type: nil)
  @object = object
  Jsii::Type.check_type(@object, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "object")
  @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

#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:



3503
3504
3505
 
# File 'app_flow/cfn_flow.rb', line 3503

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:



3508
3509
3510
 
# File 'app_flow/cfn_flow.rb', line 3508

def id_field_names
  @id_field_names
end

#object ⇒ String (readonly)

The object specified in the Zendesk flow destination.

Returns:

  • (String)

See Also:



3496
3497
3498
 
# File 'app_flow/cfn_flow.rb', line 3496

def object
  @object
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:



3515
3516
3517
 
# File 'app_flow/cfn_flow.rb', line 3515

def write_operation_type
  @write_operation_type
end

Class Method Details

.jsii_properties ⇒ Object 



3517
3518
3519
3520
3521
3522
3523
3524
 
# File 'app_flow/cfn_flow.rb', line 3517

def self.jsii_properties
  {
    :object => "object",
    :error_handling_config => "errorHandlingConfig",
    :id_field_names => "idFieldNames",
    :write_operation_type => "writeOperationType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
 
# File 'app_flow/cfn_flow.rb', line 3526

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