class CfnAgentProfile (construct)

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

Implements IConstruct, IDependable, IInspectable, IAgentProfileRef, IEnvironmentAware, ITaggableV2

Resource Type definition for AWS::WellArchitected::AgentProfile.

An Agent Profile defines the execution role, account/region scope (via aggregation configuration access roles), and Well-Architected pillar focus used to generate Well-Architected Agent recommendations.

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 cfnAgentProfile = new wellarchitected.CfnAgentProfile(this, 'MyCfnAgentProfile', {
  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',
  }],
});

Initializer

new CfnAgentProfile(scope: Construct, id: string, props: CfnAgentProfileProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnAgentProfileProps — Resource properties.

Create a new AWS::WellArchitected::AgentProfile.

Construct Props

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.

executionRoleArn

Type: string

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

name

Type: string

The name of the profile.

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

pillars

Type: string[]

The list of Well-Architected pillars to focus on.

businessOverview?

Type: string (optional)

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

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.

description?

Type: string (optional)

A description of the profile.

displayName?

Type: string (optional)

The human-readable display name of the profile.

tags?

Type: CfnTag[] (optional)

Key-value pairs to associate with the Agent Profile.

Properties

Name	Type	Description
agentProfileRef	`AgentProfileReference`	A reference to a AgentProfile resource.
aggregationConfiguration	`IResolvable` `\| (IResolvable` `\|` `AggregationConfigurationProperty)[]`	The aggregation configuration entries (account, regions, access role) associated with this profile.
attrArn	`string`	The Amazon Resource Name (ARN) of the Agent Profile.
attrCreatedAt	`string`	The timestamp when the profile was created.
attrCreatedBy	`string`	The identifier of the system or user that created this profile.
attrLastModifiedAt	`string`	The timestamp when the profile was last modified.
attrLastModifiedBy	`string`	The identifier of the system or user that last modified this profile.
cdkTagManager	`TagManager`	Tag Manager which manages the tags for this resource.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnPropertyNames	`{ [string]: string }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
env	`ResourceEnvironment`
executionRoleArn	`string`	The ARN of the IAM role assumed to execute recommendation actions.
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name of the profile.
node	`Node`	The tree node.
pillars	`string[]`	The list of Well-Architected pillars to focus on.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
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.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

agentProfileRef

Type: AgentProfileReference

A reference to a AgentProfile resource.

aggregationConfiguration

Type: IResolvable | (IResolvable | AggregationConfigurationProperty)[]

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

attrArn

Type: string

The Amazon Resource Name (ARN) of the Agent Profile.

attrCreatedAt

Type: string

The timestamp when the profile was created.

attrCreatedBy

Type: string

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

attrLastModifiedAt

Type: string

The timestamp when the profile was last modified.

attrLastModifiedBy

Type: string

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

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnPropertyNames

Type: { [string]: string }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

env

Type: ResourceEnvironment

executionRoleArn

Type: string

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

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

The name of the profile.

node

Type: Node

The tree node.

pillars

Type: string[]

The list of Well-Architected pillars to focus on.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

businessOverview?

Type: string (optional)

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

deletionProtection?

Type: boolean | IResolvable (optional)

Whether deletion protection is enabled for the profile.

description?

Type: string (optional)

A description of the profile.

displayName?

Type: string (optional)

The human-readable display name of the profile.

tags?

Type: CfnTag[] (optional)

Key-value pairs to associate with the Agent Profile.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
addResourceDependency(target, reason?)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
applyCrossStackReferenceStrength(strength)	Sets the cross-stack reference strength for this resource.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
cfnPropertyName(cdkPropertyName)
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources and stacks this resource depends on.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)⚠️	Indicates that this resource no longer depends on another resource.
removeResourceDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.
protected renderProperties(props)
static arnForAgentProfile(resource)
static isCfnAgentProfile(x)	Checks whether the given object is a CfnAgentProfile.

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)⚠️

public addDependency(target: CfnResource): void

⚠️ Deprecated: Use addResourceDependency instead.

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: Use addResourceDependency instead.

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

addResourceDependency(target, reason?)

public addResourceDependency(target: CfnResource, reason?: string): void

Parameters

target CfnResource
reason string

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength)

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

strength ReferenceStrength — - The reference strength to use for this resource.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

cfnPropertyName(cdkPropertyName)

public cfnPropertyName(cdkPropertyName: string): string

Parameters

cdkPropertyName string

Returns

string

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): (Stack &#124; CfnResource)[]

Returns

(Stack | CfnResource)[]

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)⚠️

public removeDependency(target: CfnResource): void

⚠️ Deprecated: Use removeResourceDependency instead

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target)

public removeResourceDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

mixins IMixin

Returns

IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }

static arnForAgentProfile(resource)

public static arnForAgentProfile(resource: IAgentProfileRef): string

Parameters

resource IAgentProfileRef

Returns

string

static isCfnAgentProfile(x)

public static isCfnAgentProfile(x: any): boolean

Parameters

x any

Returns

boolean

Checks whether the given object is a CfnAgentProfile.