Package software.amazon.awscdk.services.securityhub

Class CfnInsight

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.securityhub.CfnInsight

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:51.304Z")
@Stability(Stable)
public class CfnInsight
extends CfnResource
implements IInspectable

The AWS::SecurityHub::Insight resource creates a custom insight in AWS Security Hub .

An insight is a collection of findings that relate to a security issue that requires attention or remediation. For more information, see Insights in AWS Security Hub in the AWS Security Hub User Guide .

Tags aren't supported for this resource.

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.securityhub.*;
 CfnInsight cfnInsight = CfnInsight.Builder.create(this, "MyCfnInsight")
         .filters(AwsSecurityFindingFiltersProperty.builder()
                 .awsAccountId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .awsAccountName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .companyName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .complianceAssociatedStandardsId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .complianceSecurityControlId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .complianceSecurityControlParametersName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .complianceSecurityControlParametersValue(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .complianceStatus(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .confidence(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .createdAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .criticality(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .description(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .findingProviderFieldsConfidence(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .findingProviderFieldsCriticality(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .findingProviderFieldsRelatedFindingsId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .findingProviderFieldsRelatedFindingsProductArn(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .findingProviderFieldsSeverityLabel(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .findingProviderFieldsSeverityOriginal(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .findingProviderFieldsTypes(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .firstObservedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .generatorId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .id(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .keyword(List.of(KeywordFilterProperty.builder()
                         .value("value")
                         .build()))
                 .lastObservedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .malwareName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .malwarePath(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .malwareState(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .malwareType(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .networkDestinationDomain(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .networkDestinationIpV4(List.of(IpFilterProperty.builder()
                         .cidr("cidr")
                         .build()))
                 .networkDestinationIpV6(List.of(IpFilterProperty.builder()
                         .cidr("cidr")
                         .build()))
                 .networkDestinationPort(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .networkDirection(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .networkProtocol(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .networkSourceDomain(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .networkSourceIpV4(List.of(IpFilterProperty.builder()
                         .cidr("cidr")
                         .build()))
                 .networkSourceIpV6(List.of(IpFilterProperty.builder()
                         .cidr("cidr")
                         .build()))
                 .networkSourceMac(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .networkSourcePort(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .noteText(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .noteUpdatedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .noteUpdatedBy(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .processLaunchedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .processName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .processParentPid(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .processPath(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .processPid(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .processTerminatedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .productArn(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .productFields(List.of(MapFilterProperty.builder()
                         .comparison("comparison")
                         .key("key")
                         .value("value")
                         .build()))
                 .productName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .recommendationText(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .recordState(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .region(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .relatedFindingsId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .relatedFindingsProductArn(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceApplicationArn(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceApplicationName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsEc2InstanceIamInstanceProfileArn(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsEc2InstanceImageId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsEc2InstanceIpV4Addresses(List.of(IpFilterProperty.builder()
                         .cidr("cidr")
                         .build()))
                 .resourceAwsEc2InstanceIpV6Addresses(List.of(IpFilterProperty.builder()
                         .cidr("cidr")
                         .build()))
                 .resourceAwsEc2InstanceKeyName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsEc2InstanceLaunchedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .resourceAwsEc2InstanceSubnetId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsEc2InstanceType(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsEc2InstanceVpcId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsIamAccessKeyCreatedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .resourceAwsIamAccessKeyPrincipalName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsIamAccessKeyStatus(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsIamAccessKeyUserName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsIamUserUserName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsS3BucketOwnerId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceAwsS3BucketOwnerName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceContainerImageId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceContainerImageName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceContainerLaunchedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .resourceContainerName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceDetailsOther(List.of(MapFilterProperty.builder()
                         .comparison("comparison")
                         .key("key")
                         .value("value")
                         .build()))
                 .resourceId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourcePartition(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceRegion(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceTags(List.of(MapFilterProperty.builder()
                         .comparison("comparison")
                         .key("key")
                         .value("value")
                         .build()))
                 .resourceType(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .sample(List.of(BooleanFilterProperty.builder()
                         .value(false)
                         .build()))
                 .severityLabel(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .severityNormalized(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .severityProduct(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .sourceUrl(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .threatIntelIndicatorCategory(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .threatIntelIndicatorLastObservedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .threatIntelIndicatorSource(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .threatIntelIndicatorSourceUrl(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .threatIntelIndicatorType(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .threatIntelIndicatorValue(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .title(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .type(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .updatedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .userDefinedFields(List.of(MapFilterProperty.builder()
                         .comparison("comparison")
                         .key("key")
                         .value("value")
                         .build()))
                 .verificationState(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .vulnerabilitiesExploitAvailable(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .vulnerabilitiesFixAvailable(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .workflowState(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .workflowStatus(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .build())
         .groupByAttribute("groupByAttribute")
         .name("name")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-insight.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnInsight.AwsSecurityFindingFiltersProperty	A collection of filters that are applied to all active findings aggregated by AWS Security Hub .
static interface	CfnInsight.BooleanFilterProperty	Boolean filter for querying findings.
static final class	CfnInsight.Builder	A fluent builder for CfnInsight.
static interface	CfnInsight.DateFilterProperty	A date filter for querying findings.
static interface	CfnInsight.DateRangeProperty	A date range for the date filter.
static interface	CfnInsight.IpFilterProperty	The IP filter for querying findings.
static interface	CfnInsight.KeywordFilterProperty	A keyword filter for querying findings.
static interface	CfnInsight.MapFilterProperty	A map filter for filtering AWS Security Hub findings.
static interface	CfnInsight.NumberFilterProperty	A number filter for querying findings.
static interface	CfnInsight.StringFilterProperty	A string filter for filtering AWS Security Hub findings.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnInsight(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInsight(software.amazon.jsii.JsiiObjectRef objRef)
	CfnInsight(software.constructs.Construct scope, String id, CfnInsightProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrInsightArn()	The ARN of a Security Hub insight.
protected Map<String,Object>	getCfnProperties()
Object	getFilters()	One or more attributes used to filter the findings included in the insight.
String	getGroupByAttribute()	The grouping attribute for the insight's findings.
String	getName()	The name of a Security Hub insight.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFilters(IResolvable value)	One or more attributes used to filter the findings included in the insight.
void	setFilters(CfnInsight.AwsSecurityFindingFiltersProperty value)	One or more attributes used to filter the findings included in the insight.
void	setGroupByAttribute(String value)	The grouping attribute for the insight's findings.
void	setName(String value)	The name of a Security Hub insight.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnInsight

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

CfnInsight

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

CfnInsight

@Stability(Stable)
public CfnInsight(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnInsightProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrInsightArn

@Stability(Stable)
@NotNull
public String getAttrInsightArn()

The ARN of a Security Hub insight.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getFilters

@Stability(Stable)
@NotNull
public Object getFilters()

One or more attributes used to filter the findings included in the insight.

setFilters

@Stability(Stable)
public void setFilters(@NotNull
 IResolvable value)

One or more attributes used to filter the findings included in the insight.

setFilters

@Stability(Stable)
public void setFilters(@NotNull
 CfnInsight.AwsSecurityFindingFiltersProperty value)

One or more attributes used to filter the findings included in the insight.

getGroupByAttribute

@Stability(Stable)
@NotNull
public String getGroupByAttribute()

The grouping attribute for the insight's findings.

setGroupByAttribute

@Stability(Stable)
public void setGroupByAttribute(@NotNull
 String value)

The grouping attribute for the insight's findings.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of a Security Hub insight.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of a Security Hub insight.