Class: Aws::AuditManager::Types::CreateAssessmentRequest

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 CreateAssessmentRequest data as a hash:

{
  name: "AssessmentName", # required
  description: "AssessmentDescription",
  assessment_reports_destination: { # required
    destination_type: "S3", # accepts S3
    destination: "S3Url",
  },
  scope: { # required
    aws_accounts: [
      {
        id: "AccountId",
        email_address: "EmailAddress",
        name: "AccountName",
      },
    ],
    aws_services: [
      {
        service_name: "AWSServiceName",
      },
    ],
  },
  roles: [ # required
    {
      role_type: "PROCESS_OWNER", # required, accepts PROCESS_OWNER, RESOURCE_OWNER
      role_arn: "IamArn", # required
    },
  ],
  framework_id: "UUID", # required
  tags: {
    "TagKey" => "TagValue",
  },
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_reports_destination ⇒ Types::AssessmentReportsDestination

The assessment report storage destination for the assessment that’s being created.

Returns:



1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 1839

class CreateAssessmentRequest < Struct.new(
  :name,
  :description,
  :assessment_reports_destination,
  :scope,
  :roles,
  :framework_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The optional description of the assessment to be created.

Returns:

  • (String) 


1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 1839

class CreateAssessmentRequest < Struct.new(
  :name,
  :description,
  :assessment_reports_destination,
  :scope,
  :roles,
  :framework_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#framework_id ⇒ String

The identifier for the framework that the assessment will be created from.

Returns:

  • (String) 


1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 1839

class CreateAssessmentRequest < Struct.new(
  :name,
  :description,
  :assessment_reports_destination,
  :scope,
  :roles,
  :framework_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the assessment to be created.

Returns:

  • (String) 


1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 1839

class CreateAssessmentRequest < Struct.new(
  :name,
  :description,
  :assessment_reports_destination,
  :scope,
  :roles,
  :framework_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#roles ⇒ Array<Types::Role>

The list of roles for the assessment.

Returns:



1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 1839

class CreateAssessmentRequest < Struct.new(
  :name,
  :description,
  :assessment_reports_destination,
  :scope,
  :roles,
  :framework_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ Types::Scope

The wrapper that contains the Amazon Web Services accounts and services that are in scope for the assessment.

Returns:



1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 1839

class CreateAssessmentRequest < Struct.new(
  :name,
  :description,
  :assessment_reports_destination,
  :scope,
  :roles,
  :framework_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags that are associated with the assessment.

Returns:

  • (Hash<String,String>) 


1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 1839

class CreateAssessmentRequest < Struct.new(
  :name,
  :description,
  :assessment_reports_destination,
  :scope,
  :roles,
  :framework_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end