View a markdown version of this page

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

Note

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

Creates an optimization profile that defines the scope and configuration for generating recommendations. A profile specifies the execution role, target pillars, and aggregation settings for analyzing your Amazon resources.

Syntax

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

JSON

{
  "Type" : "AWS::WellArchitected::AgentProfile",
  "Properties" : {
      "AggregationConfiguration" : [ AggregationConfiguration, ... ],
      "BusinessOverview" : String,
      "DeletionProtection" : Boolean,
      "Description" : String,
      "DisplayName" : String,
      "ExecutionRoleArn" : String,
      "Name" : String,
      "Pillars" : [ String, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::WellArchitected::AgentProfile
Properties:
  AggregationConfiguration: 
    - AggregationConfiguration
  BusinessOverview: String
  DeletionProtection: Boolean
  Description: String
  DisplayName: String
  ExecutionRoleArn: String
  Name: String
  Pillars: 
    - String
  Tags: 
    - Tag

Properties

AggregationConfiguration

The aggregation configuration that defines which Amazon accounts and Regions to analyze. Not present for basic profiles.

Required: Yes

Type: Array of AggregationConfiguration

Minimum: 0

Maximum: 100

Update requires: No interruption

BusinessOverview

The business overview for this profile.

Required: No

Type: String

Maximum: 512

Update requires: No interruption

DeletionProtection

Indicates whether deletion protection is enabled for the profile.

Note

If you don't specify this property, deletion protection is enabled (true) by default. When deletion protection is enabled, you can't delete the profile until you disable deletion protection.

Required: No

Type: Boolean

Update requires: No interruption

Description

A description of the profile.

Required: No

Type: String

Maximum: 512

Update requires: No interruption

DisplayName

The display name of the profile shown to users.

Required: No

Type: String

Minimum: 3

Maximum: 128

Update requires: No interruption

ExecutionRoleArn

The ARN of the IAM execution role used for recommendation actions. Not present for basic profiles.

Required: Yes

Type: String

Pattern: ^arn:([a-z\-]+):iam::[0-9]{12}:role/(service-role/)?[a-zA-Z0-9+=,.@\-_]+$

Minimum: 1

Maximum: 2048

Update requires: No interruption

Name

The system name of the profile.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 3

Maximum: 128

Update requires: Replacement

Pillars

The Amazon Well-Architected Framework pillars associated with this profile. Not present for basic profiles.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 4

Update requires: No interruption

Tags

The tags associated with the profile.

Required: No

Type: Array of Tag

Maximum: 50

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 profile ARN.

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the optimization profile.

CreatedAt

The timestamp when the profile was created.

CreatedBy

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

LastModifiedAt

The timestamp when the profile was last modified.

LastModifiedBy

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