Package software.amazon.awscdk.services.inspector

Interface CfnAssessmentTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssessmentTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:17.920Z")
@Stability(Stable)
public interface CfnAssessmentTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAssessmentTemplate.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.inspector.*;
 CfnAssessmentTemplateProps cfnAssessmentTemplateProps = CfnAssessmentTemplateProps.builder()
         .assessmentTargetArn("assessmentTargetArn")
         .durationInSeconds(123)
         .rulesPackageArns(List.of("rulesPackageArns"))
         // the properties below are optional
         .assessmentTemplateName("assessmentTemplateName")
         .userAttributesForFindings(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAssessmentTemplateProps.Builder	A builder for CfnAssessmentTemplateProps
static final class	CfnAssessmentTemplateProps.Jsii$Proxy	An implementation for CfnAssessmentTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnAssessmentTemplateProps.Builder	builder()
String	getAssessmentTargetArn()	The ARN of the assessment target to be included in the assessment template.
default String	getAssessmentTemplateName()	The user-defined name that identifies the assessment template that you want to create.
Number	getDurationInSeconds()	The duration of the assessment run in seconds.
List<String>	getRulesPackageArns()	The ARNs of the rules packages that you want to use in the assessment template.
default Object	getUserAttributesForFindings()	The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssessmentTargetArn

@Stability(Stable)
@NotNull
String getAssessmentTargetArn()

The ARN of the assessment target to be included in the assessment template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-assessmenttargetarn

getDurationInSeconds

@Stability(Stable)
@NotNull
Number getDurationInSeconds()

The duration of the assessment run in seconds.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-durationinseconds

getRulesPackageArns

@Stability(Stable)
@NotNull
List<String> getRulesPackageArns()

The ARNs of the rules packages that you want to use in the assessment template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-rulespackagearns

getAssessmentTemplateName

@Stability(Stable)
@Nullable
default String getAssessmentTemplateName()

The user-defined name that identifies the assessment template that you want to create.

You can create several assessment templates for the same assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-assessmenttemplatename

getUserAttributesForFindings

@Stability(Stable)
@Nullable
default Object getUserAttributesForFindings()

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

Within an assessment template, each key must be unique.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspector-assessmenttemplate.html#cfn-inspector-assessmenttemplate-userattributesforfindings

builder

@Stability(Stable)
static CfnAssessmentTemplateProps.Builder builder()

Returns:

a CfnAssessmentTemplateProps.Builder of CfnAssessmentTemplateProps