Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::Inspector::AssessmentTemplate

The AWS::Inspector::AssessmentTemplate resource creates an Amazon Inspector assessment template - a resource that contains information about an Amazon Inspector assessment template.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Inspector::AssessmentTemplate", "Properties" : { "AssessmentTargetArn" : String, "DurationInSeconds" : Integer, "AssessmentTemplateName" : String, "RulesPackageArns" : [ String, ... ], "UserAttributesForFindings" : [ Resource Tag, ... ] } }

YAML

Type: "AWS::Inspector::AssessmentTemplate" Properties: AssessmentTargetArn: String DurationInSeconds: Integer AssessmentTemplateName: String RulesPackageArns: - String UserAttributesForFindings: - Resource Tag

Properties

AssessmentTargetArn

The ARN of the assessment target that corresponds to this assessment template.

Required: Yes

Type: String

Update requires: Replacement

DurationInSeconds

The duration in seconds specified for this assessment tempate. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

Required: Yes

Type: Integer

Update requires: Replacement

AssessmentTemplateName

The name of the assessment template.

Required: No

Type: String

Update requires: Replacement

RulesPackageArns

The rules packages that are specified for this assessment template.

Required: Yes

Type: List of String values

Update requires: Replacement

UserAttributesForFindings

The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template.

Required: No

Type: List of AWS CloudFormation Resource Tags

Update requires: Replacement

Return Values

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

Arn

The Amazon Resource Name (ARN) that specifies the assessment template that is created.

For more information about using Fn::GetAtt, see Fn::GetAtt.

Examples

Declaring an Amazon Inspector Assessment Template Resource

The following example shows how to declare an AWS::Inspector::AssessmentTemplate resource to create an Amazon Inspector assessment template.

JSON

"myassessmenttemplate": { "Type": "AWS::Inspector::AssessmentTemplate", "Properties": { "AssessmentTargetArn" : "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX", "DurationInSeconds" : 180, "AssessmentTemplateName" : "MyAssessmentTemplate", "RulesPackageArns" : [ "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-11B9DBXp" ], "UserAttributesForFindings" : [ { "key": "Example", "value": "example" } ] } }

YAML

myassessmenttemplate: Properties: AssessmentTargetArn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX" AssessmentTemplateName: MyAssessmentTemplate DurationInSeconds: 180 RulesPackageArns: - "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-11B9DBXp" UserAttributesForFindings: - Key: Example Value: example Type: "AWS::Inspector::AssessmentTemplate"