CfnDetector

class aws_cdk.aws_guardduty.CfnDetector(scope, id, *, enable, data_sources=None, features=None, finding_publishing_frequency=None, tags=None)

Bases: CfnResource

A CloudFormation AWS::GuardDuty::Detector.

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

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 = guardduty.CfnDetector(self, "MyCfnDetector",
    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"
    )]
)

Create a new AWS::GuardDuty::Detector.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
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 .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::GuardDuty::Detector'

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

CFNDataSourceConfigurationsProperty

class CfnDetector.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.

Link:

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.
import aws_cdk.aws_guardduty as guardduty

c_fNData_source_configurations_property = 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
    )
)

Attributes

kubernetes

Describes which Kubernetes data sources are enabled for a detector.

Link:: 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.

Link:: 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.

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

CFNKubernetesAuditLogsConfigurationProperty

class CfnDetector.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.
Link:: 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.
import aws_cdk.aws_guardduty as guardduty

c_fNKubernetes_audit_logs_configuration_property = guardduty.CfnDetector.CFNKubernetesAuditLogsConfigurationProperty(
    enable=False
)

Attributes

enable

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

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

CFNKubernetesConfigurationProperty

class CfnDetector.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.
Link:: 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.
import aws_cdk.aws_guardduty as guardduty

c_fNKubernetes_configuration_property = guardduty.CfnDetector.CFNKubernetesConfigurationProperty(
    audit_logs=guardduty.CfnDetector.CFNKubernetesAuditLogsConfigurationProperty(
        enable=False
    )
)

Attributes

audit_logs

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

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

CFNMalwareProtectionConfigurationProperty

class CfnDetector.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.
Link:: 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.
import aws_cdk.aws_guardduty as guardduty

c_fNMalware_protection_configuration_property = guardduty.CfnDetector.CFNMalwareProtectionConfigurationProperty(
    scan_ec2_instance_with_findings=guardduty.CfnDetector.CFNScanEc2InstanceWithFindingsConfigurationProperty(
        ebs_volumes=False
    )
)

Attributes

scan_ec2_instance_with_findings

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

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

CFNS3LogsConfigurationProperty

class CfnDetector.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.
Link:: 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.
import aws_cdk.aws_guardduty as guardduty

c_fNS3_logs_configuration_property = guardduty.CfnDetector.CFNS3LogsConfigurationProperty(
    enable=False
)

Attributes

enable

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

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

CFNScanEc2InstanceWithFindingsConfigurationProperty

class CfnDetector.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.
Link:: 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.
import aws_cdk.aws_guardduty as guardduty

c_fNScan_ec2_instance_with_findings_configuration_property = guardduty.CfnDetector.CFNScanEc2InstanceWithFindingsConfigurationProperty(
    ebs_volumes=False
)

Attributes

ebs_volumes

Describes the configuration for scanning EBS volumes as data source.

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

FeatureAdditionalConfigurationProperty

class CfnDetector.FeatureAdditionalConfigurationProperty(*, name=None, status=None)

Bases: object

Describes the additional configuration for a feature.

If you want to specify any additional configuration for your feature, it is required to provide the Name and Status for that additional configuration. For more information, see DetectorAdditionalConfiguration .

If you’re providing additional configuration, ensure to provide the corresponding FeatureConfigurations .

Parameters:

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-featureadditionalconfiguration.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

feature_additional_configuration_property = guardduty.CfnDetector.FeatureAdditionalConfigurationProperty(
    name="name",
    status="status"
)

Attributes

name

Name of the additional configuration of a feature.

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

status

Status of the additional configuration of a feature.

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

FeatureConfigurationsProperty

class CfnDetector.FeatureConfigurationsProperty(*, additional_configuration=None, name=None, status=None)

Bases: object

Describes the configuration for a feature.

Although the Required field associated with the following properties specifies No , if you provide information for Name , you will need to provide the information for Status too. For information about the available feature configurations, see DetectorFeatureConfiguration .

Parameters:

additional_configuration (Union[IResolvable, Sequence[Union[IResolvable, FeatureAdditionalConfigurationProperty, Dict[str, Any]]], None]) – Additional configuration of the feature.
name (Optional[str]) – Name of the feature.
status (Optional[str]) – Status of the feature.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-featureconfigurations.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

feature_configurations_property = guardduty.CfnDetector.FeatureConfigurationsProperty(
    additional_configuration=[guardduty.CfnDetector.FeatureAdditionalConfigurationProperty(
        name="name",
        status="status"
    )],
    name="name",
    status="status"
)

Attributes

additional_configuration

Additional configuration of the feature.

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

name

Name of the feature.

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

status

Status of the feature.

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