Update Settings

auditmanager_update_settings

R Documentation

Updates Audit Manager settings for the current account

Description

Updates Audit Manager settings for the current account.

Usage

auditmanager_update_settings(snsTopic,
  defaultAssessmentReportsDestination, defaultProcessOwners, kmsKey,
  evidenceFinderEnabled, deregistrationPolicy, defaultExportDestination)

Arguments

snsTopic

The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to.

defaultAssessmentReportsDestination

The default S3 destination bucket for storing assessment reports.

defaultProcessOwners

A list of the default audit owners.

kmsKey

The KMS key details.

evidenceFinderEnabled

Specifies whether the evidence finder feature is enabled. Change this attribute to enable or disable evidence finder.

When you use this attribute to disable evidence finder, Audit Manager deletes the event data store that’s used to query your evidence data. As a result, you can’t re-enable evidence finder and use the feature again. Your only alternative is to deregister and then re-register Audit Manager.

deregistrationPolicy

The deregistration policy for your Audit Manager data. You can use this attribute to determine how your data is handled when you deregister Audit Manager.

defaultExportDestination

The default S3 destination bucket for storing evidence finder exports.

Value

A list with the following syntax:

list(
  settings = list(
    isAwsOrgEnabled = TRUE|FALSE,
    snsTopic = "string",
    defaultAssessmentReportsDestination = list(
      destinationType = "S3",
      destination = "string"
    ),
    defaultProcessOwners = list(
      list(
        roleType = "PROCESS_OWNER"|"RESOURCE_OWNER",
        roleArn = "string"
      )
    ),
    kmsKey = "string",
    evidenceFinderEnablement = list(
      eventDataStoreArn = "string",
      enablementStatus = "ENABLED"|"DISABLED"|"ENABLE_IN_PROGRESS"|"DISABLE_IN_PROGRESS",
      backfillStatus = "NOT_STARTED"|"IN_PROGRESS"|"COMPLETED",
      error = "string"
    ),
    deregistrationPolicy = list(
      deleteResources = "ALL"|"DEFAULT"
    ),
    defaultExportDestination = list(
      destinationType = "S3",
      destination = "string"
    )
  )
)

Request syntax

svc$update_settings(
  snsTopic = "string",
  defaultAssessmentReportsDestination = list(
    destinationType = "S3",
    destination = "string"
  ),
  defaultProcessOwners = list(
    list(
      roleType = "PROCESS_OWNER"|"RESOURCE_OWNER",
      roleArn = "string"
    )
  ),
  kmsKey = "string",
  evidenceFinderEnabled = TRUE|FALSE,
  deregistrationPolicy = list(
    deleteResources = "ALL"|"DEFAULT"
  ),
  defaultExportDestination = list(
    destinationType = "S3",
    destination = "string"
  )
)