Struct aws_sdk_qconnect::types::builders::KnowledgeBaseSummaryBuilder

#[non_exhaustive]
pub struct KnowledgeBaseSummaryBuilder { /* private fields */ }

A builder for KnowledgeBaseSummary.

Implementations

impl KnowledgeBaseSummaryBuilder

pub fn knowledge_base_id(self, input: impl Into<String>) -> Self

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

This field is required.

pub fn set_knowledge_base_id(self, input: Option<String>) -> Self

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

pub fn get_knowledge_base_id(&self) -> &Option<String>

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

pub fn knowledge_base_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the knowledge base.

This field is required.

pub fn set_knowledge_base_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the knowledge base.

pub fn get_knowledge_base_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the knowledge base.

pub fn name(self, input: impl Into<String>) -> Self

The name of the knowledge base.

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

The name of the knowledge base.

pub fn get_name(&self) -> &Option<String>

The name of the knowledge base.

pub fn knowledge_base_type(self, input: KnowledgeBaseType) -> Self

The type of knowledge base.

This field is required.

pub fn set_knowledge_base_type(self, input: Option<KnowledgeBaseType>) -> Self

The type of knowledge base.

pub fn get_knowledge_base_type(&self) -> &Option<KnowledgeBaseType>

The type of knowledge base.

pub fn status(self, input: KnowledgeBaseStatus) -> Self

The status of the knowledge base summary.

This field is required.

pub fn set_status(self, input: Option<KnowledgeBaseStatus>) -> Self

The status of the knowledge base summary.

pub fn get_status(&self) -> &Option<KnowledgeBaseStatus>

The status of the knowledge base summary.

pub fn source_configuration(self, input: SourceConfiguration) -> Self

Configuration information about the external data source.

pub fn set_source_configuration( self, input: Option<SourceConfiguration> ) -> Self

Configuration information about the external data source.

pub fn get_source_configuration(&self) -> &Option<SourceConfiguration>

Configuration information about the external data source.

pub fn rendering_configuration(self, input: RenderingConfiguration) -> Self

Information about how to render the content.

pub fn set_rendering_configuration( self, input: Option<RenderingConfiguration> ) -> Self

Information about how to render the content.

pub fn get_rendering_configuration(&self) -> &Option<RenderingConfiguration>

Information about how to render the content.

pub fn server_side_encryption_configuration( self, input: ServerSideEncryptionConfiguration ) -> Self

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q.

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

pub fn set_server_side_encryption_configuration( self, input: Option<ServerSideEncryptionConfiguration> ) -> Self

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q.

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

pub fn get_server_side_encryption_configuration( &self ) -> &Option<ServerSideEncryptionConfiguration>

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q.

For more information about setting up a customer managed key for Amazon Q, see Enable Amazon Q in Connect for your instance.

pub fn description(self, input: impl Into<String>) -> Self

The description of the knowledge base.

pub fn set_description(self, input: Option<String>) -> Self

The description of the knowledge base.

pub fn get_description(&self) -> &Option<String>

The description of the knowledge base.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The tags used to organize, track, or control access for this resource.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

The tags used to organize, track, or control access for this resource.

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

The tags used to organize, track, or control access for this resource.

pub fn build(self) -> Result<KnowledgeBaseSummary, BuildError>

Consumes the builder and constructs a KnowledgeBaseSummary. This method will fail if any of the following fields are not set:

• knowledge_base_id
• knowledge_base_arn
• name
• knowledge_base_type
• status

Trait Implementations

impl Clone for KnowledgeBaseSummaryBuilder

fn clone(&self) -> KnowledgeBaseSummaryBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KnowledgeBaseSummaryBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for KnowledgeBaseSummaryBuilder

fn default() -> KnowledgeBaseSummaryBuilder

Returns the “default value” for a type.

impl PartialEq for KnowledgeBaseSummaryBuilder

fn eq(&self, other: &KnowledgeBaseSummaryBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for KnowledgeBaseSummaryBuilder