aws_qbusiness_plugin

account_id

Type: STRING

application_id

Type: STRING
Provider name: applicationId
Description: The identifier of the application which contains the plugin.

auth_configuration

Type: STRUCT
Provider name: authConfiguration

• basic_auth_configuration
  Type: STRUCT
  Provider name: basicAuthConfiguration
  Description: Information about the basic authentication credentials used to configure a plugin.
  

  • role_arn
    Type: STRING
    Provider name: roleArn
    Description: The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    
  • secret_arn
    Type: STRING
    Provider name: secretArn
    Description: The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
    

• idc_auth_configuration
  Type: STRUCT
  Provider name: idcAuthConfiguration
  Description: Information about the IAM Identity Center Application used to configure authentication for a plugin.
  

  • idc_application_arn
    Type: STRING
    Provider name: idcApplicationArn
    Description: The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication.
    
  • role_arn
    Type: STRING
    Provider name: roleArn
    Description: The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf.
    

• no_auth_configuration
  Type: STRUCT
  Provider name: noAuthConfiguration
  Description: Information about invoking a custom plugin without any authentication.
  

• o_auth2_client_credential_configuration
  Type: STRUCT
  Provider name: oAuth2ClientCredentialConfiguration
  Description: Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
  

  • authorization_url
    Type: STRING
    Provider name: authorizationUrl
    Description: The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
    
  • role_arn
    Type: STRING
    Provider name: roleArn
    Description: The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
    
  • secret_arn
    Type: STRING
    Provider name: secretArn
    Description: The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
    
  • token_url
    Type: STRING
    Provider name: tokenUrl
    Description: The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.
    

build_status

Type: STRING
Provider name: buildStatus
Description: The current status of a plugin. A plugin is modified asynchronously.

created_at

Type: TIMESTAMP
Provider name: createdAt
Description: The timestamp for when the plugin was created.

custom_plugin_configuration

Type: STRUCT
Provider name: customPluginConfiguration
Description: Configuration information required to create a custom plugin.

• api_schema
  Type: STRUCT
  Provider name: apiSchema
  Description: Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
  
  • payload
    Type: STRING
    Provider name: payload
    Description: The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
    
  • s3
    Type: STRUCT
    Provider name: s3
    Description: Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.
    
    • bucket
      Type: STRING
      Provider name: bucket
      Description: The name of the S3 bucket that contains the file.
      
    • key
      Type: STRING
      Provider name: key
      Description: The name of the file.
      
• api_schema_type
  Type: STRING
  Provider name: apiSchemaType
  Description: The type of OpenAPI schema to use.
  
• description
  Type: STRING
  Provider name: description
  Description: A description for your custom plugin configuration.
  

plugin_arn

Type: STRING
Provider name: pluginArn
Description: The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

plugin_id

Type: STRING
Provider name: pluginId
Description: The identifier of the plugin.

server_url

Type: STRING
Provider name: serverUrl
Description: The source URL used for plugin configuration.

state

Type: STRING
Provider name: state
Description: The current state of the plugin.

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: type
Description: The type of the plugin.

updated_at

Type: TIMESTAMP
Provider name: updatedAt
Description: The timestamp for when the plugin was last updated.