Class: Aws::AuditManager::Types::UpdateSettingsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-auditmanager/types.rb

Overview

Note:

When making an API call, you may pass UpdateSettingsRequest data as a hash:

{
  sns_topic: "SnsArn",
  default_assessment_reports_destination: {
    destination_type: "S3", # accepts S3
    destination: "S3Url",
  },
  default_process_owners: [
    {
      role_type: "PROCESS_OWNER", # required, accepts PROCESS_OWNER, RESOURCE_OWNER
      role_arn: "IamArn", # required
    },
  ],
  kms_key: "KmsKey",
  evidence_finder_enabled: false,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_assessment_reports_destination ⇒ Types::AssessmentReportsDestination

The default storage destination for assessment reports.

Returns:



5262
5263
5264
5265
5266
5267
5268
5269
5270
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 5262

class UpdateSettingsRequest < Struct.new(
  :sns_topic,
  :default_assessment_reports_destination,
  :default_process_owners,
  :kms_key,
  :evidence_finder_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#default_process_owners ⇒ Array<Types::Role>

A list of the default audit owners.

Returns:



5262
5263
5264
5265
5266
5267
5268
5269
5270
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 5262

class UpdateSettingsRequest < Struct.new(
  :sns_topic,
  :default_assessment_reports_destination,
  :default_process_owners,
  :kms_key,
  :evidence_finder_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#evidence_finder_enabled ⇒ Boolean

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.

Disabling evidence finder is permanent, so consider this decision

carefully before you proceed. If you’re using Audit Manager as a delegated administrator, keep in mind that this action applies to all member accounts in your organization.

[1]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html [2]: docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html

Returns:

  • (Boolean) 


5262
5263
5264
5265
5266
5267
5268
5269
5270
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 5262

class UpdateSettingsRequest < Struct.new(
  :sns_topic,
  :default_assessment_reports_destination,
  :default_process_owners,
  :kms_key,
  :evidence_finder_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key ⇒ String

The KMS key details.

Returns:

  • (String) 


5262
5263
5264
5265
5266
5267
5268
5269
5270
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 5262

class UpdateSettingsRequest < Struct.new(
  :sns_topic,
  :default_assessment_reports_destination,
  :default_process_owners,
  :kms_key,
  :evidence_finder_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic ⇒ String

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

Returns:

  • (String) 


5262
5263
5264
5265
5266
5267
5268
5269
5270
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 5262

class UpdateSettingsRequest < Struct.new(
  :sns_topic,
  :default_assessment_reports_destination,
  :default_process_owners,
  :kms_key,
  :evidence_finder_enabled)
  SENSITIVE = []
  include Aws::Structure
end