View a markdown version of this page

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

Note

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

Creates an optimization goal associated with a profile. Goals define specific targets and objectives for the optimization process.

Syntax

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

JSON

{
  "Type" : "AWS::WellArchitected::AgentGoal",
  "Properties" : {
      "Description" : String,
      "Pillars" : [ String, ... ],
      "ProfileArn" : String,
      "Title" : String
    }
}

YAML

Type: AWS::WellArchitected::AgentGoal
Properties:
  Description: String
  Pillars: 
    - String
  ProfileArn: String
  Title: String

Properties

Description

A description of the agent goal.

Required: No

Type: String

Pattern: ^(?:(?!\$\{[a-zA-Z]+:)[\P{C}])+$

Minimum: 1

Maximum: 4000

Update requires: No interruption

Pillars

The list of Well-Architected pillars this goal targets. Valid values: COST_OPTIMIZATION | SECURITY | RESILIENCE | PERFORMANCE.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 5

Update requires: No interruption

ProfileArn

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

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 goal.

Required: Yes

Type: String

Pattern: ^(?:(?!\$\{[a-zA-Z]+:)[\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 goal ARN.

Fn::GetAtt

Arn

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

CreatedAt

The timestamp when the goal was created.

CreatedBy

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

Id

The service-generated unique identifier of the agent goal.

LastModifiedAt

The timestamp when the goal was last modified.

LastModifiedBy

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