The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CustomPluginConfiguration_ApiSchema_Payload |
The identifier of the application that will contain the plugin.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Information about invoking a custom plugin without any authentication.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-BasicAuthConfiguration_RoleArn <
String>
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AuthConfiguration_BasicAuthConfiguration_RoleArn |
-BasicAuthConfiguration_SecretArn <
String>
The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AuthConfiguration_BasicAuthConfiguration_SecretArn |
Amazon.PowerShell.Cmdlets.QBUS.AmazonQBusinessClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A token that you provide to identify the request to create your Amazon Q Business plugin.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The type of OpenAPI schema to use.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-CustomPluginConfiguration_Description <
String>
A description for your custom plugin configuration.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A the name for your plugin.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-OAuth2ClientCredentialConfiguration_RoleArn <
String>
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AuthConfiguration_OAuth2ClientCredentialConfiguration_RoleArn |
-OAuth2ClientCredentialConfiguration_SecretArn <
String>
The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AuthConfiguration_OAuth2ClientCredentialConfiguration_SecretArn |
Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The name of the S3 bucket that contains the file.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CustomPluginConfiguration_ApiSchema_S3_Bucket |
The name of the file.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CustomPluginConfiguration_ApiSchema_S3_Key |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.CreatePluginResponse). Specifying the name of a property of type Amazon.QBusiness.Model.CreatePluginResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The source URL used for plugin configuration.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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: _ . : / = + - @.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
The type of plugin you want to create.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |