interface CfnAnalyzerProps

Language	Type name
.NET	`Amazon.CDK.AWS.AccessAnalyzer.CfnAnalyzerProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsaccessanalyzer#CfnAnalyzerProps`
Java	`software.amazon.awscdk.services.accessanalyzer.CfnAnalyzerProps`
Python	`aws_cdk.aws_accessanalyzer.CfnAnalyzerProps`
TypeScript	`aws-cdk-lib` » `aws_accessanalyzer` » `CfnAnalyzerProps`

Properties for defining a CfnAnalyzer.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_accessanalyzer as accessanalyzer } from 'aws-cdk-lib';
const cfnAnalyzerProps: accessanalyzer.CfnAnalyzerProps = {
  type: 'type',

  // the properties below are optional
  analyzerConfiguration: {
    unusedAccessConfiguration: {
      analysisRule: {
        exclusions: [{
          accountIds: ['accountIds'],
          resourceTags: [[{
            key: 'key',
            value: 'value',
          }]],
        }],
      },
      unusedAccessAge: 123,
    },
  },
  analyzerName: 'analyzerName',
  archiveRules: [{
    filter: [{
      property: 'property',

      // the properties below are optional
      contains: ['contains'],
      eq: ['eq'],
      exists: false,
      neq: ['neq'],
    }],
    ruleName: 'ruleName',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
type	`string`	The type represents the zone of trust for the analyzer.
analyzerConfiguration?	`IResolvable` `\|` `AnalyzerConfigurationProperty`	Contains information about the configuration of an analyzer for an AWS organization or account.
analyzerName?	`string`	The name of the analyzer.
archiveRules?	`IResolvable` `\|` `IResolvable` `\|` `ArchiveRuleProperty[]`	Specifies the archive rules to add for the analyzer.
tags?	`CfnTag[]`	An array of key-value pairs to apply to the analyzer.

type

Type: string

The type represents the zone of trust for the analyzer.

Allowed Values : ACCOUNT | ORGANIZATION | ACCOUNT_UNUSED_ACCESS | ORGANIZATION_UNUSED_ACCESS

analyzerConfiguration?

Type: IResolvable | AnalyzerConfigurationProperty (optional)

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

analyzerName?

Type: string (optional)

The name of the analyzer.

archiveRules?

Type: IResolvable | IResolvable | ArchiveRuleProperty[] (optional)

Specifies the archive rules to add for the analyzer.

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

tags?

Type: CfnTag[] (optional)

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.