AWS::Connect::Prompt - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Connect::Prompt

Creates a prompt for the specified Amazon Connect instance.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Connect::Prompt",
  "Properties" : {
      "Description" : String,
      "InstanceArn" : String,
      "Name" : String,
      "S3Uri" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Connect::Prompt
Properties:
  Description: String
  InstanceArn: String
  Name: String
  S3Uri: String
  Tags: 
    - Tag

Properties

Description

The description of the prompt.

Required: No

Type: String

Minimum: 1

Maximum: 250

Update requires: No interruption

InstanceArn

The identifier of the Amazon Connect instance.

Required: Yes

Type: String

Pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$

Update requires: No interruption

Name

The name of the prompt.

Required: Yes

Type: String

Minimum: 1

Maximum: 127

Update requires: No interruption

S3Uri

The URI for the S3 bucket where the prompt is stored. This property is required when you create a prompt.

Required: Conditional

Type: String

Pattern: s3://\S+/.+|https://\S+\.s3(\.\S+)?\.amazonaws\.com/\S+

Minimum: 1

Maximum: 2000

Update requires: No interruption

Tags

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the quick rule name. For example:

{ "Ref": "myPromptName" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

PromptArn

The Amazon Resource Name (ARN) of the prompt.