Class: AWSCDK::CustomerProfiles::CfnIntegration::SourceFlowConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
customer_profiles/cfn_integration.rb

Overview

The configuration that controls how Customer Profiles retrieves data from the source.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connector_type:, source_connector_properties:, connector_profile_name: nil, incremental_pull_config: nil) ⇒ SourceFlowConfigProperty

Returns a new instance of SourceFlowConfigProperty.

Parameters:



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
 
# File 'customer_profiles/cfn_integration.rb', line 1183

def initialize(connector_type:, source_connector_properties:, connector_profile_name: nil, incremental_pull_config: nil)
  @connector_type = connector_type
  Jsii::Type.check_type(@connector_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectorType")
  @source_connector_properties = source_connector_properties.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnIntegration::SourceConnectorPropertiesProperty.new(**source_connector_properties.transform_keys(&:to_sym)) : source_connector_properties
  Jsii::Type.check_type(@source_connector_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkludGVncmF0aW9uLlNvdXJjZUNvbm5lY3RvclByb3BlcnRpZXNQcm9wZXJ0eSJ9XX19")), "sourceConnectorProperties")
  @connector_profile_name = connector_profile_name
  Jsii::Type.check_type(@connector_profile_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectorProfileName") unless @connector_profile_name.nil?
  @incremental_pull_config = incremental_pull_config.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnIntegration::IncrementalPullConfigProperty.new(**incremental_pull_config.transform_keys(&:to_sym)) : incremental_pull_config
  Jsii::Type.check_type(@incremental_pull_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkludGVncmF0aW9uLkluY3JlbWVudGFsUHVsbENvbmZpZ1Byb3BlcnR5In1dfX0=")), "incrementalPullConfig") unless @incremental_pull_config.nil?
end

Instance Attribute Details

#connector_profile_name ⇒ String? (readonly)

The name of the Amazon AppFlow connector profile.

This name must be unique for each connector profile in the AWS account .

Returns:

  • (String, nil)

See Also:



1210
1211
1212
 
# File 'customer_profiles/cfn_integration.rb', line 1210

def connector_profile_name
  @connector_profile_name
end

#connector_type ⇒ String (readonly)

The type of connector, such as Salesforce, Marketo, and so on.

Returns:

  • (String)

See Also:



1198
1199
1200
 
# File 'customer_profiles/cfn_integration.rb', line 1198

def connector_type
  @connector_type
end

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

Defines the configuration for a scheduled incremental data pull.

If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.

Returns:

See Also:



1217
1218
1219
 
# File 'customer_profiles/cfn_integration.rb', line 1217

def incremental_pull_config
  @incremental_pull_config
end

#source_connector_properties ⇒ AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnIntegration::SourceConnectorPropertiesProperty (readonly)

Specifies the information that is required to query a particular source connector.

Returns:

See Also:



1203
1204
1205
 
# File 'customer_profiles/cfn_integration.rb', line 1203

def source_connector_properties
  @source_connector_properties
end

Class Method Details

.jsii_properties ⇒ Object 



1219
1220
1221
1222
1223
1224
1225
1226
 
# File 'customer_profiles/cfn_integration.rb', line 1219

def self.jsii_properties
  {
    :connector_type => "connectorType",
    :source_connector_properties => "sourceConnectorProperties",
    :connector_profile_name => "connectorProfileName",
    :incremental_pull_config => "incrementalPullConfig",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
 
# File 'customer_profiles/cfn_integration.rb', line 1228

def to_jsii
  result = {}
  result.merge!({
    "connectorType" => @connector_type,
    "sourceConnectorProperties" => @source_connector_properties,
    "connectorProfileName" => @connector_profile_name,
    "incrementalPullConfig" => @incremental_pull_config,
  })
  result.compact
end