Class: AWSCDK::AppFlow::CfnConnectorProfile::SAPODataConnectorProfilePropertiesProperty

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

Overview

The connector-specific profile properties required when using SAPOData.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_host_url: nil, application_service_path: nil, client_number: nil, disable_sso: nil, logon_language: nil, o_auth_properties: nil, port_number: nil, private_link_service_name: nil) ⇒ SAPODataConnectorProfilePropertiesProperty

Returns a new instance of SAPODataConnectorProfilePropertiesProperty.

Parameters:

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

    The location of the SAPOData resource.

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

    The application path to catalog service.

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

    The client number for the client creating the connection.

  • disable_sso (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    If you set this parameter to true , Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.

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

    The logon language of SAPOData instance.

  • o_auth_properties (AWSCDK::IResolvable, AWSCDK::AppFlow::CfnConnectorProfile::OAuthPropertiesProperty, nil) (defaults to: nil) —

    The SAPOData OAuth properties required for OAuth type authentication.

  • port_number (Numeric, nil) (defaults to: nil) —

    The port number of the SAPOData instance.

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

    The SAPOData Private Link service name to be used for private data transfers.



2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
 
# File 'app_flow/cfn_connector_profile.rb', line 2310

def initialize(application_host_url: nil, application_service_path: nil, client_number: nil, disable_sso: nil, logon_language: nil, o_auth_properties: nil, port_number: nil, private_link_service_name: nil)
  @application_host_url = application_host_url
  Jsii::Type.check_type(@application_host_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationHostUrl") unless @application_host_url.nil?
  @application_service_path = application_service_path
  Jsii::Type.check_type(@application_service_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationServicePath") unless @application_service_path.nil?
  @client_number = client_number
  Jsii::Type.check_type(@client_number, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientNumber") unless @client_number.nil?
  @disable_sso = disable_sso
  Jsii::Type.check_type(@disable_sso, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "disableSso") unless @disable_sso.nil?
  @logon_language = logon_language
  Jsii::Type.check_type(@logon_language, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logonLanguage") unless @logon_language.nil?
  @o_auth_properties = o_auth_properties.is_a?(Hash) ? ::AWSCDK::AppFlow::CfnConnectorProfile::OAuthPropertiesProperty.new(**o_auth_properties.transform_keys(&:to_sym)) : o_auth_properties
  Jsii::Type.check_type(@o_auth_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkNvbm5lY3RvclByb2ZpbGUuT0F1dGhQcm9wZXJ0aWVzUHJvcGVydHkifV19fQ==")), "oAuthProperties") unless @o_auth_properties.nil?
  @port_number = port_number
  Jsii::Type.check_type(@port_number, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "portNumber") unless @port_number.nil?
  @private_link_service_name = private_link_service_name
  Jsii::Type.check_type(@private_link_service_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "privateLinkServiceName") unless @private_link_service_name.nil?
end

Instance Attribute Details

#application_host_url ⇒ String? (readonly)

The location of the SAPOData resource.

Returns:

  • (String, nil)

See Also:



2333
2334
2335
 
# File 'app_flow/cfn_connector_profile.rb', line 2333

def application_host_url
  @application_host_url
end

#application_service_path ⇒ String? (readonly)

The application path to catalog service.

Returns:

  • (String, nil)

See Also:



2338
2339
2340
 
# File 'app_flow/cfn_connector_profile.rb', line 2338

def application_service_path
  @application_service_path
end

#client_number ⇒ String? (readonly)

The client number for the client creating the connection.

Returns:

  • (String, nil)

See Also:



2343
2344
2345
 
# File 'app_flow/cfn_connector_profile.rb', line 2343

def client_number
  @client_number
end

#disable_sso ⇒ Boolean, ... (readonly)

If you set this parameter to true , Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.

Whether you need this option depends on the types of credentials that you applied to your SAP OData connection profile. If your profile uses basic authentication credentials, SAP SSO can prevent Amazon AppFlow from connecting to your account with your username and password. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect successfully. However, if your profile uses OAuth credentials, this parameter has no affect.

Returns:

See Also:



2350
2351
2352
 
# File 'app_flow/cfn_connector_profile.rb', line 2350

def disable_sso
  @disable_sso
end

#logon_language ⇒ String? (readonly)

The logon language of SAPOData instance.

Returns:

  • (String, nil)

See Also:



2355
2356
2357
 
# File 'app_flow/cfn_connector_profile.rb', line 2355

def logon_language
  @logon_language
end

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

The SAPOData OAuth properties required for OAuth type authentication.

Returns:

See Also:



2360
2361
2362
 
# File 'app_flow/cfn_connector_profile.rb', line 2360

def o_auth_properties
  @o_auth_properties
end

#port_number ⇒ Numeric? (readonly)

The port number of the SAPOData instance.

Returns:

  • (Numeric, nil)

See Also:



2365
2366
2367
 
# File 'app_flow/cfn_connector_profile.rb', line 2365

def port_number
  @port_number
end

#private_link_service_name ⇒ String? (readonly)

The SAPOData Private Link service name to be used for private data transfers.

Returns:

  • (String, nil)

See Also:



2370
2371
2372
 
# File 'app_flow/cfn_connector_profile.rb', line 2370

def private_link_service_name
  @private_link_service_name
end

Class Method Details

.jsii_properties ⇒ Object 



2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'app_flow/cfn_connector_profile.rb', line 2372

def self.jsii_properties
  {
    :application_host_url => "applicationHostUrl",
    :application_service_path => "applicationServicePath",
    :client_number => "clientNumber",
    :disable_sso => "disableSso",
    :logon_language => "logonLanguage",
    :o_auth_properties => "oAuthProperties",
    :port_number => "portNumber",
    :private_link_service_name => "privateLinkServiceName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
 
# File 'app_flow/cfn_connector_profile.rb', line 2385

def to_jsii
  result = {}
  result.merge!({
    "applicationHostUrl" => @application_host_url,
    "applicationServicePath" => @application_service_path,
    "clientNumber" => @client_number,
    "disableSso" => @disable_sso,
    "logonLanguage" => @logon_language,
    "oAuthProperties" => @o_auth_properties,
    "portNumber" => @port_number,
    "privateLinkServiceName" => @private_link_service_name,
  })
  result.compact
end