@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:36.487Z") public class CfnDetector extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDetector(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDetector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDetector(Construct scope, java.lang.String id, CfnDetectorProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
Each tag consists of a key and an optional value, both of which you define.
For more information, see Tag .
public java.lang.Object getEnable()
public void setEnable(java.lang.Boolean value)
public void setEnable(IResolvable value)
public java.lang.Object getDataSources()
public void setDataSources(IResolvable value)
public void setDataSources(CfnDetector.CFNDataSourceConfigurationsProperty value)
public java.lang.String getFindingPublishingFrequency()
public void setFindingPublishingFrequency(java.lang.String value)