We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Definition of AWS::QuickSight::KnowledgeBase Resource Type
Create KnowledgeBase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KnowledgeBase(name: string, args: KnowledgeBaseArgs, opts?: CustomResourceOptions);@overload
def KnowledgeBase(resource_name: str,
args: KnowledgeBaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KnowledgeBase(resource_name: str,
opts: Optional[ResourceOptions] = None,
aws_account_id: Optional[str] = None,
data_source_arn: Optional[str] = None,
knowledge_base_configuration: Optional[KnowledgeBaseConfigurationArgs] = None,
knowledge_base_id: Optional[str] = None,
access_control_configuration: Optional[KnowledgeBaseAccessControlConfigurationArgs] = None,
description: Optional[str] = None,
is_email_notification_opted_for_ingestion_failures: Optional[bool] = None,
media_extraction_configuration: Optional[KnowledgeBaseMediaExtractionConfigurationArgs] = None,
name: Optional[str] = None,
permissions: Optional[Sequence[KnowledgeBaseResourcePermissionArgs]] = None,
primary_owner_arn: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewKnowledgeBase(ctx *Context, name string, args KnowledgeBaseArgs, opts ...ResourceOption) (*KnowledgeBase, error)public KnowledgeBase(string name, KnowledgeBaseArgs args, CustomResourceOptions? opts = null)
public KnowledgeBase(String name, KnowledgeBaseArgs args)
public KnowledgeBase(String name, KnowledgeBaseArgs args, CustomResourceOptions options)
type: aws-native:quicksight:KnowledgeBase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_quicksight_knowledge_base" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args KnowledgeBaseArgs
- 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 KnowledgeBaseArgs
- 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 KnowledgeBaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KnowledgeBaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KnowledgeBaseArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
KnowledgeBase 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 KnowledgeBase resource accepts the following input properties:
- Aws
Account stringId - Data
Source stringArn - Knowledge
Base Pulumi.Configuration Aws Native. Quick Sight. Inputs. Knowledge Base Configuration - Knowledge
Base stringId - Access
Control Pulumi.Configuration Aws Native. Quick Sight. Inputs. Knowledge Base Access Control Configuration - Description string
- Is
Email boolNotification Opted For Ingestion Failures - Media
Extraction Pulumi.Configuration Aws Native. Quick Sight. Inputs. Knowledge Base Media Extraction Configuration - Name string
- Permissions
List<Pulumi.
Aws Native. Quick Sight. Inputs. Knowledge Base Resource Permission> - Primary
Owner stringArn -
List<Pulumi.
Aws Native. Inputs. Tag>
- Aws
Account stringId - Data
Source stringArn - Knowledge
Base KnowledgeConfiguration Base Configuration Args - Knowledge
Base stringId - Access
Control KnowledgeConfiguration Base Access Control Configuration Args - Description string
- Is
Email boolNotification Opted For Ingestion Failures - Media
Extraction KnowledgeConfiguration Base Media Extraction Configuration Args - Name string
- Permissions
[]Knowledge
Base Resource Permission Args - Primary
Owner stringArn -
Tag
Args
- aws_
account_ stringid - data_
source_ stringarn - knowledge_
base_ objectconfiguration - knowledge_
base_ stringid - access_
control_ objectconfiguration - description string
- is_
email_ boolnotification_ opted_ for_ ingestion_ failures - media_
extraction_ objectconfiguration - name string
- permissions list(object)
- primary_
owner_ stringarn - list(object)
- aws
Account StringId - data
Source StringArn - knowledge
Base KnowledgeConfiguration Base Configuration - knowledge
Base StringId - access
Control KnowledgeConfiguration Base Access Control Configuration - description String
- is
Email BooleanNotification Opted For Ingestion Failures - media
Extraction KnowledgeConfiguration Base Media Extraction Configuration - name String
- permissions
List<Knowledge
Base Resource Permission> - primary
Owner StringArn - List<Tag>
- aws
Account stringId - data
Source stringArn - knowledge
Base KnowledgeConfiguration Base Configuration - knowledge
Base stringId - access
Control KnowledgeConfiguration Base Access Control Configuration - description string
- is
Email booleanNotification Opted For Ingestion Failures - media
Extraction KnowledgeConfiguration Base Media Extraction Configuration - name string
- permissions
Knowledge
Base Resource Permission[] - primary
Owner stringArn - Tag[]
- aws_
account_ strid - data_
source_ strarn - knowledge_
base_ Knowledgeconfiguration Base Configuration Args - knowledge_
base_ strid - access_
control_ Knowledgeconfiguration Base Access Control Configuration Args - description str
- is_
email_ boolnotification_ opted_ for_ ingestion_ failures - media_
extraction_ Knowledgeconfiguration Base Media Extraction Configuration Args - name str
- permissions
Sequence[Knowledge
Base Resource Permission Args] - primary_
owner_ strarn -
Sequence[Tag
Args]
- aws
Account StringId - data
Source StringArn - knowledge
Base Property MapConfiguration - knowledge
Base StringId - access
Control Property MapConfiguration - description String
- is
Email BooleanNotification Opted For Ingestion Failures - media
Extraction Property MapConfiguration - name String
- permissions List<Property Map>
- primary
Owner StringArn - List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the KnowledgeBase resource produces the following output properties:
- Created
At string - Document
Count double - Id string
- The provider-assigned unique ID for this managed resource.
- Knowledge
Base stringArn - Knowledge
Base doubleSize Bytes - Primary
Owner stringUsername - Status
Pulumi.
Aws Native. Quick Sight. Knowledge Base Data Set Status - Type string
- Updated
At string
- Created
At string - Document
Count float64 - Id string
- The provider-assigned unique ID for this managed resource.
- Knowledge
Base stringArn - Knowledge
Base float64Size Bytes - Primary
Owner stringUsername - Status
Knowledge
Base Data Set Status - Type string
- Updated
At string
- created_
at string - document_
count number - id string
- The provider-assigned unique ID for this managed resource.
- knowledge_
base_ stringarn - knowledge_
base_ numbersize_ bytes - primary_
owner_ stringusername - status "CREATING" | "UPDATING" | "ACTIVE" | "FAILED" | "DELETING"
- type string
- updated_
at string
- created
At String - document
Count Double - id String
- The provider-assigned unique ID for this managed resource.
- knowledge
Base StringArn - knowledge
Base DoubleSize Bytes - primary
Owner StringUsername - status
Knowledge
Base Data Set Status - type String
- updated
At String
- created
At string - document
Count number - id string
- The provider-assigned unique ID for this managed resource.
- knowledge
Base stringArn - knowledge
Base numberSize Bytes - primary
Owner stringUsername - status
Knowledge
Base Data Set Status - type string
- updated
At string
- created_
at str - document_
count float - id str
- The provider-assigned unique ID for this managed resource.
- knowledge_
base_ strarn - knowledge_
base_ floatsize_ bytes - primary_
owner_ strusername - status
Knowledge
Base Data Set Status - type str
- updated_
at str
- created
At String - document
Count Number - id String
- The provider-assigned unique ID for this managed resource.
- knowledge
Base StringArn - knowledge
Base NumberSize Bytes - primary
Owner StringUsername - status "CREATING" | "UPDATING" | "ACTIVE" | "FAILED" | "DELETING"
- type String
- updated
At String
Look up Existing KnowledgeBase Resource
Get an existing KnowledgeBase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): KnowledgeBase@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> KnowledgeBasefunc GetKnowledgeBase(ctx *Context, name string, id IDInput, state *KnowledgeBaseState, opts ...ResourceOption) (*KnowledgeBase, error)public static KnowledgeBase Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static KnowledgeBase get(String name, Output<String> id, CustomResourceOptions options)resources: existingKnowledgeBase: type: aws-native:quicksight:KnowledgeBase get: id: ${id}import {
to = aws-native_quicksight_knowledge_base.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state KnowledgeBaseState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
KnowledgeBaseAccessControlConfiguration, KnowledgeBaseAccessControlConfigurationArgs
- Is
Acl boolEnabled
- Is
Acl boolEnabled
- is_
acl_ boolenabled
- is
Acl BooleanEnabled
- is
Acl booleanEnabled
- is_
acl_ boolenabled
- is
Acl BooleanEnabled
KnowledgeBaseAudioExtractionConfiguration, KnowledgeBaseAudioExtractionConfigurationArgs
KnowledgeBaseAudioExtractionStatus
| Name | Value |
|---|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|---|
| Knowledge | ENABLED |
| Knowledge | DISABLED |
| Value |
|---|
ENABLED |
DISABLED |
| Name | Value |
|---|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|---|
| ENABLED | ENABLED |
| DISABLED | DISABLED |
| Value |
|---|
ENABLED |
DISABLED |
KnowledgeBaseConfiguration, KnowledgeBaseConfigurationArgs
KnowledgeBaseDataSetStatus
| Name | Value |
|---|---|
| Creating | CREATING |
| Updating | UPDATING |
| Active | ACTIVE |
| Failed | FAILED |
| Deleting | DELETING |
| Name | Value |
|---|---|
| Knowledge | CREATING |
| Knowledge | UPDATING |
| Knowledge | ACTIVE |
| Knowledge | FAILED |
| Knowledge | DELETING |
| Value |
|---|
CREATING |
UPDATING |
ACTIVE |
FAILED |
DELETING |
| Name | Value |
|---|---|
| Creating | CREATING |
| Updating | UPDATING |
| Active | ACTIVE |
| Failed | FAILED |
| Deleting | DELETING |
| Name | Value |
|---|---|
| Creating | CREATING |
| Updating | UPDATING |
| Active | ACTIVE |
| Failed | FAILED |
| Deleting | DELETING |
| Name | Value |
|---|---|
| CREATING | CREATING |
| UPDATING | UPDATING |
| ACTIVE | ACTIVE |
| FAILED | FAILED |
| DELETING | DELETING |
| Value |
|---|
CREATING |
UPDATING |
ACTIVE |
FAILED |
DELETING |
KnowledgeBaseImageExtractionConfiguration, KnowledgeBaseImageExtractionConfigurationArgs
KnowledgeBaseImageExtractionStatus
| Name | Value |
|---|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|---|
| Knowledge | ENABLED |
| Knowledge | DISABLED |
| Value |
|---|
ENABLED |
DISABLED |
| Name | Value |
|---|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|---|
| ENABLED | ENABLED |
| DISABLED | DISABLED |
| Value |
|---|
ENABLED |
DISABLED |
KnowledgeBaseKbTemplateConfiguration, KnowledgeBaseKbTemplateConfigurationArgs
- Template object
- Template interface{}
- template any
- template Object
- template any
- template Any
- template Any
KnowledgeBaseMediaExtractionConfiguration, KnowledgeBaseMediaExtractionConfigurationArgs
- Audio
Extraction Pulumi.Configuration Aws Native. Quick Sight. Inputs. Knowledge Base Audio Extraction Configuration - Image
Extraction Pulumi.Configuration Aws Native. Quick Sight. Inputs. Knowledge Base Image Extraction Configuration - Video
Extraction Pulumi.Configuration Aws Native. Quick Sight. Inputs. Knowledge Base Video Extraction Configuration
KnowledgeBaseResourcePermission, KnowledgeBaseResourcePermissionArgs
KnowledgeBaseVideoExtractionConfiguration, KnowledgeBaseVideoExtractionConfigurationArgs
KnowledgeBaseVideoExtractionStatus
| Name | Value |
|---|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|---|
| Knowledge | ENABLED |
| Knowledge | DISABLED |
| Value |
|---|
ENABLED |
DISABLED |
| Name | Value |
|---|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|---|
| Enabled | ENABLED |
| Disabled | DISABLED |
| Name | Value |
|---|---|
| ENABLED | ENABLED |
| DISABLED | DISABLED |
| Value |
|---|
ENABLED |
DISABLED |
KnowledgeBaseVideoExtractionType
| Name | Value |
|---|---|
| Audio | AUDIO_TRANSCRIPTION_ONLY |
| Visual | VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION |
| Name | Value |
|---|---|
| Knowledge | AUDIO_TRANSCRIPTION_ONLY |
| Knowledge | VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION |
| Value |
|---|
AUDIO_TRANSCRIPTION_ONLY |
VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION |
| Name | Value |
|---|---|
| Audio | AUDIO_TRANSCRIPTION_ONLY |
| Visual | VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION |
| Name | Value |
|---|---|
| Audio | AUDIO_TRANSCRIPTION_ONLY |
| Visual | VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION |
| Name | Value |
|---|---|
| AUDIO_TRANSCRIPTION_ONLY | AUDIO_TRANSCRIPTION_ONLY |
| VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION | VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION |
| Value |
|---|
AUDIO_TRANSCRIPTION_ONLY |
VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION |
Tag, TagArgs
A set of tags to apply to the resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi