Package software.amazon.awscdk.services.wellarchitected

Class CfnAgentGoal

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.CfnAgentGoal
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAgentGoalRef, 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.313Z") @Stability(Stable) public class CfnAgentGoal extends CfnResource implements IInspectable, IAgentGoalRef
Resource schema for AWS::WellArchitected::AgentGoal.

An Agent Goal expresses a Well-Architected objective (a title, optional description, and the pillars it targets) within an Agent Profile, used to focus 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.*;
 CfnAgentGoal cfnAgentGoal = CfnAgentGoal.Builder.create(this, "MyCfnAgentGoal")
         .pillars(List.of("pillars"))
         .profileArn("profileArn")
         .title("title")
         // the properties below are optional
         .description("description")
         .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

    • CfnAgentGoal

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

    • CfnAgentGoal

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

    • CfnAgentGoal

      @Stability(Stable) public CfnAgentGoal(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAgentGoalProps props)
      Create a new AWS::WellArchitected::AgentGoal.

      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

    • arnForAgentGoal

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

    • isCfnAgentGoal

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

      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.

    • getAgentGoalRef

      @Stability(Stable) @NotNull public AgentGoalReference getAgentGoalRef()
      A reference to a AgentGoal resource.
      Specified by:
      getAgentGoalRef in interface IAgentGoalRef

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The synthetic Amazon Resource Name (ARN) of the Agent Goal, composed of the parent profile ARN and the goal id.

    • getAttrCreatedAt

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

    • getAttrCreatedBy

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

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The service-generated unique identifier of the Agent Goal.

    • getAttrLastModifiedAt

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

    • getAttrLastModifiedBy

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

    • 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

    • getPillars

      @Stability(Stable) @NotNull public List<String> getPillars()
      The list of Well-Architected pillars this goal targets.

    • setPillars

      @Stability(Stable) public void setPillars(@NotNull List<String> value)
      The list of Well-Architected pillars this goal targets.

    • getProfileArn

      @Stability(Stable) @NotNull public String getProfileArn()
      The Amazon Resource Name (ARN) of the parent Agent Profile that owns this goal.

    • setProfileArn

      @Stability(Stable) public void setProfileArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the parent Agent Profile that owns this goal.

    • getTitle

      @Stability(Stable) @NotNull public String getTitle()
      The title of the Agent Goal.

    • setTitle

      @Stability(Stable) public void setTitle(@NotNull String value)
      The title of the Agent Goal.

    • getDescription

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

    • setDescription

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