Package software.amazon.awscdk.services.iot

Class CfnScheduledAudit

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.iot.CfnScheduledAudit
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IScheduledAuditRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:38.188Z") @Stability(Stable) public class CfnScheduledAudit extends CfnResource implements IInspectable, IScheduledAuditRef, ITaggable
Use the AWS::IoT::ScheduledAudit resource to create a scheduled audit that is run at a specified time interval.

For API reference, see CreateScheduleAudit and for general information, see Audit .

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.iot.*;
 CfnScheduledAudit cfnScheduledAudit = CfnScheduledAudit.Builder.create(this, "MyCfnScheduledAudit")
         .frequency("frequency")
         .targetCheckNames(List.of("targetCheckNames"))
         // the properties below are optional
         .dayOfMonth("dayOfMonth")
         .dayOfWeek("dayOfWeek")
         .scheduledAuditName("scheduledAuditName")
         .tags(List.of(CfnTag.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

    • CfnScheduledAudit

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

    • CfnScheduledAudit

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

    • CfnScheduledAudit

      @Stability(Stable) public CfnScheduledAudit(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnScheduledAuditProps props)
      Create a new AWS::IoT::ScheduledAudit.

      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

    • arnForScheduledAudit

      @Stability(Stable) @NotNull public static String arnForScheduledAudit(@NotNull IScheduledAuditRef resource)
      Parameters:
      resource - This parameter is required.

    • fromScheduledAuditArn

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

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

    • fromScheduledAuditName

      @Stability(Stable) @NotNull public static IScheduledAuditRef fromScheduledAuditName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String scheduledAuditName)
      Creates a new IScheduledAuditRef from a scheduledAuditName.

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

    • isCfnScheduledAudit

      @Stability(Stable) @NotNull public static Boolean isCfnScheduledAudit(@NotNull Object x)
      Checks whether the given object is a CfnScheduledAudit.

      Parameters:
      x - 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.

    • getAttrScheduledAuditArn

      @Stability(Stable) @NotNull public String getAttrScheduledAuditArn()
      The ARN of the scheduled audit.

    • getCfnProperties

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

    • getScheduledAuditRef

      @Stability(Stable) @NotNull public ScheduledAuditReference getScheduledAuditRef()
      A reference to a ScheduledAudit resource.
      Specified by:
      getScheduledAuditRef in interface IScheduledAuditRef

    • getTags

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

    • getFrequency

      @Stability(Stable) @NotNull public String getFrequency()
      How often the scheduled audit occurs.

    • setFrequency

      @Stability(Stable) public void setFrequency(@NotNull String value)
      How often the scheduled audit occurs.

    • getTargetCheckNames

      @Stability(Stable) @NotNull public List<String> getTargetCheckNames()
      Which checks are performed during the scheduled audit.

    • setTargetCheckNames

      @Stability(Stable) public void setTargetCheckNames(@NotNull List<String> value)
      Which checks are performed during the scheduled audit.

    • getDayOfMonth

      @Stability(Stable) @Nullable public String getDayOfMonth()
      The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY").

    • setDayOfMonth

      @Stability(Stable) public void setDayOfMonth(@Nullable String value)
      The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY").

    • getDayOfWeek

      @Stability(Stable) @Nullable public String getDayOfWeek()
      The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").

    • setDayOfWeek

      @Stability(Stable) public void setDayOfWeek(@Nullable String value)
      The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").

    • getScheduledAuditName

      @Stability(Stable) @Nullable public String getScheduledAuditName()
      The name of the scheduled audit.

    • setScheduledAuditName

      @Stability(Stable) public void setScheduledAuditName(@Nullable String value)
      The name of the scheduled audit.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Metadata that can be used to manage the scheduled audit.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Metadata that can be used to manage the scheduled audit.