Package software.amazon.awscdk.services.wellarchitected

Class CfnAgentProfile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.wellarchitected.CfnAgentProfile
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAgentProfileRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:05:03.314Z") @Stability(Stable) public class CfnAgentProfile extends CfnResource implements IInspectable, IAgentProfileRef, 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 software.amazon.awscdk.services.wellarchitected.*;
 CfnAgentProfile cfnAgentProfile = CfnAgentProfile.Builder.create(this, "MyCfnAgentProfile")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAgentProfile

      protected CfnAgentProfile(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAgentProfile

      protected CfnAgentProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAgentProfile

      @Stability(Stable) public CfnAgentProfile(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAgentProfileProps props)
      Create a new AWS::WellArchitected::AgentProfile.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForAgentProfile

      @Stability(Stable) @NotNull public static String arnForAgentProfile(@NotNull IAgentProfileRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnAgentProfile

      @Stability(Stable) @NotNull public static Boolean isCfnAgentProfile(@NotNull Object x)
      Checks whether the given object is a CfnAgentProfile.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAgentProfileRef

      @Stability(Stable) @NotNull public AgentProfileReference getAgentProfileRef()
      A reference to a AgentProfile resource.
      Specified by:
      getAgentProfileRef in interface IAgentProfileRef

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the Agent Profile.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the profile was created.

    • getAttrCreatedBy

      @Stability(Stable) @NotNull public String getAttrCreatedBy()
      The identifier of the system or user that created this profile.

    • getAttrLastModifiedAt

      @Stability(Stable) @NotNull public String getAttrLastModifiedAt()
      The timestamp when the profile was last modified.

    • getAttrLastModifiedBy

      @Stability(Stable) @NotNull public String getAttrLastModifiedBy()
      The identifier of the system or user that last modified this profile.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getAggregationConfiguration

      @Stability(Stable) @NotNull public 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>

    • setAggregationConfiguration

      @Stability(Stable) public void setAggregationConfiguration(@NotNull IResolvable value)
      The aggregation configuration entries (account, regions, access role) associated with this profile.

    • setAggregationConfiguration

      @Stability(Stable) public void setAggregationConfiguration(@NotNull List<Object> value)
      The aggregation configuration entries (account, regions, access role) associated with this profile.

    • getExecutionRoleArn

      @Stability(Stable) @NotNull public String getExecutionRoleArn()
      The ARN of the IAM role assumed to execute recommendation actions.

    • setExecutionRoleArn

      @Stability(Stable) public void setExecutionRoleArn(@NotNull String value)
      The ARN of the IAM role assumed to execute recommendation actions.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the profile.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the profile.

    • getPillars

      @Stability(Stable) @NotNull public List<String> getPillars()
      The list of Well-Architected pillars to focus on.

    • setPillars

      @Stability(Stable) public void setPillars(@NotNull List<String> value)
      The list of Well-Architected pillars to focus on.

    • getBusinessOverview

      @Stability(Stable) @Nullable public String getBusinessOverview()
      A business overview for the profile used to improve recommendation quality.

    • setBusinessOverview

      @Stability(Stable) public void setBusinessOverview(@Nullable String value)
      A business overview for the profile used to improve recommendation quality.

    • getDeletionProtection

      @Stability(Stable) @Nullable public Object getDeletionProtection()
      Whether deletion protection is enabled for the profile.

      Returns union: either Boolean or IResolvable

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable Boolean value)
      Whether deletion protection is enabled for the profile.

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      Whether deletion protection is enabled for the profile.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the profile.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the profile.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The human-readable display name of the profile.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The human-readable display name of the profile.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Key-value pairs to associate with the Agent Profile.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Key-value pairs to associate with the Agent Profile.