software.amazon.awscdk.services.inspector

Class CfnAssessmentTemplate

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.inspector.CfnAssessmentTemplate

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.739Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAssessmentTemplate(Construct scope, java.lang.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
java.lang.String	getAssessmentTargetArn() The ARN of the assessment target to be included in the assessment template.
java.lang.String	getAssessmentTemplateName() The user-defined name that identifies the assessment template that you want to create.
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) that specifies the assessment template that is created.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Number	getDurationInSeconds() The duration of the assessment run in seconds.
java.util.List<java.lang.String>	getRulesPackageArns() The ARNs of the rules packages that you want to use in the assessment template.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAssessmentTargetArn(java.lang.String value) The ARN of the assessment target to be included in the assessment template.
void	setAssessmentTemplateName(java.lang.String value) The user-defined name that identifies the assessment template that you want to create.
void	setDurationInSeconds(java.lang.Number value) The duration of the assessment run in seconds.
void	setRulesPackageArns(java.util.List<java.lang.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(java.util.List<java.lang.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.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnAssessmentTemplate(Construct scope,
                             java.lang.String id,
                             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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAssessmentTargetArn

public java.lang.String getAssessmentTargetArn()

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

setAssessmentTargetArn

public void setAssessmentTargetArn(java.lang.String value)

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

getDurationInSeconds

public java.lang.Number getDurationInSeconds()

The duration of the assessment run in seconds.

setDurationInSeconds

public void setDurationInSeconds(java.lang.Number value)

The duration of the assessment run in seconds.

getRulesPackageArns

public java.util.List<java.lang.String> getRulesPackageArns()

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

setRulesPackageArns

public void setRulesPackageArns(java.util.List<java.lang.String> value)

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

getAssessmentTemplateName

public java.lang.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

public void setAssessmentTemplateName(java.lang.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

public java.lang.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

public 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.

Within an assessment template, each key must be unique.

setUserAttributesForFindings

public void setUserAttributesForFindings(java.util.List<java.lang.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.