You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Inspector::Types::CreateAssessmentTemplateRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb

Overview

Note:

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

{
  assessment_target_arn: "Arn", # required
  assessment_template_name: "AssessmentTemplateName", # required
  duration_in_seconds: 1, # required
  rules_package_arns: ["Arn"], # required
  user_attributes_for_findings: [
    {
      key: "AttributeKey", # required
      value: "AttributeValue",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_target_arnString

The ARN that specifies the assessment target for which you want to create the assessment template.

Returns:

  • (String)


711
712
713
714
715
716
717
718
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 711

class CreateAssessmentTemplateRequest < Struct.new(
  :assessment_target_arn,
  :assessment_template_name,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings)
  include Aws::Structure
end

#assessment_template_nameString

The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique.

Returns:

  • (String)


711
712
713
714
715
716
717
718
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 711

class CreateAssessmentTemplateRequest < Struct.new(
  :assessment_target_arn,
  :assessment_template_name,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings)
  include Aws::Structure
end

#duration_in_secondsInteger

The duration of the assessment run in seconds. The default value is 3600 seconds (one hour).

Returns:

  • (Integer)


711
712
713
714
715
716
717
718
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 711

class CreateAssessmentTemplateRequest < Struct.new(
  :assessment_target_arn,
  :assessment_template_name,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings)
  include Aws::Structure
end

#rules_package_arnsArray<String>

The ARNs that specify the rules packages that you want to attach to the assessment template.

Returns:

  • (Array<String>)


711
712
713
714
715
716
717
718
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 711

class CreateAssessmentTemplateRequest < Struct.new(
  :assessment_target_arn,
  :assessment_template_name,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings)
  include Aws::Structure
end

#user_attributes_for_findingsArray<Types::Attribute>

The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template. An attribute is a key and value pair (an Attribute object). Within an assessment template, each key must be unique.

Returns:



711
712
713
714
715
716
717
718
# File 'gems/aws-sdk-inspector/lib/aws-sdk-inspector/types.rb', line 711

class CreateAssessmentTemplateRequest < Struct.new(
  :assessment_target_arn,
  :assessment_template_name,
  :duration_in_seconds,
  :rules_package_arns,
  :user_attributes_for_findings)
  include Aws::Structure
end