Class CfnDetector
A CloudFormation AWS::GuardDuty::Detector
.
Inherited Members
Namespace: Amazon.CDK.AWS.GuardDuty
Assembly: Amazon.CDK.AWS.GuardDuty.dll
Syntax (csharp)
public class CfnDetector : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDetector
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::GuardDuty::Detector
resource specifies a new GuardDuty detector. 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.
CloudformationResource: AWS::GuardDuty::Detector
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html
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 FeatureConfigurationsProperty {
AdditionalConfiguration = new [] { new FeatureAdditionalConfigurationProperty {
Name = "name",
Status = "status"
} },
Name = "name",
Status = "status"
} },
FindingPublishingFrequency = "findingPublishingFrequency",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDetector(Construct, String, ICfnDetectorProps) | Create a new |
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 |
Properties
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 | Specifies tags added to a new detector resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDetector(Construct, String, ICfnDetectorProps)
Create a new AWS::GuardDuty::Detector
.
public CfnDetector(Construct scope, string id, ICfnDetectorProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDetectorProps
- resource properties.
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
Properties
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
Remarks
Enable
Specifies whether the detector is to be enabled on creation.
public virtual object Enable { get; set; }
Property Value
System.Object
Remarks
Features
A list of features that will be configured for the detector.
public virtual object Features { get; set; }
Property Value
System.Object
Remarks
FindingPublishingFrequency
Specifies how frequently updated findings are exported.
public virtual string FindingPublishingFrequency { get; set; }
Property Value
System.String
Remarks
Tags
Specifies tags added to a new detector resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Each tag consists of a key and an optional value, both of which you define.
Currently, support is available only for creating and deleting a tag. No support exists for updating the tags.
For more information, see Tag .
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>