AWS CDK

2.272.0

interface CfnAgentProfileProps

Language	Type name
.NET	`Amazon.CDK.AWS.WellArchitected.CfnAgentProfileProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awswellarchitected#CfnAgentProfileProps`
Java	`software.amazon.awscdk.services.wellarchitected.CfnAgentProfileProps`
Python	`aws_cdk.aws_wellarchitected.CfnAgentProfileProps`
TypeScript	`aws-cdk-lib` » `aws_wellarchitected` » `CfnAgentProfileProps`

Properties for defining a CfnAgentProfile.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-agentprofile.html

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

Name	Type	Description
aggregationConfiguration	`IResolvable` `\| (IResolvable` `\|` `AggregationConfigurationProperty)[]`	The aggregation configuration entries (account, regions, access role) associated with this profile.
executionRoleArn	`string`	The ARN of the IAM role assumed to execute recommendation actions.
name	`string`	The name of the profile.
pillars	`string[]`	The list of Well-Architected pillars to focus on.
businessOverview?	`string`	A business overview for the profile used to improve recommendation quality.
deletionProtection?	`boolean \|` `IResolvable`	Whether deletion protection is enabled for the profile.
description?	`string`	A description of the profile.
displayName?	`string`	The human-readable display name of the profile.
tags?	`CfnTag[]`	Key-value pairs to associate with the Agent Profile.

aggregationConfiguration

Type: IResolvable | (IResolvable | AggregationConfigurationProperty)[]

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-agentprofile.html#cfn-wellarchitected-agentprofile-aggregationconfiguration

executionRoleArn

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-agentprofile.html#cfn-wellarchitected-agentprofile-executionrolearn

name

Type: string

The name of the profile.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-agentprofile.html#cfn-wellarchitected-agentprofile-name

pillars

Type: string[]

The list of Well-Architected pillars to focus on.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-agentprofile.html#cfn-wellarchitected-agentprofile-pillars

businessOverview?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-agentprofile.html#cfn-wellarchitected-agentprofile-businessoverview

deletionProtection?

Type: boolean | IResolvable (optional)

Whether deletion protection is enabled for the profile.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-agentprofile.html#cfn-wellarchitected-agentprofile-deletionprotection

description?

Type: string (optional)

A description of the profile.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-agentprofile.html#cfn-wellarchitected-agentprofile-description

displayName?

Type: string (optional)

The human-readable display name of the profile.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-agentprofile.html#cfn-wellarchitected-agentprofile-displayname

tags?

Type: CfnTag[] (optional)

Key-value pairs to associate with the Agent Profile.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-agentprofile.html#cfn-wellarchitected-agentprofile-tags

← Previous Next →