CfnAgentGoalProps

class aws_cdk.aws_wellarchitected.CfnAgentGoalProps(*, pillars, profile_arn, title, description=None)

Bases: object

Properties for defining a CfnAgentGoal.

Parameters:
  • pillars (Sequence[str]) – The list of Well-Architected pillars this goal targets.

  • profile_arn (str) – 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.

  • title (str) – The title of the Agent Goal.

  • description (Optional[str]) – A description of the Agent Goal.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_wellarchitected as wellarchitected

cfn_agent_goal_props = wellarchitected.CfnAgentGoalProps(
    pillars=["pillars"],
    profile_arn="profileArn",
    title="title",

    # the properties below are optional
    description="description"
)

Attributes

description

A description of the Agent Goal.

See:

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

pillars

The list of Well-Architected pillars this goal targets.

See:

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

profile_arn

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:

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

title

The title of the Agent Goal.

See:

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