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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-auditmanager/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", # accepts PROCESS_OWNER, RESOURCE_OWNER
      role_arn: "IamArn",
    },
  ],
  framework_id: "UUID", # required
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_reports_destinationTypes::AssessmentReportsDestination

The assessment report storage destination for the specified assessment that is being created.



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 1575

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

#descriptionString

The optional description of the assessment to be created.

Returns:

  • (String)


1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 1575

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

#framework_idString

The identifier for the specified framework.

Returns:

  • (String)


1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 1575

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

#nameString

The name of the assessment to be created.

Returns:

  • (String)


1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 1575

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

#rolesArray<Types::Role>

The list of roles for the specified assessment.

Returns:



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 1575

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

#scopeTypes::Scope

The wrapper that contains the accounts and services in scope for the assessment.

Returns:



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 1575

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

#tagsHash<String,String>

The tags associated with the assessment.

Returns:

  • (Hash<String,String>)


1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 1575

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