CfnMalwareProtectionPlanPropsMixin

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

Bases: Mixin

Creates a new Malware Protection plan for the protected resource.

When you create a Malware Protection plan, the AWS service terms for GuardDuty Malware Protection will apply.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-malwareprotectionplan.html
CloudformationResource:: AWS::GuardDuty::MalwareProtectionPlan
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_malware_protection_plan_props_mixin = guardduty_mixins.CfnMalwareProtectionPlanPropsMixin(guardduty_mixins.CfnMalwareProtectionPlanMixinProps(
    actions=guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.CFNActionsProperty(
        tagging=guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.CFNTaggingProperty(
            status="status"
        )
    ),
    protected_resource=guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.CFNProtectedResourceProperty(
        s3_bucket=guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.S3BucketProperty(
            bucket_name="bucketName",
            object_prefixes=["objectPrefixes"]
        )
    ),
    role="role",
    tags=[guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.TagItemProperty(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnMalwareProtectionPlanMixinProps, 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 = ['actions', 'protectedResource', 'role', '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

CFNActionsProperty

class CfnMalwareProtectionPlanPropsMixin.CFNActionsProperty(*, tagging=None)

Bases: object

Specifies the action that is to be applied to the Malware Protection plan resource.

Parameters:: tagging (Union[IResolvable, CFNTaggingProperty, Dict[str, Any], None]) – Contains information about tagging status of the Malware Protection plan resource.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnactions.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_fNActions_property = guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.CFNActionsProperty(
    tagging=guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.CFNTaggingProperty(
        status="status"
    )
)

Attributes

tagging

Contains information about tagging status of the Malware Protection plan resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnactions.html#cfn-guardduty-malwareprotectionplan-cfnactions-tagging

CFNProtectedResourceProperty

class CfnMalwareProtectionPlanPropsMixin.CFNProtectedResourceProperty(*, s3_bucket=None)

Bases: object

Information about the protected resource.

Presently, S3Bucket is the only supported protected resource.

Parameters:: s3_bucket (Union[IResolvable, S3BucketProperty, Dict[str, Any], None]) – Information about the protected S3 bucket resource.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnprotectedresource.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_fNProtected_resource_property = guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.CFNProtectedResourceProperty(
    s3_bucket=guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.S3BucketProperty(
        bucket_name="bucketName",
        object_prefixes=["objectPrefixes"]
    )
)

Attributes

s3_bucket

Information about the protected S3 bucket resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnprotectedresource.html#cfn-guardduty-malwareprotectionplan-cfnprotectedresource-s3bucket

CFNStatusReasonsProperty

class CfnMalwareProtectionPlanPropsMixin.CFNStatusReasonsProperty(*, code=None, message=None)

Bases: object

Information about the status code and status details associated with the status of the Malware Protection plan.

Parameters:

code (Optional[str]) – The status code of the Malware Protection plan. For more information, see Malware Protection plan resource status in the GuardDuty User Guide .
message (Optional[str]) – Issue message that specifies the reason. For information about potential troubleshooting steps, see Troubleshooting Malware Protection for S3 status issues in the Amazon GuardDuty User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnstatusreasons.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_fNStatus_reasons_property = guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.CFNStatusReasonsProperty(
    code="code",
    message="message"
)

Attributes

code

The status code of the Malware Protection plan.

For more information, see Malware Protection plan resource status in the GuardDuty User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnstatusreasons.html#cfn-guardduty-malwareprotectionplan-cfnstatusreasons-code

message

Issue message that specifies the reason.

For information about potential troubleshooting steps, see Troubleshooting Malware Protection for S3 status issues in the Amazon GuardDuty User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfnstatusreasons.html#cfn-guardduty-malwareprotectionplan-cfnstatusreasons-message

CFNTaggingProperty

class CfnMalwareProtectionPlanPropsMixin.CFNTaggingProperty(*, status=None)

Bases: object

Contains information about tagging status of the Malware Protection plan resource.

Parameters:: status (Optional[str]) – Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object. Potential values include ENABLED and DISABLED . These values are case-sensitive.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-cfntagging.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_fNTagging_property = guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.CFNTaggingProperty(
    status="status"
)

Attributes

status

Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object.

Potential values include ENABLED and DISABLED . These values are case-sensitive.

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

S3BucketProperty

class CfnMalwareProtectionPlanPropsMixin.S3BucketProperty(*, bucket_name=None, object_prefixes=None)

Bases: object

Information about the protected S3 bucket resource.

Parameters:

bucket_name (Optional[str]) – Name of the S3 bucket.
object_prefixes (Optional[Sequence[str]]) – Information about the specified object prefixes. An S3 object will be scanned only if it belongs to any of the specified object prefixes.

See:

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

s3_bucket_property = guardduty_mixins.CfnMalwareProtectionPlanPropsMixin.S3BucketProperty(
    bucket_name="bucketName",
    object_prefixes=["objectPrefixes"]
)

Attributes

bucket_name

Name of the S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-s3bucket.html#cfn-guardduty-malwareprotectionplan-s3bucket-bucketname

object_prefixes

Information about the specified object prefixes.

An S3 object will be scanned only if it belongs to any of the specified object prefixes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-malwareprotectionplan-s3bucket.html#cfn-guardduty-malwareprotectionplan-s3bucket-objectprefixes

TagItemProperty

class CfnMalwareProtectionPlanPropsMixin.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-malwareprotectionplan-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.CfnMalwareProtectionPlanPropsMixin.TagItemProperty(
    key="key",
    value="value"
)

Attributes

key

The tag key.

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

value

The tag value.

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