View a markdown version of this page

AWS::WellArchitected::AgentContext - 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::WellArchitected::AgentContext

Note

Amazon Well-Architected Agent is in preview release and is subject to change.

Creates a context associated with an optimization profile. Contexts provide application and environment information used during recommendation generation.

Syntax

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

JSON

{
  "Type" : "AWS::WellArchitected::AgentContext",
  "Properties" : {
      "Content" : Json,
      "ContextType" : String,
      "ProfileArn" : String,
      "Title" : String
    }
}

YAML

Type: AWS::WellArchitected::AgentContext
Properties:
  Content: Json
  ContextType: String
  ProfileArn: String
  Title: String

Properties

Content

The free-form content of the agent context, supplied as a JSON object. This content provides supplemental application information used to improve recommendation quality.

Required: Yes

Type: Json

Update requires: No interruption

ContextType

The type of the agent context. Valid value: APPLICATION.

Required: Yes

Type: String

Allowed values: APPLICATION

Update requires: Replacement

ProfileArn

The Amazon Resource Name (ARN) of the parent agent profile that owns this context.

Required: Yes

Type: String

Pattern: ^arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:[0-9]{12}:agent-profile/[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 2048

Update requires: Replacement

Title

The title of the agent context.

Required: Yes

Type: String

Pattern: ^[\P{C}]+$

Minimum: 1

Maximum: 1000

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the agent context ARN.

Fn::GetAtt

ApplicationType

The type of the application described by this context. Valid values: SAS | DESKTOP_APPLICATION | OTHER.

Arn

The Amazon Resource Name (ARN) of the agent context.

CreatedAt

The timestamp when the context was created.

CreatedBy

The identifier of the system or user that created this context.

Criticality

The business criticality of the application described by this context. Valid values: MISSION_CRITICAL | BUSINESS_CRITICAL | NON_CRITICAL | TEST_DEVELOPMENT.

Id

The service-generated unique identifier of the agent context.

LastModifiedAt

The timestamp when the context was last modified.

LastModifiedBy

The identifier of the system or user that last modified this context.