CfnDetectorPropsMixin

class aws_cdk.mixins_preview.aws_guardduty.mixins.CfnDetectorPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-detector.html
CloudformationResource:: AWS::GuardDuty::Detector
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_detector_props_mixin = guardduty_mixins.CfnDetectorPropsMixin(guardduty_mixins.CfnDetectorMixinProps(
    data_sources=guardduty_mixins.CfnDetectorPropsMixin.CFNDataSourceConfigurationsProperty(
        kubernetes=guardduty_mixins.CfnDetectorPropsMixin.CFNKubernetesConfigurationProperty(
            audit_logs=guardduty_mixins.CfnDetectorPropsMixin.CFNKubernetesAuditLogsConfigurationProperty(
                enable=False
            )
        ),
        malware_protection=guardduty_mixins.CfnDetectorPropsMixin.CFNMalwareProtectionConfigurationProperty(
            scan_ec2_instance_with_findings=guardduty_mixins.CfnDetectorPropsMixin.CFNScanEc2InstanceWithFindingsConfigurationProperty(
                ebs_volumes=False
            )
        ),
        s3_logs=guardduty_mixins.CfnDetectorPropsMixin.CFNS3LogsConfigurationProperty(
            enable=False
        )
    ),
    enable=False,
    features=[guardduty_mixins.CfnDetectorPropsMixin.CFNFeatureConfigurationProperty(
        additional_configuration=[guardduty_mixins.CfnDetectorPropsMixin.CFNFeatureAdditionalConfigurationProperty(
            name="name",
            status="status"
        )],
        name="name",
        status="status"
    )],
    finding_publishing_frequency="findingPublishingFrequency",
    tags=[guardduty_mixins.CfnDetectorPropsMixin.TagItemProperty(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::GuardDuty::Detector.

Parameters:

props (Union[CfnDetectorMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['dataSources', 'enable', 'features', 'findingPublishingFrequency', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CFNDataSourceConfigurationsProperty

class CfnDetectorPropsMixin.CFNDataSourceConfigurationsProperty(*, kubernetes=None, malware_protection=None, s3_logs=None)

Bases: object

Describes whether S3 data event logs, Kubernetes audit logs, or Malware Protection will be enabled as a data source when the detector is created.

Parameters:

kubernetes (Union[IResolvable, CFNKubernetesConfigurationProperty, Dict[str, Any], None]) – Describes which Kubernetes data sources are enabled for a detector.
malware_protection (Union[IResolvable, CFNMalwareProtectionConfigurationProperty, Dict[str, Any], None]) – Describes whether Malware Protection will be enabled as a data source.
s3_logs (Union[IResolvable, CFNS3LogsConfigurationProperty, Dict[str, Any], None]) – Describes whether S3 data event logs are enabled as a data source.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

c_fNData_source_configurations_property = guardduty_mixins.CfnDetectorPropsMixin.CFNDataSourceConfigurationsProperty(
    kubernetes=guardduty_mixins.CfnDetectorPropsMixin.CFNKubernetesConfigurationProperty(
        audit_logs=guardduty_mixins.CfnDetectorPropsMixin.CFNKubernetesAuditLogsConfigurationProperty(
            enable=False
        )
    ),
    malware_protection=guardduty_mixins.CfnDetectorPropsMixin.CFNMalwareProtectionConfigurationProperty(
        scan_ec2_instance_with_findings=guardduty_mixins.CfnDetectorPropsMixin.CFNScanEc2InstanceWithFindingsConfigurationProperty(
            ebs_volumes=False
        )
    ),
    s3_logs=guardduty_mixins.CfnDetectorPropsMixin.CFNS3LogsConfigurationProperty(
        enable=False
    )
)

Attributes

kubernetes

Describes which Kubernetes data sources are enabled for a detector.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfndatasourceconfigurations.html#cfn-guardduty-detector-cfndatasourceconfigurations-kubernetes

malware_protection

Describes whether Malware Protection will be enabled as a data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfndatasourceconfigurations.html#cfn-guardduty-detector-cfndatasourceconfigurations-malwareprotection

s3_logs

Describes whether S3 data event logs are enabled as a data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfndatasourceconfigurations.html#cfn-guardduty-detector-cfndatasourceconfigurations-s3logs

CFNFeatureAdditionalConfigurationProperty

class CfnDetectorPropsMixin.CFNFeatureAdditionalConfigurationProperty(*, name=None, status=None)

Bases: object

Information about the additional configuration of a feature in your account.

Parameters:

name (Optional[str]) – Name of the additional configuration.
status (Optional[str]) – Status of the additional configuration.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

c_fNFeature_additional_configuration_property = guardduty_mixins.CfnDetectorPropsMixin.CFNFeatureAdditionalConfigurationProperty(
    name="name",
    status="status"
)

Attributes

name

Name of the additional configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureadditionalconfiguration.html#cfn-guardduty-detector-cfnfeatureadditionalconfiguration-name

status

Status of the additional configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureadditionalconfiguration.html#cfn-guardduty-detector-cfnfeatureadditionalconfiguration-status

CFNFeatureConfigurationProperty

class CfnDetectorPropsMixin.CFNFeatureConfigurationProperty(*, additional_configuration=None, name=None, status=None)

Bases: object

Information about the configuration of a feature in your account.

Parameters:

additional_configuration (Union[IResolvable, Sequence[Union[IResolvable, CFNFeatureAdditionalConfigurationProperty, Dict[str, Any]]], None]) – Information about the additional configuration of a feature in your account.
name (Optional[str]) – Name of the feature. For a list of allowed values, see DetectorFeatureConfiguration in the GuardDuty API Reference .
status (Optional[str]) – Status of the feature configuration.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

c_fNFeature_configuration_property = guardduty_mixins.CfnDetectorPropsMixin.CFNFeatureConfigurationProperty(
    additional_configuration=[guardduty_mixins.CfnDetectorPropsMixin.CFNFeatureAdditionalConfigurationProperty(
        name="name",
        status="status"
    )],
    name="name",
    status="status"
)

Attributes

additional_configuration

Information about the additional configuration of a feature in your account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureconfiguration.html#cfn-guardduty-detector-cfnfeatureconfiguration-additionalconfiguration

name

Name of the feature.

For a list of allowed values, see DetectorFeatureConfiguration in the GuardDuty API Reference .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureconfiguration.html#cfn-guardduty-detector-cfnfeatureconfiguration-name

status

Status of the feature configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnfeatureconfiguration.html#cfn-guardduty-detector-cfnfeatureconfiguration-status

CFNKubernetesAuditLogsConfigurationProperty

class CfnDetectorPropsMixin.CFNKubernetesAuditLogsConfigurationProperty(*, enable=None)

Bases: object

Describes which optional data sources are enabled for a detector.

Parameters:: enable (Union[bool, IResolvable, None]) – Describes whether Kubernetes audit logs are enabled as a data source for the detector.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnkubernetesauditlogsconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

c_fNKubernetes_audit_logs_configuration_property = guardduty_mixins.CfnDetectorPropsMixin.CFNKubernetesAuditLogsConfigurationProperty(
    enable=False
)

Attributes

enable

Describes whether Kubernetes audit logs are enabled as a data source for the detector.

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

CFNKubernetesConfigurationProperty

class CfnDetectorPropsMixin.CFNKubernetesConfigurationProperty(*, audit_logs=None)

Bases: object

Describes which Kubernetes protection data sources are enabled for the detector.

Parameters:: audit_logs (Union[IResolvable, CFNKubernetesAuditLogsConfigurationProperty, Dict[str, Any], None]) – Describes whether Kubernetes audit logs are enabled as a data source for the detector.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnkubernetesconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

c_fNKubernetes_configuration_property = guardduty_mixins.CfnDetectorPropsMixin.CFNKubernetesConfigurationProperty(
    audit_logs=guardduty_mixins.CfnDetectorPropsMixin.CFNKubernetesAuditLogsConfigurationProperty(
        enable=False
    )
)

Attributes

audit_logs

Describes whether Kubernetes audit logs are enabled as a data source for the detector.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnkubernetesconfiguration.html#cfn-guardduty-detector-cfnkubernetesconfiguration-auditlogs

CFNMalwareProtectionConfigurationProperty

class CfnDetectorPropsMixin.CFNMalwareProtectionConfigurationProperty(*, scan_ec2_instance_with_findings=None)

Bases: object

Describes whether Malware Protection will be enabled as a data source.

Parameters:: scan_ec2_instance_with_findings (Union[IResolvable, CFNScanEc2InstanceWithFindingsConfigurationProperty, Dict[str, Any], None]) – Describes the configuration of Malware Protection for EC2 instances with findings.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnmalwareprotectionconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

c_fNMalware_protection_configuration_property = guardduty_mixins.CfnDetectorPropsMixin.CFNMalwareProtectionConfigurationProperty(
    scan_ec2_instance_with_findings=guardduty_mixins.CfnDetectorPropsMixin.CFNScanEc2InstanceWithFindingsConfigurationProperty(
        ebs_volumes=False
    )
)

Attributes

scan_ec2_instance_with_findings

Describes the configuration of Malware Protection for EC2 instances with findings.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnmalwareprotectionconfiguration.html#cfn-guardduty-detector-cfnmalwareprotectionconfiguration-scanec2instancewithfindings

CFNS3LogsConfigurationProperty

class CfnDetectorPropsMixin.CFNS3LogsConfigurationProperty(*, enable=None)

Bases: object

Describes whether S3 data event logs will be enabled as a data source when the detector is created.

Parameters:: enable (Union[bool, IResolvable, None]) – The status of S3 data event logs as a data source.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfns3logsconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

c_fNS3_logs_configuration_property = guardduty_mixins.CfnDetectorPropsMixin.CFNS3LogsConfigurationProperty(
    enable=False
)

Attributes

enable

The status of S3 data event logs as a data source.

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

CFNScanEc2InstanceWithFindingsConfigurationProperty

class CfnDetectorPropsMixin.CFNScanEc2InstanceWithFindingsConfigurationProperty(*, ebs_volumes=None)

Bases: object

Describes whether Malware Protection for EC2 instances with findings will be enabled as a data source.

Parameters:: ebs_volumes (Union[bool, IResolvable, None]) – Describes the configuration for scanning EBS volumes as data source.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnscanec2instancewithfindingsconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

c_fNScan_ec2_instance_with_findings_configuration_property = guardduty_mixins.CfnDetectorPropsMixin.CFNScanEc2InstanceWithFindingsConfigurationProperty(
    ebs_volumes=False
)

Attributes

ebs_volumes

Describes the configuration for scanning EBS volumes as data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnscanec2instancewithfindingsconfiguration.html#cfn-guardduty-detector-cfnscanec2instancewithfindingsconfiguration-ebsvolumes

TagItemProperty

class CfnDetectorPropsMixin.TagItemProperty(*, key=None, value=None)

Bases: object

Describes a tag.

Parameters:

key (Optional[str]) – The tag key.
value (Optional[str]) – The tag value.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

tag_item_property = guardduty_mixins.CfnDetectorPropsMixin.TagItemProperty(
    key="key",
    value="value"
)

Attributes

key

The tag key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-tagitem.html#cfn-guardduty-detector-tagitem-key

value

The tag value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-tagitem.html#cfn-guardduty-detector-tagitem-value