Package software.amazon.awscdk.services.wellarchitected

Interface CfnAgentProfileProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgentProfileProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:05:03.316Z")
@Stability(Stable)
public interface CfnAgentProfileProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAgentProfile.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wellarchitected.*;
 CfnAgentProfileProps cfnAgentProfileProps = CfnAgentProfileProps.builder()
         .aggregationConfiguration(List.of(AggregationConfigurationProperty.builder()
                 .accessRoleArn("accessRoleArn")
                 .accountId("accountId")
                 .regions(List.of("regions"))
                 .build()))
         .executionRoleArn("executionRoleArn")
         .name("name")
         .pillars(List.of("pillars"))
         // the properties below are optional
         .businessOverview("businessOverview")
         .deletionProtection(false)
         .description("description")
         .displayName("displayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAgentProfileProps.Builder	A builder for CfnAgentProfileProps
static final class	CfnAgentProfileProps.Jsii$Proxy	An implementation for CfnAgentProfileProps

Method Summary

Modifier and Type	Method	Description
static CfnAgentProfileProps.Builder	builder()
Object	getAggregationConfiguration()	The aggregation configuration entries (account, regions, access role) associated with this profile.
default String	getBusinessOverview()	A business overview for the profile used to improve recommendation quality.
default Object	getDeletionProtection()	Whether deletion protection is enabled for the profile.
default String	getDescription()	A description of the profile.
default String	getDisplayName()	The human-readable display name of the profile.
String	getExecutionRoleArn()	The ARN of the IAM role assumed to execute recommendation actions.
String	getName()	The name of the profile.
List<String>	getPillars()	The list of Well-Architected pillars to focus on.
default List<CfnTag>	getTags()	Key-value pairs to associate with the Agent Profile.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAggregationConfiguration

@Stability(Stable)
@NotNull
Object getAggregationConfiguration()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAgentProfile.AggregationConfigurationProperty>

See Also:

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

getExecutionRoleArn

@Stability(Stable)
@NotNull
String getExecutionRoleArn()

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

getName

@Stability(Stable)
@NotNull
String getName()

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

getPillars

@Stability(Stable)
@NotNull
List<String> getPillars()

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

getBusinessOverview

@Stability(Stable)
@Nullable
default String getBusinessOverview()

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

getDeletionProtection

@Stability(Stable)
@Nullable
default Object getDeletionProtection()

Whether deletion protection is enabled for the profile.

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

Returns union: either Boolean or IResolvable

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the profile.

See Also:

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

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnAgentProfileProps.Builder builder()

Returns:

a CfnAgentProfileProps.Builder of CfnAgentProfileProps