Class CfnDetector
The AWS::GuardDuty::Detector
resource specifies a new GuardDuty detector.
Inherited Members
Namespace: Amazon.CDK.AWS.GuardDuty
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDetector : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDetector
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
A detector is an object that represents the GuardDuty service. A detector is required for GuardDuty to become operational.
Make sure you use either DataSources
or Features
in a one request, and not both.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html
CloudformationResource: AWS::GuardDuty::Detector
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GuardDuty;
var cfnDetector = new CfnDetector(this, "MyCfnDetector", new CfnDetectorProps {
Enable = false,
// the properties below are optional
DataSources = new CFNDataSourceConfigurationsProperty {
Kubernetes = new CFNKubernetesConfigurationProperty {
AuditLogs = new CFNKubernetesAuditLogsConfigurationProperty {
Enable = false
}
},
MalwareProtection = new CFNMalwareProtectionConfigurationProperty {
ScanEc2InstanceWithFindings = new CFNScanEc2InstanceWithFindingsConfigurationProperty {
EbsVolumes = false
}
},
S3Logs = new CFNS3LogsConfigurationProperty {
Enable = false
}
},
Features = new [] { new CFNFeatureConfigurationProperty {
Name = "name",
Status = "status",
// the properties below are optional
AdditionalConfiguration = new [] { new CFNFeatureAdditionalConfigurationProperty {
Name = "name",
Status = "status"
} }
} },
FindingPublishingFrequency = "findingPublishingFrequency",
Tags = new [] { new TagItemProperty {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDetector(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDetector(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDetector(Construct, String, ICfnDetectorProps) |
Properties
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataSources | Describes which data sources will be enabled for the detector. |
Enable | Specifies whether the detector is to be enabled on creation. |
Features | A list of features that will be configured for the detector. |
FindingPublishingFrequency | Specifies how frequently updated findings are exported. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Specifies tags added to a new detector resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDetector(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDetector(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDetector(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDetector(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDetector(Construct, String, ICfnDetectorProps)
public CfnDetector(Construct scope, string id, ICfnDetectorProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDetectorProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataSources
Describes which data sources will be enabled for the detector.
public virtual object DataSources { get; set; }
Property Value
System.Object
Enable
Specifies whether the detector is to be enabled on creation.
public virtual object Enable { get; set; }
Property Value
System.Object
Features
A list of features that will be configured for the detector.
public virtual object Features { get; set; }
Property Value
System.Object
FindingPublishingFrequency
Specifies how frequently updated findings are exported.
public virtual string FindingPublishingFrequency { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Specifies tags added to a new detector resource.
public virtual CfnDetector.ITagItemProperty[] TagsRaw { get; set; }
Property Value
CfnDetector.ITagItemProperty[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>