aws-cdk-lib.aws_wellarchitected.CfnAgentProfileProps

CfnAgentProfileProps Struct

Properties for defining a CfnAgentProfile.

Source

Generated code

Type last changed

v2.272.0 · 30 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wellarchitected as wellarchitected } from 'aws-cdk-lib';
const cfnAgentProfileProps: wellarchitected.CfnAgentProfileProps = {
  aggregationConfiguration: [{
    accessRoleArn: 'accessRoleArn',
    accountId: 'accountId',
    regions: ['regions'],
  }],
  executionRoleArn: 'executionRoleArn',
  name: 'name',
  pillars: ['pillars'],

  // the properties below are optional
  businessOverview: 'businessOverview',
  deletionProtection: false,
  description: 'description',
  displayName: 'displayName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

aggregationConfigurationIResolvable | IResolvable | CfnAgentProfile.AggregationConfigurationProperty[]aggregation_configurationtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AggregationConfigurationProperty]]]aggregationConfigurationIResolvableAggregationConfigurationIResolvableAggregationConfigurationinterface{}required#

The aggregation configuration entries (account, regions, access role) associated with this profile.

businessOverviewstringbusiness_overviewstrbusinessOverviewStringBusinessOverviewstringBusinessOverview*string#

A business overview for the profile used to improve recommendation quality.

deletionProtectionboolean | IResolvabledeletion_protectiontyping.Union[bool, IResolvable]deletionProtectionBooleanDeletionProtectionboolDeletionProtectioninterface{}#

Whether deletion protection is enabled for the profile.

When enabled, the profile cannot be deleted until deletion protection is disabled.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

A description of the profile.

displayNamestringdisplay_namestrdisplayNameStringDisplayNamestringDisplayName*string#

The human-readable display name of the profile.

executionRoleArnstringexecution_role_arnstrexecutionRoleArnStringExecutionRoleArnstringExecutionRoleArn*stringrequired#

The ARN of the IAM role assumed to execute recommendation actions.

namestringnamestrnameStringNamestringName*stringrequired#

The name of the profile.

Unique within the account and used as the last component of the ARN.

pillarsstring[]pillarstyping.List[str]pillarsList<String>Pillarsstring[]Pillars*[]*stringrequired#

The list of Well-Architected pillars to focus on.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

Key-value pairs to associate with the Agent Profile.

Used as props by

• CfnAgentProfile