Class: AWSCDK::AppFlow::CfnConnectorProfile::CustomConnectorProfileCredentialsProperty

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

Overview

The connector-specific profile credentials that are required when using the custom connector.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(authentication_type:, api_key: nil, basic: nil, custom: nil, oauth2: nil) ⇒ CustomConnectorProfileCredentialsProperty

Returns a new instance of CustomConnectorProfileCredentialsProperty.

Parameters:



1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
 
# File 'app_flow/cfn_connector_profile.rb', line 1213

def initialize(authentication_type:, api_key: nil, basic: nil, custom: nil, oauth2: nil)
  @authentication_type = authentication_type
  Jsii::Type.check_type(@authentication_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authenticationType")
  @api_key = api_key.is_a?(Hash) ? ::AWSCDK::AppFlow::CfnConnectorProfile::APIKeyCredentialsProperty.new(**api_key.transform_keys(&:to_sym)) : api_key
  Jsii::Type.check_type(@api_key, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkNvbm5lY3RvclByb2ZpbGUuQXBpS2V5Q3JlZGVudGlhbHNQcm9wZXJ0eSJ9XX19")), "apiKey") unless @api_key.nil?
  @basic = basic.is_a?(Hash) ? ::AWSCDK::AppFlow::CfnConnectorProfile::BasicAuthCredentialsProperty.new(**basic.transform_keys(&:to_sym)) : basic
  Jsii::Type.check_type(@basic, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkNvbm5lY3RvclByb2ZpbGUuQmFzaWNBdXRoQ3JlZGVudGlhbHNQcm9wZXJ0eSJ9XX19")), "basic") unless @basic.nil?
  @custom = custom.is_a?(Hash) ? ::AWSCDK::AppFlow::CfnConnectorProfile::CustomAuthCredentialsProperty.new(**custom.transform_keys(&:to_sym)) : custom
  Jsii::Type.check_type(@custom, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkNvbm5lY3RvclByb2ZpbGUuQ3VzdG9tQXV0aENyZWRlbnRpYWxzUHJvcGVydHkifV19fQ==")), "custom") unless @custom.nil?
  @oauth2 = oauth2.is_a?(Hash) ? ::AWSCDK::AppFlow::CfnConnectorProfile::OAuth2CredentialsProperty.new(**oauth2.transform_keys(&:to_sym)) : oauth2
  Jsii::Type.check_type(@oauth2, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkNvbm5lY3RvclByb2ZpbGUuT0F1dGgyQ3JlZGVudGlhbHNQcm9wZXJ0eSJ9XX19")), "oauth2") unless @oauth2.nil?
end

Instance Attribute Details

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

The API keys required for the authentication of the user.

Returns:

See Also:



1235
1236
1237
 
# File 'app_flow/cfn_connector_profile.rb', line 1235

def api_key
  @api_key
end

#authentication_type ⇒ String (readonly)

The authentication type that the custom connector uses for authenticating while creating a connector profile.

Returns:

  • (String)

See Also:



1230
1231
1232
 
# File 'app_flow/cfn_connector_profile.rb', line 1230

def authentication_type
  @authentication_type
end

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

The basic credentials that are required for the authentication of the user.

Returns:

See Also:



1240
1241
1242
 
# File 'app_flow/cfn_connector_profile.rb', line 1240

def basic
  @basic
end

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

If the connector uses the custom authentication mechanism, this holds the required credentials.

Returns:

See Also:



1245
1246
1247
 
# File 'app_flow/cfn_connector_profile.rb', line 1245

def custom
  @custom
end

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

The OAuth 2.0 credentials required for the authentication of the user.

Returns:

See Also:



1250
1251
1252
 
# File 'app_flow/cfn_connector_profile.rb', line 1250

def oauth2
  @oauth2
end

Class Method Details

.jsii_properties ⇒ Object 



1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'app_flow/cfn_connector_profile.rb', line 1252

def self.jsii_properties
  {
    :authentication_type => "authenticationType",
    :api_key => "apiKey",
    :basic => "basic",
    :custom => "custom",
    :oauth2 => "oauth2",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
 
# File 'app_flow/cfn_connector_profile.rb', line 1262

def to_jsii
  result = {}
  result.merge!({
    "authenticationType" => @authentication_type,
    "apiKey" => @api_key,
    "basic" => @basic,
    "custom" => @custom,
    "oauth2" => @oauth2,
  })
  result.compact
end