software.amazon.awscdk.services.inspector

Class CfnAssessmentTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.inspector.CfnAssessmentTemplate

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.828Z")
 @Stability(value=Stable)
public class CfnAssessmentTemplate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Inspector::AssessmentTemplate`.

The AWS::Inspector::AssessmentTemplate resource creates an Amazon Inspector assessment template, which specifies the Inspector assessment targets that will be evaluated by an assessment run and its related configurations.

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.*;
 CfnAssessmentTemplate cfnAssessmentTemplate = CfnAssessmentTemplate.Builder.create(this, "MyCfnAssessmentTemplate")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAssessmentTemplate.Builder A fluent builder for CfnAssessmentTemplate.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAssessmentTemplate(software.constructs.Construct scope, String id, CfnAssessmentTemplateProps props) Create a new `AWS::Inspector::AssessmentTemplate`.
protected	CfnAssessmentTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAssessmentTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAssessmentTargetArn() The ARN of the assessment target to be included in the assessment template.
String	getAssessmentTemplateName() The user-defined name that identifies the assessment template that you want to create.
String	getAttrArn() The Amazon Resource Name (ARN) that specifies the assessment template that is created.
protected Map<String,Object>	getCfnProperties()
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.
Object	getUserAttributesForFindings() The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssessmentTargetArn(String value) The ARN of the assessment target to be included in the assessment template.
void	setAssessmentTemplateName(String value) The user-defined name that identifies the assessment template that you want to create.
void	setDurationInSeconds(Number value) The duration of the assessment run in seconds.
void	setRulesPackageArns(List<String> value) The ARNs of the rules packages that you want to use in the assessment template.
void	setUserAttributesForFindings(IResolvable value) The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template.
void	setUserAttributesForFindings(List<Object> value) 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 class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAssessmentTemplate

protected CfnAssessmentTemplate(software.amazon.jsii.JsiiObjectRef objRef)

CfnAssessmentTemplate

protected CfnAssessmentTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAssessmentTemplate

@Stability(value=Stable)
public CfnAssessmentTemplate(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      CfnAssessmentTemplateProps props)

Create a new `AWS::Inspector::AssessmentTemplate`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAssessmentTargetArn

@Stability(value=Stable)
 @NotNull
public String getAssessmentTargetArn()

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

setAssessmentTargetArn

@Stability(value=Stable)
public void setAssessmentTargetArn(@NotNull
                                                            String value)

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

getDurationInSeconds

@Stability(value=Stable)
 @NotNull
public Number getDurationInSeconds()

The duration of the assessment run in seconds.

setDurationInSeconds

@Stability(value=Stable)
public void setDurationInSeconds(@NotNull
                                                          Number value)

The duration of the assessment run in seconds.

getRulesPackageArns

@Stability(value=Stable)
 @NotNull
public List<String> getRulesPackageArns()

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

setRulesPackageArns

@Stability(value=Stable)
public void setRulesPackageArns(@NotNull
                                                         List<String> value)

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

getAssessmentTemplateName

@Stability(value=Stable)
 @Nullable
public 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.

setAssessmentTemplateName

@Stability(value=Stable)
public void setAssessmentTemplateName(@Nullable
                                                               String value)

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.

getUserAttributesForFindings

@Stability(value=Stable)
 @Nullable
public 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.

setUserAttributesForFindings

@Stability(value=Stable)
public void setUserAttributesForFindings(@Nullable
                                                                  IResolvable value)

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.

setUserAttributesForFindings

@Stability(value=Stable)
public void setUserAttributesForFindings(@Nullable
                                                                  List<Object> value)

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.