software.amazon.awscdk.services.guardduty

Class CfnDetector

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

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.684Z")
 @Stability(value=Stable)
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 or Kubernetes audit logs 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 Example:
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 Example:

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
	CfnDetector(software.constructs.Construct scope, 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 Map<String,Object>	getCfnProperties()
Object	getDataSources() Describes which data sources will be enabled for the detector.
Object	getEnable() Specifies whether the detector is to be enabled on creation.
String	getFindingPublishingFrequency() Specifies how frequently updated findings are exported.
TagManager	getTags() `AWS::GuardDuty::Detector.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,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(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(String value) Specifies how frequently updated findings are exported.

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

CfnDetector

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

CfnDetector

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

CfnDetector

@Stability(value=Stable)
public CfnDetector(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::GuardDuty::Detector.Tags`.

getEnable

@Stability(value=Stable)
 @NotNull
public Object getEnable()

Specifies whether the detector is to be enabled on creation.

setEnable

@Stability(value=Stable)
public void setEnable(@NotNull
                                               Boolean value)

Specifies whether the detector is to be enabled on creation.

setEnable

@Stability(value=Stable)
public void setEnable(@NotNull
                                               IResolvable value)

Specifies whether the detector is to be enabled on creation.

getDataSources

@Stability(value=Stable)
 @Nullable
public Object getDataSources()

Describes which data sources will be enabled for the detector.

setDataSources

@Stability(value=Stable)
public void setDataSources(@Nullable
                                                    CfnDetector.CFNDataSourceConfigurationsProperty value)

Describes which data sources will be enabled for the detector.

setDataSources

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

Describes which data sources will be enabled for the detector.

getFindingPublishingFrequency

@Stability(value=Stable)
 @Nullable
public String getFindingPublishingFrequency()

Specifies how frequently updated findings are exported.

setFindingPublishingFrequency

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

Specifies how frequently updated findings are exported.