View a markdown version of this page

AWS::Bedrock::RetrievalInstruction - 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).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Bedrock::RetrievalInstruction

Creates a new retrieval instruction. The retrieval instruction is usable once its status becomes ACTIVE. Use GetRetrievalInstruction to check whether it is ready.

Syntax

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

JSON

{
  "Type" : "AWS::Bedrock::RetrievalInstruction",
  "Properties" : {
      "CustomerEncryptionKeyArn" : String,
      "Description" : String,
      "Instruction" : Instruction,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Bedrock::RetrievalInstruction
Properties:
  CustomerEncryptionKeyArn: String
  Description: String
  Instruction: 
    Instruction
  Name: String
  Tags: 
    - Tag

Properties

CustomerEncryptionKeyArn

Property description not available.

Required: No

Type: String

Pattern: ^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$

Minimum: 1

Maximum: 2048

Update requires: Replacement

Description

A description of the retrieval instruction.

Required: No

Type: String

Minimum: 1

Maximum: 200

Update requires: No interruption

Instruction

Property description not available.

Required: Yes

Type: Instruction

Update requires: No interruption

Name

The name of the retrieval instruction.

Required: Yes

Type: String

Pattern: ^([0-9a-zA-Z][_-]?){1,100}$

Minimum: 1

Maximum: 100

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

CreatedAt

When you created the retrieval instruction.

LastTransitionStatus

The outcome or in-progress state of the most recent create or update of the retrieval instruction.

RetrievalInstructionId

The identifier of the retrieval instruction.

Status

Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time.

UpdatedAt

When the retrieval instruction was last updated.