Package software.amazon.awscdk.services.wellarchitected

Interface CfnAgentGoalProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgentGoalProps.Jsii$Proxy

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

Properties for defining a CfnAgentGoal.

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.*;
 CfnAgentGoalProps cfnAgentGoalProps = CfnAgentGoalProps.builder()
         .pillars(List.of("pillars"))
         .profileArn("profileArn")
         .title("title")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAgentGoalProps.Builder	builder()
default String	getDescription()	A description of the Agent Goal.
List<String>	getPillars()	The list of Well-Architected pillars this goal targets.
String	getProfileArn()	The Amazon Resource Name (ARN) of the parent Agent Profile that owns this goal.
String	getTitle()	The title of the Agent Goal.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPillars

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

The list of Well-Architected pillars this goal targets.

See Also:

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

getProfileArn

@Stability(Stable)
@NotNull
String getProfileArn()

The Amazon Resource Name (ARN) of the parent Agent Profile that owns this goal.

Pass !Ref of the parent AWS::WellArchitected::AgentProfile to flow its ARN here.

See Also:

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

getTitle

@Stability(Stable)
@NotNull
String getTitle()

The title of the Agent Goal.

See Also:

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

getDescription

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

A description of the Agent Goal.

See Also:

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

builder

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

Returns:

a CfnAgentGoalProps.Builder of CfnAgentGoalProps