Class: Aws::QBusiness::Types::CreatePluginRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The identifier of the application that will contain the plugin.

Returns:

  • (String) 


2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2010

class CreatePluginRequest < Struct.new(
  :application_id,
  :display_name,
  :type,
  :auth_configuration,
  :server_url,
  :custom_plugin_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#auth_configuration ⇒ Types::PluginAuthConfiguration

Authentication configuration information for an Amazon Q Business plugin.

Returns:



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2010

class CreatePluginRequest < Struct.new(
  :application_id,
  :display_name,
  :type,
  :auth_configuration,
  :server_url,
  :custom_plugin_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A token that you provide to identify the request to create your Amazon Q Business plugin.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2010

class CreatePluginRequest < Struct.new(
  :application_id,
  :display_name,
  :type,
  :auth_configuration,
  :server_url,
  :custom_plugin_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#custom_plugin_configuration ⇒ Types::CustomPluginConfiguration

Contains configuration for a custom plugin.

Returns:



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2010

class CreatePluginRequest < Struct.new(
  :application_id,
  :display_name,
  :type,
  :auth_configuration,
  :server_url,
  :custom_plugin_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

A the name for your plugin.

Returns:

  • (String) 


2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2010

class CreatePluginRequest < Struct.new(
  :application_id,
  :display_name,
  :type,
  :auth_configuration,
  :server_url,
  :custom_plugin_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#server_url ⇒ String

The source URL used for plugin configuration.

Returns:

  • (String) 


2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2010

class CreatePluginRequest < Struct.new(
  :application_id,
  :display_name,
  :type,
  :auth_configuration,
  :server_url,
  :custom_plugin_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2010

class CreatePluginRequest < Struct.new(
  :application_id,
  :display_name,
  :type,
  :auth_configuration,
  :server_url,
  :custom_plugin_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of plugin you want to create.

Returns:

  • (String) 


2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2010

class CreatePluginRequest < Struct.new(
  :application_id,
  :display_name,
  :type,
  :auth_configuration,
  :server_url,
  :custom_plugin_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end