CfnDetectorProps

class aws_cdk.aws_guardduty.CfnDetectorProps(*, enable, data_sources=None, features=None, finding_publishing_frequency=None, tags=None)

Bases: object

Properties for defining a CfnDetector.

Parameters:
  • enable (Union[bool, IResolvable]) – Specifies whether the detector is to be enabled on creation.

  • data_sources (Union[IResolvable, CFNDataSourceConfigurationsProperty, Dict[str, Any], None]) – Describes which data sources will be enabled for the detector.

  • features (Union[IResolvable, Sequence[Union[IResolvable, FeatureConfigurationsProperty, Dict[str, Any]]], None]) – A list of features that will be configured for the detector.

  • finding_publishing_frequency (Optional[str]) – Specifies how frequently updated findings are exported.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Specifies tags added to a new detector resource. 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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_guardduty as guardduty

cfn_detector_props = guardduty.CfnDetectorProps(
    enable=False,

    # the properties below are optional
    data_sources=guardduty.CfnDetector.CFNDataSourceConfigurationsProperty(
        kubernetes=guardduty.CfnDetector.CFNKubernetesConfigurationProperty(
            audit_logs=guardduty.CfnDetector.CFNKubernetesAuditLogsConfigurationProperty(
                enable=False
            )
        ),
        malware_protection=guardduty.CfnDetector.CFNMalwareProtectionConfigurationProperty(
            scan_ec2_instance_with_findings=guardduty.CfnDetector.CFNScanEc2InstanceWithFindingsConfigurationProperty(
                ebs_volumes=False
            )
        ),
        s3_logs=guardduty.CfnDetector.CFNS3LogsConfigurationProperty(
            enable=False
        )
    ),
    features=[guardduty.CfnDetector.FeatureConfigurationsProperty(
        additional_configuration=[guardduty.CfnDetector.FeatureAdditionalConfigurationProperty(
            name="name",
            status="status"
        )],
        name="name",
        status="status"
    )],
    finding_publishing_frequency="findingPublishingFrequency",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

data_sources

Describes which data sources will be enabled for the detector.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-datasources

enable

Specifies whether the detector is to be enabled on creation.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-enable

features

A list of features that will be configured for the detector.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-features

finding_publishing_frequency

Specifies how frequently updated findings are exported.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-findingpublishingfrequency

tags

Specifies tags added to a new detector resource.

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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html#cfn-guardduty-detector-tags