CfnAgentProfilePropsMixin

class aws_cdk.cfn_property_mixins.aws_wellarchitected.CfnAgentProfilePropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::WellArchitected::AgentProfile.

An Agent Profile defines the execution role, account/region scope (via aggregation configuration access roles), and Well-Architected pillar focus used to generate Well-Architected Agent recommendations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wellarchitected-agentprofile.html
CloudformationResource:: AWS::WellArchitected::AgentProfile
Mixin:: true
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.cfn_property_mixins import aws_wellarchitected as wellarchitected
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_agent_profile_props_mixin = wellarchitected.CfnAgentProfilePropsMixin(wellarchitected.CfnAgentProfileMixinProps(
    aggregation_configuration=[wellarchitected.CfnAgentProfilePropsMixin.AggregationConfigurationProperty(
        access_role_arn="accessRoleArn",
        account_id="accountId",
        regions=["regions"]
    )],
    business_overview="businessOverview",
    deletion_protection=False,
    description="description",
    display_name="displayName",
    execution_role_arn="executionRoleArn",
    name="name",
    pillars=["pillars"],
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::WellArchitected::AgentProfile.

Parameters:

props (Union[CfnAgentProfileMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['aggregationConfiguration', 'businessOverview', 'deletionProtection', 'description', 'displayName', 'executionRoleArn', 'name', 'pillars', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

AggregationConfigurationProperty

class CfnAgentProfilePropsMixin.AggregationConfigurationProperty(*, access_role_arn=None, account_id=None, regions=None)

Bases: object

Defines an account, its in-scope regions, and the access role used to reach resources in that account.

Parameters:

access_role_arn (Optional[str]) – The ARN of the IAM role used to access resources in this account.
account_id (Optional[str]) – The target AWS account ID.
regions (Optional[Sequence[str]]) – The target regions in the account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wellarchitected-agentprofile-aggregationconfiguration.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.cfn_property_mixins import aws_wellarchitected as wellarchitected

aggregation_configuration_property = wellarchitected.CfnAgentProfilePropsMixin.AggregationConfigurationProperty(
    access_role_arn="accessRoleArn",
    account_id="accountId",
    regions=["regions"]
)

Attributes

access_role_arn

The ARN of the IAM role used to access resources in this account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wellarchitected-agentprofile-aggregationconfiguration.html#cfn-wellarchitected-agentprofile-aggregationconfiguration-accessrolearn

account_id

The target AWS account ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wellarchitected-agentprofile-aggregationconfiguration.html#cfn-wellarchitected-agentprofile-aggregationconfiguration-accountid

regions

The target regions in the account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wellarchitected-agentprofile-aggregationconfiguration.html#cfn-wellarchitected-agentprofile-aggregationconfiguration-regions