Class: AWSCDK::QBusiness::CfnPlugin::PluginAuthConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
q_business/cfn_plugin.rb

Overview

Authentication configuration information for an Amazon Q Business plugin.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(basic_auth_configuration: nil, no_auth_configuration: nil, o_auth2_client_credential_configuration: nil) ⇒ PluginAuthConfigurationProperty

Returns a new instance of PluginAuthConfigurationProperty.

Parameters:



852
853
854
855
856
857
858
859
 
# File 'q_business/cfn_plugin.rb', line 852

def initialize(basic_auth_configuration: nil, no_auth_configuration: nil, o_auth2_client_credential_configuration: nil)
  @basic_auth_configuration = basic_auth_configuration.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnPlugin::BasicAuthConfigurationProperty.new(**basic_auth_configuration.transform_keys(&:to_sym)) : basic_auth_configuration
  Jsii::Type.check_type(@basic_auth_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuUGx1Z2luLkJhc2ljQXV0aENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "basicAuthConfiguration") unless @basic_auth_configuration.nil?
  @no_auth_configuration = no_auth_configuration
  Jsii::Type.check_type(@no_auth_configuration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "noAuthConfiguration") unless @no_auth_configuration.nil?
  @o_auth2_client_credential_configuration = o_auth2_client_credential_configuration.is_a?(Hash) ? ::AWSCDK::QBusiness::CfnPlugin::OAuth2ClientCredentialConfigurationProperty.new(**o_auth2_client_credential_configuration.transform_keys(&:to_sym)) : o_auth2_client_credential_configuration
  Jsii::Type.check_type(@o_auth2_client_credential_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xYnVzaW5lc3MuQ2ZuUGx1Z2luLk9BdXRoMkNsaWVudENyZWRlbnRpYWxDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "oAuth2ClientCredentialConfiguration") unless @o_auth2_client_credential_configuration.nil?
end

Instance Attribute Details

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

Information about the basic authentication credentials used to configure a plugin.

Returns:

See Also:



865
866
867
 
# File 'q_business/cfn_plugin.rb', line 865

def basic_auth_configuration
  @basic_auth_configuration
end

#no_auth_configuration ⇒ Object? (readonly)

Information about invoking a custom plugin without any authentication.

Returns:

  • (Object, nil)

See Also:



870
871
872
 
# File 'q_business/cfn_plugin.rb', line 870

def no_auth_configuration
  @no_auth_configuration
end

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

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

Returns:

See Also:



875
876
877
 
# File 'q_business/cfn_plugin.rb', line 875

def o_auth2_client_credential_configuration
  @o_auth2_client_credential_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



877
878
879
880
881
882
883
 
# File 'q_business/cfn_plugin.rb', line 877

def self.jsii_properties
  {
    :basic_auth_configuration => "basicAuthConfiguration",
    :no_auth_configuration => "noAuthConfiguration",
    :o_auth2_client_credential_configuration => "oAuth2ClientCredentialConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



885
886
887
888
889
890
891
892
893
 
# File 'q_business/cfn_plugin.rb', line 885

def to_jsii
  result = {}
  result.merge!({
    "basicAuthConfiguration" => @basic_auth_configuration,
    "noAuthConfiguration" => @no_auth_configuration,
    "oAuth2ClientCredentialConfiguration" => @o_auth2_client_credential_configuration,
  })
  result.compact
end