CfnAnalyzerProps

class aws_cdk.aws_accessanalyzer.CfnAnalyzerProps(*, type, analyzer_configuration=None, analyzer_name=None, archive_rules=None, tags=None)

Bases: object

Properties for defining a CfnAnalyzer.

Parameters:

type (str) – The type represents the zone of trust for the analyzer. Allowed Values : ACCOUNT | ORGANIZATION | ACCOUNT_UNUSED_ACCESS | ORGANIZATION_UNUSED_ACCESS
analyzer_configuration (Union[IResolvable, AnalyzerConfigurationProperty, Dict[str, Any], None]) – Contains information about the configuration of an analyzer for an AWS organization or account.
analyzer_name (Optional[str]) – The name of the analyzer.
archive_rules (Union[IResolvable, Sequence[Union[IResolvable, ArchiveRuleProperty, Dict[str, Any]]], None]) – Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to the analyzer. You can use the set of Unicode letters, digits, whitespace, _ , . , / , = , + , and - . For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with aws: . For the tag value, you can specify a value that is 0 to 256 characters in length.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.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_accessanalyzer as accessanalyzer

cfn_analyzer_props = accessanalyzer.CfnAnalyzerProps(
    type="type",

    # the properties below are optional
    analyzer_configuration=accessanalyzer.CfnAnalyzer.AnalyzerConfigurationProperty(
        unused_access_configuration=accessanalyzer.CfnAnalyzer.UnusedAccessConfigurationProperty(
            analysis_rule=accessanalyzer.CfnAnalyzer.AnalysisRuleProperty(
                exclusions=[accessanalyzer.CfnAnalyzer.AnalysisRuleCriteriaProperty(
                    account_ids=["accountIds"],
                    resource_tags=[[CfnTag(
                        key="key",
                        value="value"
                    )]]
                )]
            ),
            unused_access_age=123
        )
    ),
    analyzer_name="analyzerName",
    archive_rules=[accessanalyzer.CfnAnalyzer.ArchiveRuleProperty(
        filter=[accessanalyzer.CfnAnalyzer.FilterProperty(
            property="property",

            # the properties below are optional
            contains=["contains"],
            eq=["eq"],
            exists=False,
            neq=["neq"]
        )],
        rule_name="ruleName"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

analyzer_configuration

Contains information about the configuration of an analyzer for an AWS organization or account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-analyzerconfiguration

analyzer_name

The name of the analyzer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-analyzername

archive_rules

Specifies the archive rules to add for the analyzer.

Archive rules automatically archive findings that meet the criteria you define for the rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-archiverules

tags

An array of key-value pairs to apply to the analyzer.

You can use the set of Unicode letters, digits, whitespace, _ , . , / , = , + , and - .

For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with aws: .

For the tag value, you can specify a value that is 0 to 256 characters in length.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-tags

type

The type represents the zone of trust for the analyzer.

Allowed Values : ACCOUNT | ORGANIZATION | ACCOUNT_UNUSED_ACCESS | ORGANIZATION_UNUSED_ACCESS

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-type