Package software.amazon.awscdk.services.guardduty

Class CfnMalwareProtectionPlan

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.guardduty.CfnMalwareProtectionPlan
All Implemented Interfaces:
IInspectable, ITaggableV2, IMalwareProtectionPlanRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:39.698Z") @Stability(Stable) public class CfnMalwareProtectionPlan extends CfnResource implements IInspectable, IMalwareProtectionPlanRef, ITaggableV2
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.guardduty.*;
 CfnMalwareProtectionPlan cfnMalwareProtectionPlan = CfnMalwareProtectionPlan.Builder.create(this, "MyCfnMalwareProtectionPlan")
         .protectedResource(CFNProtectedResourceProperty.builder()
                 .s3Bucket(S3BucketProperty.builder()
                         .bucketName("bucketName")
                         .objectPrefixes(List.of("objectPrefixes"))
                         .build())
                 .build())
         .role("role")
         // the properties below are optional
         .actions(CFNActionsProperty.builder()
                 .tagging(CFNTaggingProperty.builder()
                         .status("status")
                         .build())
                 .build())
         .tags(List.of(TagItemProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMalwareProtectionPlan

      protected CfnMalwareProtectionPlan(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMalwareProtectionPlan

      protected CfnMalwareProtectionPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMalwareProtectionPlan

      @Stability(Stable) public CfnMalwareProtectionPlan(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMalwareProtectionPlanProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromMalwareProtectionPlanArn

      @Stability(Stable) @NotNull public static IMalwareProtectionPlanRef fromMalwareProtectionPlanArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IMalwareProtectionPlanRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromMalwareProtectionPlanId

      @Stability(Stable) @NotNull public static IMalwareProtectionPlanRef fromMalwareProtectionPlanId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String malwareProtectionPlanId)
      Creates a new IMalwareProtectionPlanRef from a malwareProtectionPlanId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      malwareProtectionPlanId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Amazon Resource Name (ARN) associated with this Malware Protection plan.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the Malware Protection plan resource was created.

    • getAttrMalwareProtectionPlanId

      @Stability(Stable) @NotNull public String getAttrMalwareProtectionPlanId()
      A unique identifier associated with Malware Protection plan.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Status of the Malware Protection plan resource.

    • getAttrStatusReasons

      @Stability(Stable) @NotNull public IResolvable getAttrStatusReasons()
      Status details associated with the Malware Protection plan resource status.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getMalwareProtectionPlanRef

      @Stability(Stable) @NotNull public MalwareProtectionPlanReference getMalwareProtectionPlanRef()
      A reference to a MalwareProtectionPlan resource.
      Specified by:
      getMalwareProtectionPlanRef in interface IMalwareProtectionPlanRef

    • getProtectedResource

      @Stability(Stable) @NotNull public Object getProtectedResource()
      Information about the protected resource.

      Returns union: either IResolvable or CfnMalwareProtectionPlan.CFNProtectedResourceProperty

    • setProtectedResource

      @Stability(Stable) public void setProtectedResource(@NotNull IResolvable value)
      Information about the protected resource.

    • setProtectedResource

      @Stability(Stable) public void setProtectedResource(@NotNull CfnMalwareProtectionPlan.CFNProtectedResourceProperty value)
      Information about the protected resource.

    • getRole

      @Stability(Stable) @NotNull public String getRole()
      Amazon Resource Name (ARN) of the IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource.

    • setRole

      @Stability(Stable) public void setRole(@NotNull String value)
      Amazon Resource Name (ARN) of the IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource.

    • getActions

      @Stability(Stable) @Nullable public Object getActions()
      Specifies the action that is to be applied to the Malware Protection plan resource.

      Returns union: either IResolvable or CfnMalwareProtectionPlan.CFNActionsProperty

    • setActions

      @Stability(Stable) public void setActions(@Nullable IResolvable value)
      Specifies the action that is to be applied to the Malware Protection plan resource.

    • setActions

      @Stability(Stable) public void setActions(@Nullable CfnMalwareProtectionPlan.CFNActionsProperty value)
      Specifies the action that is to be applied to the Malware Protection plan resource.

    • getTags

      @Stability(Stable) @Nullable public List<CfnMalwareProtectionPlan.TagItemProperty> getTags()
      The tags to be added to the created Malware Protection plan resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnMalwareProtectionPlan.TagItemProperty> value)
      The tags to be added to the created Malware Protection plan resource.