software.amazon.awscdk.services.guardduty

Class CfnDetector

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.guardduty.CfnDetector

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.487Z")
public class CfnDetector
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GuardDuty::Detector`.

The AWS::GuardDuty::Detector resource specifies a new detector. A detector is an object that represents the service. A detector is required for to become operational.

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.guardduty.*;
 CfnDetector cfnDetector = CfnDetector.Builder.create(this, "MyCfnDetector")
         .enable(false)
         // the properties below are optional
         .dataSources(CFNDataSourceConfigurationsProperty.builder()
                 .kubernetes(CFNKubernetesConfigurationProperty.builder()
                         .auditLogs(CFNKubernetesAuditLogsConfigurationProperty.builder()
                                 .enable(false)
                                 .build())
                         .build())
                 .malwareProtection(CFNMalwareProtectionConfigurationProperty.builder()
                         .scanEc2InstanceWithFindings(CFNScanEc2InstanceWithFindingsConfigurationProperty.builder()
                                 .ebsVolumes(false)
                                 .build())
                         .build())
                 .s3Logs(CFNS3LogsConfigurationProperty.builder()
                         .enable(false)
                         .build())
                 .build())
         .findingPublishingFrequency("findingPublishingFrequency")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDetector.Builder A fluent builder for CfnDetector.
static interface	CfnDetector.CFNDataSourceConfigurationsProperty Describes whether S3 data event logs, Kubernetes audit logs, or Malware Protection will be enabled as a data source when the detector is created.
static interface	CfnDetector.CFNKubernetesAuditLogsConfigurationProperty Describes which optional data sources are enabled for a detector.
static interface	CfnDetector.CFNKubernetesConfigurationProperty Describes which Kubernetes protection data sources are enabled for the detector.
static interface	CfnDetector.CFNMalwareProtectionConfigurationProperty Describes whether Malware Protection will be enabled as a data source.
static interface	CfnDetector.CFNS3LogsConfigurationProperty Describes whether S3 data event logs will be enabled as a data source when the detector is created.
static interface	CfnDetector.CFNScanEc2InstanceWithFindingsConfigurationProperty Describes whether Malware Protection for EC2 instances with findings will be enabled as a data source.

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
	CfnDetector(Construct scope, java.lang.String id, CfnDetectorProps props) Create a new `AWS::GuardDuty::Detector`.
protected	CfnDetector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDetector(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getDataSources() Describes which data sources will be enabled for the detector.
java.lang.Object	getEnable() Specifies whether the detector is to be enabled on creation.
java.lang.String	getFindingPublishingFrequency() Specifies how frequently updated findings are exported.
TagManager	getTags() The tags to be added to a new detector resource.
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	setDataSources(CfnDetector.CFNDataSourceConfigurationsProperty value) Describes which data sources will be enabled for the detector.
void	setDataSources(IResolvable value) Describes which data sources will be enabled for the detector.
void	setEnable(java.lang.Boolean value) Specifies whether the detector is to be enabled on creation.
void	setEnable(IResolvable value) Specifies whether the detector is to be enabled on creation.
void	setFindingPublishingFrequency(java.lang.String value) Specifies how frequently updated findings are exported.

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

CfnDetector

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

CfnDetector

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

CfnDetector

public CfnDetector(Construct scope,
                   java.lang.String id,
                   CfnDetectorProps props)

Create a new `AWS::GuardDuty::Detector`.

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags to be added to a new detector resource.

Each tag consists of a key and an optional value, both of which you define.

For more information, see Tag .

getEnable

public java.lang.Object getEnable()

Specifies whether the detector is to be enabled on creation.

setEnable

public void setEnable(java.lang.Boolean value)

Specifies whether the detector is to be enabled on creation.

setEnable

public void setEnable(IResolvable value)

Specifies whether the detector is to be enabled on creation.

getDataSources

public java.lang.Object getDataSources()

Describes which data sources will be enabled for the detector.

setDataSources

public void setDataSources(IResolvable value)

Describes which data sources will be enabled for the detector.

setDataSources

public void setDataSources(CfnDetector.CFNDataSourceConfigurationsProperty value)

Describes which data sources will be enabled for the detector.

getFindingPublishingFrequency

public java.lang.String getFindingPublishingFrequency()

Specifies how frequently updated findings are exported.

setFindingPublishingFrequency

public void setFindingPublishingFrequency(java.lang.String value)

Specifies how frequently updated findings are exported.