Class: Aws::QBusiness::Types::PluginAuthConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure, Structure::Union
Defined in:
lib/aws-sdk-qbusiness/types.rb

Overview

Note:

PluginAuthConfiguration is a union - when making an API calls you must set exactly one of the members.

Note:

PluginAuthConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PluginAuthConfiguration corresponding to the set member.

Authentication configuration information for an Amazon Q Business plugin.

See Also:

Defined Under Namespace

Classes: BasicAuthConfiguration, IdcAuthConfiguration, NoAuthConfiguration, OAuth2ClientCredentialConfiguration, Unknown

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#basic_auth_configuration ⇒ Types::BasicAuthConfiguration

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

Returns:



6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6073

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#idc_auth_configuration ⇒ Types::IdcAuthConfiguration

Information about the IAM Identity Center Application used to configure authentication for a plugin.

Returns:



6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6073

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#no_auth_configuration ⇒ Types::NoAuthConfiguration

Information about invoking a custom plugin without any authentication.

Returns:



6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6073

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#o_auth_2_client_credential_configuration ⇒ Types::OAuth2ClientCredentialConfiguration

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

Returns:



6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6073

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



6073
6074
6075
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6073

def unknown
  @unknown
end