aws-native.qbusiness.getPlugin

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Using getPlugin

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getPlugin(args: GetPluginArgs, opts?: InvokeOptions): Promise<GetPluginResult>
function getPluginOutput(args: GetPluginOutputArgs, opts?: InvokeOptions): Output<GetPluginResult>

def get_plugin(application_id: Optional[str] = None,
               plugin_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetPluginResult
def get_plugin_output(application_id: Optional[pulumi.Input[str]] = None,
               plugin_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetPluginResult]

func LookupPlugin(ctx *Context, args *LookupPluginArgs, opts ...InvokeOption) (*LookupPluginResult, error)
func LookupPluginOutput(ctx *Context, args *LookupPluginOutputArgs, opts ...InvokeOption) LookupPluginResultOutput

> Note: This function is named LookupPlugin in the Go SDK.

public static class GetPlugin 
{
    public static Task<GetPluginResult> InvokeAsync(GetPluginArgs args, InvokeOptions? opts = null)
    public static Output<GetPluginResult> Invoke(GetPluginInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPluginResult> getPlugin(GetPluginArgs args, InvokeOptions options)
public static Output<GetPluginResult> getPlugin(GetPluginArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:qbusiness:getPlugin
  arguments:
    # arguments dictionary

The following arguments are supported:

ApplicationId string: The identifier of the application that will contain the plugin.
PluginId string: The identifier of the plugin.

ApplicationId string: The identifier of the application that will contain the plugin.
PluginId string: The identifier of the plugin.

applicationId String: The identifier of the application that will contain the plugin.
pluginId String: The identifier of the plugin.

applicationId string: The identifier of the application that will contain the plugin.
pluginId string: The identifier of the plugin.

application_id str: The identifier of the application that will contain the plugin.
plugin_id str: The identifier of the plugin.

applicationId String: The identifier of the application that will contain the plugin.
pluginId String: The identifier of the plugin.

getPlugin Result

The following output properties are available:

AuthConfiguration Pulumi.AwsNative.QBusiness.Outputs.PluginAuthConfiguration0Properties | Pulumi.AwsNative.QBusiness.Outputs.PluginAuthConfiguration1Properties | Pulumi.AwsNative.QBusiness.Outputs.PluginAuthConfiguration2Properties: Authentication configuration information for an Amazon Q Business plugin.
BuildStatus Pulumi.AwsNative.QBusiness.PluginBuildStatus: The current status of a plugin. A plugin is modified asynchronously.
CreatedAt string: The timestamp for when the plugin was created.
CustomPluginConfiguration Pulumi.AwsNative.QBusiness.Outputs.PluginCustomPluginConfiguration: Configuration information required to create a custom plugin.
DisplayName string: The name of the plugin.
PluginArn string: The Amazon Resource Name (ARN) of a plugin.
PluginId string: The identifier of the plugin.
ServerUrl string: The plugin server URL used for configuration.
State Pulumi.AwsNative.QBusiness.PluginState: The current status of the plugin.
Tags List<Pulumi.AwsNative.Outputs.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: _ . : / = + - @.
UpdatedAt string: The timestamp for when the plugin was last updated.

AuthConfiguration PluginAuthConfiguration0Properties | PluginAuthConfiguration1Properties | PluginAuthConfiguration2Properties: Authentication configuration information for an Amazon Q Business plugin.
BuildStatus PluginBuildStatus: The current status of a plugin. A plugin is modified asynchronously.
CreatedAt string: The timestamp for when the plugin was created.
CustomPluginConfiguration PluginCustomPluginConfiguration: Configuration information required to create a custom plugin.
DisplayName string: The name of the plugin.
PluginArn string: The Amazon Resource Name (ARN) of a plugin.
PluginId string: The identifier of the plugin.
ServerUrl string: The plugin server URL used for configuration.
State PluginStateEnum: The current status of the plugin.
Tags 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: _ . : / = + - @.
UpdatedAt string: The timestamp for when the plugin was last updated.

authConfiguration PluginAuthConfiguration0Properties | PluginAuthConfiguration1Properties | PluginAuthConfiguration2Properties: Authentication configuration information for an Amazon Q Business plugin.
buildStatus PluginBuildStatus: The current status of a plugin. A plugin is modified asynchronously.
createdAt String: The timestamp for when the plugin was created.
customPluginConfiguration PluginCustomPluginConfiguration: Configuration information required to create a custom plugin.
displayName String: The name of the plugin.
pluginArn String: The Amazon Resource Name (ARN) of a plugin.
pluginId String: The identifier of the plugin.
serverUrl String: The plugin server URL used for configuration.
state PluginState: The current status of the plugin.
tags List<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: _ . : / = + - @.
updatedAt String: The timestamp for when the plugin was last updated.

authConfiguration PluginAuthConfiguration0Properties | PluginAuthConfiguration1Properties | PluginAuthConfiguration2Properties: Authentication configuration information for an Amazon Q Business plugin.
buildStatus PluginBuildStatus: The current status of a plugin. A plugin is modified asynchronously.
createdAt string: The timestamp for when the plugin was created.
customPluginConfiguration PluginCustomPluginConfiguration: Configuration information required to create a custom plugin.
displayName string: The name of the plugin.
pluginArn string: The Amazon Resource Name (ARN) of a plugin.
pluginId string: The identifier of the plugin.
serverUrl string: The plugin server URL used for configuration.
state PluginState: The current status of the plugin.
tags 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: _ . : / = + - @.
updatedAt string: The timestamp for when the plugin was last updated.

auth_configuration PluginAuthConfiguration0Properties | PluginAuthConfiguration1Properties | PluginAuthConfiguration2Properties: Authentication configuration information for an Amazon Q Business plugin.
build_status PluginBuildStatus: The current status of a plugin. A plugin is modified asynchronously.
created_at str: The timestamp for when the plugin was created.
custom_plugin_configuration PluginCustomPluginConfiguration: Configuration information required to create a custom plugin.
display_name str: The name of the plugin.
plugin_arn str: The Amazon Resource Name (ARN) of a plugin.
plugin_id str: The identifier of the plugin.
server_url str: The plugin server URL used for configuration.
state PluginState: The current status of the plugin.
tags Sequence[root_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: _ . : / = + - @.
updated_at str: The timestamp for when the plugin was last updated.

authConfiguration Property Map | Property Map | Property Map: Authentication configuration information for an Amazon Q Business plugin.
buildStatus "READY" | "CREATE_IN_PROGRESS" | "CREATE_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_FAILED" | "DELETE_IN_PROGRESS" | "DELETE_FAILED": The current status of a plugin. A plugin is modified asynchronously.
createdAt String: The timestamp for when the plugin was created.
customPluginConfiguration Property Map: Configuration information required to create a custom plugin.
displayName String: The name of the plugin.
pluginArn String: The Amazon Resource Name (ARN) of a plugin.
pluginId String: The identifier of the plugin.
serverUrl String: The plugin server URL used for configuration.
state "ENABLED" | "DISABLED": The current status of the plugin.
tags List<Property Map>: 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: _ . : / = + - @.
updatedAt String: The timestamp for when the plugin was last updated.

Supporting Types

PluginApiSchema0Properties

Payload string

Payload string

payload String

payload string

payload str

payload String

PluginApiSchema1Properties

S3 Pulumi.AwsNative.QBusiness.Inputs.PluginS3

S3 PluginS3

s3 PluginS3

s3 PluginS3

s3 PluginS3

s3 Property Map

PluginApiSchemaType

PluginBuildStatus

PluginCustomPluginConfiguration

ApiSchema Pulumi.AwsNative.QBusiness.Inputs.PluginApiSchema0Properties | Pulumi.AwsNative.QBusiness.Inputs.PluginApiSchema1Properties: 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.
ApiSchemaType Pulumi.AwsNative.QBusiness.PluginApiSchemaType: The type of OpenAPI schema to use.
Description string: A description for your custom plugin configuration.

ApiSchema PluginApiSchema0Properties | PluginApiSchema1Properties: 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.
ApiSchemaType PluginApiSchemaType: The type of OpenAPI schema to use.
Description string: A description for your custom plugin configuration.

apiSchema PluginApiSchema0Properties | PluginApiSchema1Properties: 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.
apiSchemaType PluginApiSchemaType: The type of OpenAPI schema to use.
description String: A description for your custom plugin configuration.

apiSchema PluginApiSchema0Properties | PluginApiSchema1Properties: 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.
apiSchemaType PluginApiSchemaType: The type of OpenAPI schema to use.
description string: A description for your custom plugin configuration.

api_schema PluginApiSchema0Properties | PluginApiSchema1Properties: 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.
api_schema_type PluginApiSchemaType: The type of OpenAPI schema to use.
description str: A description for your custom plugin configuration.

apiSchema Property Map | Property Map: 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.
apiSchemaType "OPEN_API_V3": The type of OpenAPI schema to use.
description String: A description for your custom plugin configuration.