Package software.amazon.awscdk.services.wellarchitected

Class CfnAgentContext

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

An Agent Context provides supplemental application context (free-form content) within an Agent Profile, used to improve the quality of 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.*;
 Object content;
 CfnAgentContext cfnAgentContext = CfnAgentContext.Builder.create(this, "MyCfnAgentContext")
         .content(content)
         .contextType("contextType")
         .profileArn("profileArn")
         .title("title")
         .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

    • CfnAgentContext

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

    • CfnAgentContext

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

    • CfnAgentContext

      @Stability(Stable) public CfnAgentContext(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAgentContextProps props)
      Create a new AWS::WellArchitected::AgentContext.

      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

    • arnForAgentContext

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

    • isCfnAgentContext

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

      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.

    • getAgentContextRef

      @Stability(Stable) @NotNull public AgentContextReference getAgentContextRef()
      A reference to a AgentContext resource.
      Specified by:
      getAgentContextRef in interface IAgentContextRef

    • getAttrApplicationType

      @Stability(Stable) @NotNull public String getAttrApplicationType()
      Type of the application described by this context.

      Mirrors the value stored in Content.applicationType and is surfaced as a typed read-only attribute by the service for discoverability.

    • getAttrArn

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

    • getAttrCreatedAt

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

    • getAttrCreatedBy

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

    • getAttrCriticality

      @Stability(Stable) @NotNull public String getAttrCriticality()
      Business criticality of the application described by this context.

      Mirrors the value stored in Content.criticality and is surfaced as a typed read-only attribute by the service for discoverability.

    • getAttrId

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

    • getAttrLastModifiedAt

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

    • getAttrLastModifiedBy

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

    • 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

    • getContent

      @Stability(Stable) @NotNull public Object getContent()
      The free-form content of the Agent Context, supplied as an arbitrary JSON object.

    • setContent

      @Stability(Stable) public void setContent(@NotNull Object value)
      The free-form content of the Agent Context, supplied as an arbitrary JSON object.

    • getContextType

      @Stability(Stable) @NotNull public String getContextType()
      The type of the Agent Context.

    • setContextType

      @Stability(Stable) public void setContextType(@NotNull String value)
      The type of the Agent Context.

    • getProfileArn

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

    • setProfileArn

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

    • getTitle

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

    • setTitle

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