Skip to content

Create Analyzer

accessanalyzer_create_analyzer R Documentation

Creates an analyzer for your account

Description

Creates an analyzer for your account.

Usage

accessanalyzer_create_analyzer(analyzerName, type, archiveRules, tags,
  clientToken, configuration)

Arguments

analyzerName

[required] The name of the analyzer to create.

type

[required] The type of analyzer to create. Only ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS, and ORGANIZATION_UNUSED_ACCESS analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.

archiveRules

Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.

tags

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

clientToken

A client token.

configuration

Specifies the configuration of the analyzer. If the analyzer is an unused access analyzer, the specified scope of unused access is used for the configuration. If the analyzer is an external access analyzer, this field is not used.

Value

A list with the following syntax:

list(
  arn = "string"
)

Request syntax

svc$create_analyzer(
  analyzerName = "string",
  type = "ACCOUNT"|"ORGANIZATION"|"ACCOUNT_UNUSED_ACCESS"|"ORGANIZATION_UNUSED_ACCESS",
  archiveRules = list(
    list(
      ruleName = "string",
      filter = list(
        list(
          eq = list(
            "string"
          ),
          neq = list(
            "string"
          ),
          contains = list(
            "string"
          ),
          exists = TRUE|FALSE
        )
      )
    )
  ),
  tags = list(
    "string"
  ),
  clientToken = "string",
  configuration = list(
    unusedAccess = list(
      unusedAccessAge = 123
    )
  )
)