aws-cdk-lib.aws_connect.CfnPromptProps

CfnPromptProps Struct

Properties for defining a CfnPrompt.

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_connect as connect } from 'aws-cdk-lib';
const cfnPromptProps: connect.CfnPromptProps = {
  instanceArn: 'instanceArn',
  name: 'name',

  // the properties below are optional
  description: 'description',
  s3Uri: 's3Uri',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

The description of the prompt.

instanceArnstring | IInstanceRefinstance_arntyping.Union[str, IInstanceRef]instanceArnStringInstanceArnstringInstanceArninterface{}required#

The identifier of the Connect Customer instance.

namestringnamestrnameStringNamestringName*stringrequired#

The name of the prompt.

s3Uristrings3_uristrs3UriStringS3UristringS3Uri*string#

The URI for the S3 bucket where the prompt is stored.

This property is required when you create a prompt.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

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

For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Used as props by

• CfnPrompt