Class: AWSCDK::AppFlow::CfnFlow::SourceFlowConfigProperty

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

Overview

Contains information about the configuration of the source connector used in the flow.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of SourceFlowConfigProperty.

Parameters:



2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
 
# File 'app_flow/cfn_flow.rb', line 2977

def initialize(connector_type:, source_connector_properties:, api_version: nil, 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::AppFlow::CfnFlow::SourceConnectorPropertiesProperty.new(**source_connector_properties.transform_keys(&:to_sym)) : source_connector_properties
  Jsii::Type.check_type(@source_connector_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkZsb3cuU291cmNlQ29ubmVjdG9yUHJvcGVydGllc1Byb3BlcnR5In1dfX0=")), "sourceConnectorProperties")
  @api_version = api_version
  Jsii::Type.check_type(@api_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiVersion") unless @api_version.nil?
  @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::AppFlow::CfnFlow::IncrementalPullConfigProperty.new(**incremental_pull_config.transform_keys(&:to_sym)) : incremental_pull_config
  Jsii::Type.check_type(@incremental_pull_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkZsb3cuSW5jcmVtZW50YWxQdWxsQ29uZmlnUHJvcGVydHkifV19fQ==")), "incrementalPullConfig") unless @incremental_pull_config.nil?
end

Instance Attribute Details

#api_version ⇒ String? (readonly)

The API version of the connector when it's used as a source in the flow.

Returns:

  • (String, nil)

See Also:



3004
3005
3006
 
# File 'app_flow/cfn_flow.rb', line 3004

def api_version
  @api_version
end

#connector_profile_name ⇒ String? (readonly)

The name of the connector profile.

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

Returns:

  • (String, nil)

See Also:



3011
3012
3013
 
# File 'app_flow/cfn_flow.rb', line 3011

def connector_profile_name
  @connector_profile_name
end

#connector_type ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



2994
2995
2996
 
# File 'app_flow/cfn_flow.rb', line 2994

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:



3018
3019
3020
 
# File 'app_flow/cfn_flow.rb', line 3018

def incremental_pull_config
  @incremental_pull_config
end

#source_connector_properties ⇒ AWSCDK::IResolvable, AWSCDK::AppFlow::CfnFlow::SourceConnectorPropertiesProperty (readonly)

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

Returns:

See Also:



2999
3000
3001
 
# File 'app_flow/cfn_flow.rb', line 2999

def source_connector_properties
  @source_connector_properties
end

Class Method Details

.jsii_properties ⇒ Object 



3020
3021
3022
3023
3024
3025
3026
3027
3028
 
# File 'app_flow/cfn_flow.rb', line 3020

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

Instance Method Details

#to_jsii ⇒ Object 



3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
 
# File 'app_flow/cfn_flow.rb', line 3030

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