Package software.amazon.awscdk.services.wisdom

Interface CfnAssistantProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssistantProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-20T14:04:33.916Z")
@Stability(Stable)
public interface CfnAssistantProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAssistant.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wisdom.*;
 CfnAssistantProps cfnAssistantProps = CfnAssistantProps.builder()
         .name("name")
         .type("type")
         // the properties below are optional
         .description("description")
         .serverSideEncryptionConfiguration(ServerSideEncryptionConfigurationProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAssistantProps.Builder	A builder for CfnAssistantProps
static final class	CfnAssistantProps.Jsii$Proxy	An implementation for CfnAssistantProps

Method Summary

Modifier and Type	Method	Description
static CfnAssistantProps.Builder	builder()
default String	getDescription()	The description.
String	getName()	The name.
default Object	getServerSideEncryptionConfiguration()	The configuration information for the customer managed key used for encryption.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.
String	getType()	The type of assistant.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html#cfn-wisdom-assistant-name

getType

@Stability(Stable)
@NotNull
String getType()

The type of assistant.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html#cfn-wisdom-assistant-type

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html#cfn-wisdom-assistant-description

getServerSideEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getServerSideEncryptionConfiguration()

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 in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt , kms:GenerateDataKey* , and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html#cfn-wisdom-assistant-serversideencryptionconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistant.html#cfn-wisdom-assistant-tags

builder

@Stability(Stable)
static CfnAssistantProps.Builder builder()

Returns:

a CfnAssistantProps.Builder of CfnAssistantProps