Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. wisdom
  5. Assistant

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.wisdom.Assistant

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Wisdom::Assistant Resource Type

    Create Assistant Resource

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

    Constructor syntax

    new Assistant(name: string, args: AssistantArgs, opts?: CustomResourceOptions);
    @overload
def Assistant(resource_name: str,
              args: AssistantArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Assistant(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              type: Optional[AssistantType] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              server_side_encryption_configuration: Optional[AssistantServerSideEncryptionConfigurationArgs] = None,
              tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None)
    func NewAssistant(ctx *Context, name string, args AssistantArgs, opts ...ResourceOption) (*Assistant, error)
    public Assistant(string name, AssistantArgs args, CustomResourceOptions? opts = null)
    public Assistant(String name, AssistantArgs args)
public Assistant(String name, AssistantArgs args, CustomResourceOptions options)

    type: aws-native:wisdom:Assistant
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 AssistantArgs
    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 AssistantArgs
    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 AssistantArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AssistantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AssistantArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Assistant 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 Assistant resource accepts the following input properties:

    Type Pulumi.AwsNative.Wisdom.AssistantType
    The type of assistant.
    Description string
    The description.
    Name string
    The name.
    ServerSideEncryptionConfiguration Pulumi.AwsNative.Wisdom.Inputs.AssistantServerSideEncryptionConfiguration

    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 .

    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
    The tags used to organize, track, or control access for this resource.
    Type AssistantType
    The type of assistant.
    Description string
    The description.
    Name string
    The name.
    ServerSideEncryptionConfiguration AssistantServerSideEncryptionConfigurationArgs

    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 .

    Tags CreateOnlyTagArgs
    The tags used to organize, track, or control access for this resource.
    type AssistantType
    The type of assistant.
    description String
    The description.
    name String
    The name.
    serverSideEncryptionConfiguration AssistantServerSideEncryptionConfiguration

    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 .

    tags List<CreateOnlyTag>
    The tags used to organize, track, or control access for this resource.
    type AssistantType
    The type of assistant.
    description string
    The description.
    name string
    The name.
    serverSideEncryptionConfiguration AssistantServerSideEncryptionConfiguration

    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 .

    tags CreateOnlyTag[]
    The tags used to organize, track, or control access for this resource.
    type AssistantType
    The type of assistant.
    description str
    The description.
    name str
    The name.
    server_side_encryption_configuration AssistantServerSideEncryptionConfigurationArgs

    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 .

    tags Sequence[CreateOnlyTagArgs]
    The tags used to organize, track, or control access for this resource.
    type "AGENT"
    The type of assistant.
    description String
    The description.
    name String
    The name.
    serverSideEncryptionConfiguration Property Map

    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 .

    tags List<Property Map>
    The tags used to organize, track, or control access for this resource.

    Outputs

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

    AssistantArn string
    The Amazon Resource Name (ARN) of the assistant.
    AssistantId string
    The identifier of the Amazon Q in Connect assistant.
    Id string
    The provider-assigned unique ID for this managed resource.
    AssistantArn string
    The Amazon Resource Name (ARN) of the assistant.
    AssistantId string
    The identifier of the Amazon Q in Connect assistant.
    Id string
    The provider-assigned unique ID for this managed resource.
    assistantArn String
    The Amazon Resource Name (ARN) of the assistant.
    assistantId String
    The identifier of the Amazon Q in Connect assistant.
    id String
    The provider-assigned unique ID for this managed resource.
    assistantArn string
    The Amazon Resource Name (ARN) of the assistant.
    assistantId string
    The identifier of the Amazon Q in Connect assistant.
    id string
    The provider-assigned unique ID for this managed resource.
    assistant_arn str
    The Amazon Resource Name (ARN) of the assistant.
    assistant_id str
    The identifier of the Amazon Q in Connect assistant.
    id str
    The provider-assigned unique ID for this managed resource.
    assistantArn String
    The Amazon Resource Name (ARN) of the assistant.
    assistantId String
    The identifier of the Amazon Q in Connect assistant.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    AssistantServerSideEncryptionConfiguration, AssistantServerSideEncryptionConfigurationArgs

    KmsKeyId string
    The customer managed key used for encryption. The customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
    KmsKeyId string
    The customer managed key used for encryption. The customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
    kmsKeyId String
    The customer managed key used for encryption. The customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
    kmsKeyId string
    The customer managed key used for encryption. The customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
    kms_key_id str
    The customer managed key used for encryption. The customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
    kmsKeyId String
    The customer managed key used for encryption. The customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

    AssistantType, AssistantTypeArgs

    Agent
    AGENT
    AssistantTypeAgent
    AGENT
    Agent
    AGENT
    Agent
    AGENT
    AGENT
    AGENT
    "AGENT"
    AGENT

    CreateOnlyTag, CreateOnlyTagArgs

    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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native