CfnAgentProfileProps
- class aws_cdk.aws_wellarchitected.CfnAgentProfileProps(*, aggregation_configuration, execution_role_arn, name, pillars, business_overview=None, deletion_protection=None, description=None, display_name=None, tags=None)
Bases:
objectProperties for defining a
CfnAgentProfile.- Parameters:
aggregation_configuration (
Union[IResolvable,Sequence[Union[IResolvable,AggregationConfigurationProperty,Dict[str,Any]]]]) – The aggregation configuration entries (account, regions, access role) associated with this profile.execution_role_arn (
str) – The ARN of the IAM role assumed to execute recommendation actions.name (
str) – The name of the profile. Unique within the account and used as the last component of the ARN.pillars (
Sequence[str]) – The list of Well-Architected pillars to focus on.business_overview (
Optional[str]) – A business overview for the profile used to improve recommendation quality.deletion_protection (
Union[bool,IResolvable,None]) – Whether deletion protection is enabled for the profile. When enabled, the profile cannot be deleted until deletion protection is disabled.description (
Optional[str]) – A description of the profile.display_name (
Optional[str]) – The human-readable display name of the profile.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – Key-value pairs to associate with the Agent Profile.
- See:
- ExampleMetadata:
fixture=_generated
Example:
from aws_cdk import CfnTag # 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_profile_props = wellarchitected.CfnAgentProfileProps( aggregation_configuration=[wellarchitected.CfnAgentProfile.AggregationConfigurationProperty( access_role_arn="accessRoleArn", account_id="accountId", regions=["regions"] )], execution_role_arn="executionRoleArn", name="name", pillars=["pillars"], # the properties below are optional business_overview="businessOverview", deletion_protection=False, description="description", display_name="displayName", tags=[CfnTag( key="key", value="value" )] )
Attributes
- aggregation_configuration
The aggregation configuration entries (account, regions, access role) associated with this profile.
- business_overview
A business overview for the profile used to improve recommendation quality.
- deletion_protection
Whether deletion protection is enabled for the profile.
When enabled, the profile cannot be deleted until deletion protection is disabled.
- description
A description of the profile.
- display_name
The human-readable display name of the profile.
- execution_role_arn
The ARN of the IAM role assumed to execute recommendation actions.
- name
The name of the profile.
Unique within the account and used as the last component of the ARN.
- pillars
The list of Well-Architected pillars to focus on.
- tags
Key-value pairs to associate with the Agent Profile.