We recommend new projects start with resources from the AWS provider.
aws-native.qbusiness.Plugin
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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,
           auth_configuration: Optional[Union[PluginAuthConfiguration0PropertiesArgs, PluginAuthConfiguration1PropertiesArgs, PluginAuthConfiguration2PropertiesArgs]] = None,
           display_name: Optional[str] = None,
           type: Optional[PluginType] = None,
           application_id: Optional[str] = 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Plugin resource accepts the following input properties:
- AuthConfiguration Pulumi.Aws | Pulumi.Native. QBusiness. Inputs. Plugin Auth Configuration0Properties Aws | Pulumi.Native. QBusiness. Inputs. Plugin Auth Configuration1Properties Aws Native. QBusiness. Inputs. Plugin Auth Configuration2Properties 
- Authentication configuration information for an Amazon Q Business plugin.
- DisplayName string
- The name of the plugin.
- Type
Pulumi.Aws Native. QBusiness. Plugin Type 
- The type of the plugin.
- ApplicationId string
- The identifier of the application that will contain the plugin.
- CustomPlugin Pulumi.Configuration Aws Native. QBusiness. Inputs. Plugin Custom Plugin Configuration 
- Configuration information required to create a custom plugin.
- ServerUrl string
- The plugin server URL used for configuration.
- State
Pulumi.Aws Native. QBusiness. Plugin State 
- The current status of the plugin.
- 
List<Pulumi.Aws Native. 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: _ . : / = + - @.
- AuthConfiguration PluginAuth | PluginConfiguration0Properties Args Auth | PluginConfiguration1Properties Args Auth Configuration2Properties Args 
- Authentication configuration information for an Amazon Q Business plugin.
- DisplayName string
- The name of the plugin.
- Type
PluginType 
- The type of the plugin.
- ApplicationId string
- The identifier of the application that will contain the plugin.
- CustomPlugin PluginConfiguration Custom Plugin Configuration Args 
- Configuration information required to create a custom plugin.
- ServerUrl string
- The plugin server URL used for configuration.
- State
PluginState Enum 
- The current status of the plugin.
- 
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: _ . : / = + - @.
- authConfiguration PluginAuth | PluginConfiguration0Properties Auth | PluginConfiguration1Properties Auth Configuration2Properties 
- Authentication configuration information for an Amazon Q Business plugin.
- displayName String
- The name of the plugin.
- type
PluginType 
- The type of the plugin.
- applicationId String
- The identifier of the application that will contain the plugin.
- customPlugin PluginConfiguration Custom Plugin Configuration 
- 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.
- 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: _ . : / = + - @.
- authConfiguration PluginAuth | PluginConfiguration0Properties Auth | PluginConfiguration1Properties Auth Configuration2Properties 
- Authentication configuration information for an Amazon Q Business plugin.
- displayName string
- The name of the plugin.
- type
PluginType 
- The type of the plugin.
- applicationId string
- The identifier of the application that will contain the plugin.
- customPlugin PluginConfiguration Custom Plugin Configuration 
- 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.
- 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: _ . : / = + - @.
- auth_configuration PluginAuth | PluginConfiguration0Properties Args Auth | PluginConfiguration1Properties Args Auth Configuration2Properties Args 
- Authentication configuration information for an Amazon Q Business plugin.
- display_name str
- The name of the plugin.
- type
PluginType 
- The type of the plugin.
- application_id str
- The identifier of the application that will contain the plugin.
- custom_plugin_ Pluginconfiguration Custom Plugin Configuration Args 
- 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.
- 
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: _ . : / = + - @.
- 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" | "QUICKSIGHT" | "SERVICENOW_NOW_PLATFORM" | "JIRA_CLOUD" | "SALESFORCE_CRM" | "ZENDESK_SUITE" | "ATLASSIAN_CONFLUENCE" | "GOOGLE_CALENDAR" | "MICROSOFT_TEAMS" | "MICROSOFT_EXCHANGE" | "PAGERDUTY_ADVANCE" | "SMARTSHEET" | "ASANA"
- The type of the plugin.
- applicationId String
- The identifier of the application that will contain the plugin.
- customPlugin Property MapConfiguration 
- 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.
- 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.Aws Native. QBusiness. Plugin Build Status 
- 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 PluginBuild Status 
- 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 PluginBuild Status 
- 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 PluginBuild Status 
- 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 PluginBuild Status 
- 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 str
- payload String
PluginApiSchema1Properties, PluginApiSchema1PropertiesArgs      
PluginApiSchemaType, PluginApiSchemaTypeArgs        
- OpenApi V3 
- OPEN_API_V3
- PluginApi Schema Type Open Api V3 
- OPEN_API_V3
- OpenApi V3 
- OPEN_API_V3
- OpenApi V3 
- OPEN_API_V3
- OPEN_API_V3
- OPEN_API_V3
- "OPEN_API_V3"
- OPEN_API_V3
PluginAuthConfiguration0Properties, PluginAuthConfiguration0PropertiesArgs      
PluginAuthConfiguration1Properties, PluginAuthConfiguration1PropertiesArgs      
PluginAuthConfiguration2Properties, PluginAuthConfiguration2PropertiesArgs      
PluginBasicAuthConfiguration, PluginBasicAuthConfigurationArgs        
- role_arn str
- secret_arn str
PluginBuildStatus, PluginBuildStatusArgs      
- Ready
- READY
- CreateIn Progress 
- CREATE_IN_PROGRESS
- CreateFailed 
- CREATE_FAILED
- UpdateIn Progress 
- UPDATE_IN_PROGRESS
- UpdateFailed 
- UPDATE_FAILED
- DeleteIn Progress 
- DELETE_IN_PROGRESS
- DeleteFailed 
- DELETE_FAILED
- PluginBuild Status Ready 
- READY
- PluginBuild Status Create In Progress 
- CREATE_IN_PROGRESS
- PluginBuild Status Create Failed 
- CREATE_FAILED
- PluginBuild Status Update In Progress 
- UPDATE_IN_PROGRESS
- PluginBuild Status Update Failed 
- UPDATE_FAILED
- PluginBuild Status Delete In Progress 
- DELETE_IN_PROGRESS
- PluginBuild Status Delete Failed 
- DELETE_FAILED
- Ready
- READY
- CreateIn Progress 
- CREATE_IN_PROGRESS
- CreateFailed 
- CREATE_FAILED
- UpdateIn Progress 
- UPDATE_IN_PROGRESS
- UpdateFailed 
- UPDATE_FAILED
- DeleteIn Progress 
- DELETE_IN_PROGRESS
- DeleteFailed 
- DELETE_FAILED
- Ready
- READY
- CreateIn Progress 
- CREATE_IN_PROGRESS
- CreateFailed 
- CREATE_FAILED
- UpdateIn Progress 
- UPDATE_IN_PROGRESS
- UpdateFailed 
- UPDATE_FAILED
- DeleteIn Progress 
- 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.Aws | Pulumi.Native. QBusiness. Inputs. Plugin Api Schema0Properties Aws Native. QBusiness. Inputs. Plugin Api Schema1Properties 
- 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.
- ApiSchema Pulumi.Type Aws Native. QBusiness. Plugin Api Schema Type 
- The type of OpenAPI schema to use.
- Description string
- A description for your custom plugin configuration.
- ApiSchema PluginApi | PluginSchema0Properties Api Schema1Properties 
- 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.
- ApiSchema PluginType Api Schema Type 
- The type of OpenAPI schema to use.
- Description string
- A description for your custom plugin configuration.
- apiSchema PluginApi | PluginSchema0Properties Api Schema1Properties 
- 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.
- apiSchema PluginType Api Schema Type 
- The type of OpenAPI schema to use.
- description String
- A description for your custom plugin configuration.
- apiSchema PluginApi | PluginSchema0Properties Api Schema1Properties 
- 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.
- apiSchema PluginType Api Schema Type 
- The type of OpenAPI schema to use.
- description string
- A description for your custom plugin configuration.
- api_schema PluginApi | PluginSchema0Properties Api Schema1Properties 
- 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_ Plugintype Api Schema Type 
- 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.
- apiSchema "OPEN_API_V3"Type 
- The type of OpenAPI schema to use.
- description String
- A description for your custom plugin configuration.
PluginOAuth2ClientCredentialConfiguration, PluginOAuth2ClientCredentialConfigurationArgs        
- role_arn str
- secret_arn str
- str
- token_url str
PluginS3, PluginS3Args    
PluginState, PluginStateArgs    
- Enabled
- ENABLED
- Disabled
- DISABLED
- PluginState Enabled 
- ENABLED
- PluginState Disabled 
- 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
- Quicksight
- QUICKSIGHT
- ServicenowNow Platform 
- SERVICENOW_NOW_PLATFORM
- JiraCloud 
- JIRA_CLOUD
- SalesforceCrm 
- SALESFORCE_CRM
- ZendeskSuite 
- ZENDESK_SUITE
- AtlassianConfluence 
- ATLASSIAN_CONFLUENCE
- GoogleCalendar 
- GOOGLE_CALENDAR
- MicrosoftTeams 
- MICROSOFT_TEAMS
- MicrosoftExchange 
- MICROSOFT_EXCHANGE
- PagerdutyAdvance 
- PAGERDUTY_ADVANCE
- Smartsheet
- SMARTSHEET
- Asana
- ASANA
- PluginType Service Now 
- SERVICE_NOW
- PluginType Salesforce 
- SALESFORCE
- PluginType Jira 
- JIRA
- PluginType Zendesk 
- ZENDESK
- PluginType Custom 
- CUSTOM
- PluginType Quicksight 
- QUICKSIGHT
- PluginType Servicenow Now Platform 
- SERVICENOW_NOW_PLATFORM
- PluginType Jira Cloud 
- JIRA_CLOUD
- PluginType Salesforce Crm 
- SALESFORCE_CRM
- PluginType Zendesk Suite 
- ZENDESK_SUITE
- PluginType Atlassian Confluence 
- ATLASSIAN_CONFLUENCE
- PluginType Google Calendar 
- GOOGLE_CALENDAR
- PluginType Microsoft Teams 
- MICROSOFT_TEAMS
- PluginType Microsoft Exchange 
- MICROSOFT_EXCHANGE
- PluginType Pagerduty Advance 
- PAGERDUTY_ADVANCE
- PluginType Smartsheet 
- SMARTSHEET
- PluginType Asana 
- ASANA
- ServiceNow 
- SERVICE_NOW
- Salesforce
- SALESFORCE
- Jira
- JIRA
- Zendesk
- ZENDESK
- Custom
- CUSTOM
- Quicksight
- QUICKSIGHT
- ServicenowNow Platform 
- SERVICENOW_NOW_PLATFORM
- JiraCloud 
- JIRA_CLOUD
- SalesforceCrm 
- SALESFORCE_CRM
- ZendeskSuite 
- ZENDESK_SUITE
- AtlassianConfluence 
- ATLASSIAN_CONFLUENCE
- GoogleCalendar 
- GOOGLE_CALENDAR
- MicrosoftTeams 
- MICROSOFT_TEAMS
- MicrosoftExchange 
- MICROSOFT_EXCHANGE
- PagerdutyAdvance 
- PAGERDUTY_ADVANCE
- Smartsheet
- SMARTSHEET
- Asana
- ASANA
- ServiceNow 
- SERVICE_NOW
- Salesforce
- SALESFORCE
- Jira
- JIRA
- Zendesk
- ZENDESK
- Custom
- CUSTOM
- Quicksight
- QUICKSIGHT
- ServicenowNow Platform 
- SERVICENOW_NOW_PLATFORM
- JiraCloud 
- JIRA_CLOUD
- SalesforceCrm 
- SALESFORCE_CRM
- ZendeskSuite 
- ZENDESK_SUITE
- AtlassianConfluence 
- ATLASSIAN_CONFLUENCE
- GoogleCalendar 
- GOOGLE_CALENDAR
- MicrosoftTeams 
- MICROSOFT_TEAMS
- MicrosoftExchange 
- MICROSOFT_EXCHANGE
- PagerdutyAdvance 
- PAGERDUTY_ADVANCE
- Smartsheet
- SMARTSHEET
- Asana
- ASANA
- SERVICE_NOW
- SERVICE_NOW
- SALESFORCE
- SALESFORCE
- JIRA
- JIRA
- ZENDESK
- ZENDESK
- CUSTOM
- CUSTOM
- QUICKSIGHT
- QUICKSIGHT
- SERVICENOW_NOW_PLATFORM
- SERVICENOW_NOW_PLATFORM
- JIRA_CLOUD
- JIRA_CLOUD
- SALESFORCE_CRM
- SALESFORCE_CRM
- ZENDESK_SUITE
- ZENDESK_SUITE
- ATLASSIAN_CONFLUENCE
- ATLASSIAN_CONFLUENCE
- GOOGLE_CALENDAR
- GOOGLE_CALENDAR
- MICROSOFT_TEAMS
- MICROSOFT_TEAMS
- MICROSOFT_EXCHANGE
- MICROSOFT_EXCHANGE
- PAGERDUTY_ADVANCE
- PAGERDUTY_ADVANCE
- SMARTSHEET
- SMARTSHEET
- ASANA
- ASANA
- "SERVICE_NOW"
- SERVICE_NOW
- "SALESFORCE"
- SALESFORCE
- "JIRA"
- JIRA
- "ZENDESK"
- ZENDESK
- "CUSTOM"
- CUSTOM
- "QUICKSIGHT"
- QUICKSIGHT
- "SERVICENOW_NOW_PLATFORM"
- SERVICENOW_NOW_PLATFORM
- "JIRA_CLOUD"
- JIRA_CLOUD
- "SALESFORCE_CRM"
- SALESFORCE_CRM
- "ZENDESK_SUITE"
- ZENDESK_SUITE
- "ATLASSIAN_CONFLUENCE"
- ATLASSIAN_CONFLUENCE
- "GOOGLE_CALENDAR"
- GOOGLE_CALENDAR
- "MICROSOFT_TEAMS"
- MICROSOFT_TEAMS
- "MICROSOFT_EXCHANGE"
- MICROSOFT_EXCHANGE
- "PAGERDUTY_ADVANCE"
- PAGERDUTY_ADVANCE
- "SMARTSHEET"
- SMARTSHEET
- "ASANA"
- ASANA
Tag, TagArgs  
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.