1. Packages
  2. AWS Native
  3. API Docs
  4. qbusiness
  5. Plugin

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.qbusiness.Plugin

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    Definition of AWS::QBusiness::Plugin Resource Type

    Create Plugin Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Plugin(name: string, args: PluginArgs, opts?: CustomResourceOptions);
    @overload
    def Plugin(resource_name: str,
               args: PluginArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Plugin(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               application_id: Optional[str] = None,
               auth_configuration: Optional[Union[PluginAuthConfiguration0PropertiesArgs, PluginAuthConfiguration1PropertiesArgs, PluginAuthConfiguration2PropertiesArgs]] = None,
               display_name: Optional[str] = None,
               type: Optional[PluginType] = None,
               custom_plugin_configuration: Optional[PluginCustomPluginConfigurationArgs] = None,
               server_url: Optional[str] = None,
               state: Optional[PluginState] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewPlugin(ctx *Context, name string, args PluginArgs, opts ...ResourceOption) (*Plugin, error)
    public Plugin(string name, PluginArgs args, CustomResourceOptions? opts = null)
    public Plugin(String name, PluginArgs args)
    public Plugin(String name, PluginArgs args, CustomResourceOptions options)
    
    type: aws-native:qbusiness:Plugin
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PluginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PluginArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PluginArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PluginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PluginArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Plugin Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Plugin resource accepts the following input properties:

    ApplicationId string
    The identifier of the application that will contain the plugin.
    AuthConfiguration Pulumi.AwsNative.QBusiness.Inputs.PluginAuthConfiguration0Properties | Pulumi.AwsNative.QBusiness.Inputs.PluginAuthConfiguration1Properties | Pulumi.AwsNative.QBusiness.Inputs.PluginAuthConfiguration2Properties
    Authentication configuration information for an Amazon Q Business plugin.
    DisplayName string
    The name of the plugin.
    Type Pulumi.AwsNative.QBusiness.PluginType
    The type of the plugin.
    CustomPluginConfiguration Pulumi.AwsNative.QBusiness.Inputs.PluginCustomPluginConfiguration
    Configuration information required to create a custom 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.Inputs.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: _ . : / = + - @.
    ApplicationId string
    The identifier of the application that will contain the plugin.
    AuthConfiguration PluginAuthConfiguration0PropertiesArgs | PluginAuthConfiguration1PropertiesArgs | PluginAuthConfiguration2PropertiesArgs
    Authentication configuration information for an Amazon Q Business plugin.
    DisplayName string
    The name of the plugin.
    Type PluginType
    The type of the plugin.
    CustomPluginConfiguration PluginCustomPluginConfigurationArgs
    Configuration information required to create a custom plugin.
    ServerUrl string
    The plugin server URL used for configuration.
    State PluginStateEnum
    The current status of the plugin.
    Tags TagArgs
    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: _ . : / = + - @.
    applicationId String
    The identifier of the application that will contain the plugin.
    authConfiguration PluginAuthConfiguration0Properties | PluginAuthConfiguration1Properties | PluginAuthConfiguration2Properties
    Authentication configuration information for an Amazon Q Business plugin.
    displayName String
    The name of the plugin.
    type PluginType
    The type of the plugin.
    customPluginConfiguration PluginCustomPluginConfiguration
    Configuration information required to create a custom 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: _ . : / = + - @.
    applicationId string
    The identifier of the application that will contain the plugin.
    authConfiguration PluginAuthConfiguration0Properties | PluginAuthConfiguration1Properties | PluginAuthConfiguration2Properties
    Authentication configuration information for an Amazon Q Business plugin.
    displayName string
    The name of the plugin.
    type PluginType
    The type of the plugin.
    customPluginConfiguration PluginCustomPluginConfiguration
    Configuration information required to create a custom 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: _ . : / = + - @.
    application_id str
    The identifier of the application that will contain the plugin.
    auth_configuration PluginAuthConfiguration0PropertiesArgs | PluginAuthConfiguration1PropertiesArgs | PluginAuthConfiguration2PropertiesArgs
    Authentication configuration information for an Amazon Q Business plugin.
    display_name str
    The name of the plugin.
    type PluginType
    The type of the plugin.
    custom_plugin_configuration PluginCustomPluginConfigurationArgs
    Configuration information required to create a custom plugin.
    server_url str
    The plugin server URL used for configuration.
    state PluginState
    The current status of the plugin.
    tags Sequence[TagArgs]
    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: _ . : / = + - @.
    applicationId String
    The identifier of the application that will contain the plugin.
    authConfiguration Property Map | Property Map | Property Map
    Authentication configuration information for an Amazon Q Business plugin.
    displayName String
    The name of the plugin.
    type "SERVICE_NOW" | "SALESFORCE" | "JIRA" | "ZENDESK" | "CUSTOM"
    The type of the plugin.
    customPluginConfiguration Property Map
    Configuration information required to create a custom 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: _ . : / = + - @.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Plugin resource produces the following output properties:

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    PluginArn string
    The Amazon Resource Name (ARN) of a plugin.
    PluginId string
    The identifier of the plugin.
    UpdatedAt string
    The timestamp for when the plugin was last updated.
    BuildStatus PluginBuildStatus
    The current status of a plugin. A plugin is modified asynchronously.
    CreatedAt string
    The timestamp for when the plugin was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    PluginArn string
    The Amazon Resource Name (ARN) of a plugin.
    PluginId string
    The identifier of the plugin.
    UpdatedAt string
    The timestamp for when the plugin was last updated.
    buildStatus PluginBuildStatus
    The current status of a plugin. A plugin is modified asynchronously.
    createdAt String
    The timestamp for when the plugin was created.
    id String
    The provider-assigned unique ID for this managed resource.
    pluginArn String
    The Amazon Resource Name (ARN) of a plugin.
    pluginId String
    The identifier of the plugin.
    updatedAt String
    The timestamp for when the plugin was last updated.
    buildStatus PluginBuildStatus
    The current status of a plugin. A plugin is modified asynchronously.
    createdAt string
    The timestamp for when the plugin was created.
    id string
    The provider-assigned unique ID for this managed resource.
    pluginArn string
    The Amazon Resource Name (ARN) of a plugin.
    pluginId string
    The identifier of the plugin.
    updatedAt string
    The timestamp for when the plugin was last updated.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    plugin_arn str
    The Amazon Resource Name (ARN) of a plugin.
    plugin_id str
    The identifier of the plugin.
    updated_at str
    The timestamp for when the plugin was last updated.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    pluginArn String
    The Amazon Resource Name (ARN) of a plugin.
    pluginId String
    The identifier of the plugin.
    updatedAt String
    The timestamp for when the plugin was last updated.

    Supporting Types

    PluginApiSchema0Properties, PluginApiSchema0PropertiesArgs

    Payload string
    Payload string
    payload String
    payload string
    payload String

    PluginApiSchema1Properties, PluginApiSchema1PropertiesArgs

    PluginApiSchemaType, PluginApiSchemaTypeArgs

    OpenApiV3
    OPEN_API_V3
    PluginApiSchemaTypeOpenApiV3
    OPEN_API_V3
    OpenApiV3
    OPEN_API_V3
    OpenApiV3
    OPEN_API_V3
    OPEN_API_V3
    OPEN_API_V3
    "OPEN_API_V3"
    OPEN_API_V3

    PluginAuthConfiguration0Properties, PluginAuthConfiguration0PropertiesArgs

    PluginAuthConfiguration1Properties, PluginAuthConfiguration1PropertiesArgs

    PluginAuthConfiguration2Properties, PluginAuthConfiguration2PropertiesArgs

    PluginBasicAuthConfiguration, PluginBasicAuthConfigurationArgs

    RoleArn string
    SecretArn string
    RoleArn string
    SecretArn string
    roleArn String
    secretArn String
    roleArn string
    secretArn string
    roleArn String
    secretArn String

    PluginBuildStatus, PluginBuildStatusArgs

    Ready
    READY
    CreateInProgress
    CREATE_IN_PROGRESS
    CreateFailed
    CREATE_FAILED
    UpdateInProgress
    UPDATE_IN_PROGRESS
    UpdateFailed
    UPDATE_FAILED
    DeleteInProgress
    DELETE_IN_PROGRESS
    DeleteFailed
    DELETE_FAILED
    PluginBuildStatusReady
    READY
    PluginBuildStatusCreateInProgress
    CREATE_IN_PROGRESS
    PluginBuildStatusCreateFailed
    CREATE_FAILED
    PluginBuildStatusUpdateInProgress
    UPDATE_IN_PROGRESS
    PluginBuildStatusUpdateFailed
    UPDATE_FAILED
    PluginBuildStatusDeleteInProgress
    DELETE_IN_PROGRESS
    PluginBuildStatusDeleteFailed
    DELETE_FAILED
    Ready
    READY
    CreateInProgress
    CREATE_IN_PROGRESS
    CreateFailed
    CREATE_FAILED
    UpdateInProgress
    UPDATE_IN_PROGRESS
    UpdateFailed
    UPDATE_FAILED
    DeleteInProgress
    DELETE_IN_PROGRESS
    DeleteFailed
    DELETE_FAILED
    Ready
    READY
    CreateInProgress
    CREATE_IN_PROGRESS
    CreateFailed
    CREATE_FAILED
    UpdateInProgress
    UPDATE_IN_PROGRESS
    UpdateFailed
    UPDATE_FAILED
    DeleteInProgress
    DELETE_IN_PROGRESS
    DeleteFailed
    DELETE_FAILED
    READY
    READY
    CREATE_IN_PROGRESS
    CREATE_IN_PROGRESS
    CREATE_FAILED
    CREATE_FAILED
    UPDATE_IN_PROGRESS
    UPDATE_IN_PROGRESS
    UPDATE_FAILED
    UPDATE_FAILED
    DELETE_IN_PROGRESS
    DELETE_IN_PROGRESS
    DELETE_FAILED
    DELETE_FAILED
    "READY"
    READY
    "CREATE_IN_PROGRESS"
    CREATE_IN_PROGRESS
    "CREATE_FAILED"
    CREATE_FAILED
    "UPDATE_IN_PROGRESS"
    UPDATE_IN_PROGRESS
    "UPDATE_FAILED"
    UPDATE_FAILED
    "DELETE_IN_PROGRESS"
    DELETE_IN_PROGRESS
    "DELETE_FAILED"
    DELETE_FAILED

    PluginCustomPluginConfiguration, PluginCustomPluginConfigurationArgs

    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.

    PluginOAuth2ClientCredentialConfiguration, PluginOAuth2ClientCredentialConfigurationArgs

    RoleArn string
    SecretArn string
    RoleArn string
    SecretArn string
    roleArn String
    secretArn String
    roleArn string
    secretArn string
    roleArn String
    secretArn String

    PluginS3, PluginS3Args

    Bucket string
    Key string
    Bucket string
    Key string
    bucket String
    key String
    bucket string
    key string
    bucket str
    key str
    bucket String
    key String

    PluginState, PluginStateArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    PluginStateEnabled
    ENABLED
    PluginStateDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    PluginType, PluginTypeArgs

    ServiceNow
    SERVICE_NOW
    Salesforce
    SALESFORCE
    Jira
    JIRA
    Zendesk
    ZENDESK
    Custom
    CUSTOM
    PluginTypeServiceNow
    SERVICE_NOW
    PluginTypeSalesforce
    SALESFORCE
    PluginTypeJira
    JIRA
    PluginTypeZendesk
    ZENDESK
    PluginTypeCustom
    CUSTOM
    ServiceNow
    SERVICE_NOW
    Salesforce
    SALESFORCE
    Jira
    JIRA
    Zendesk
    ZENDESK
    Custom
    CUSTOM
    ServiceNow
    SERVICE_NOW
    Salesforce
    SALESFORCE
    Jira
    JIRA
    Zendesk
    ZENDESK
    Custom
    CUSTOM
    SERVICE_NOW
    SERVICE_NOW
    SALESFORCE
    SALESFORCE
    JIRA
    JIRA
    ZENDESK
    ZENDESK
    CUSTOM
    CUSTOM
    "SERVICE_NOW"
    SERVICE_NOW
    "SALESFORCE"
    SALESFORCE
    "JIRA"
    JIRA
    "ZENDESK"
    ZENDESK
    "CUSTOM"
    CUSTOM

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi