Package software.amazon.awscdk.services.iot

Interface CfnScheduledAuditProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnScheduledAuditProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.599Z") @Stability(Stable) public interface CfnScheduledAuditProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnScheduledAudit.

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.*;
 CfnScheduledAuditProps cfnScheduledAuditProps = CfnScheduledAuditProps.builder()
         .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();

  • Method Details

    • getFrequency

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

    • getTargetCheckNames

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

      Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

      The following checks are currently aviable:

      • AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK
      • CA_CERTIFICATE_EXPIRING_CHECK
      • CA_CERTIFICATE_KEY_QUALITY_CHECK
      • CONFLICTING_CLIENT_IDS_CHECK
      • DEVICE_CERTIFICATE_EXPIRING_CHECK
      • DEVICE_CERTIFICATE_KEY_QUALITY_CHECK
      • DEVICE_CERTIFICATE_SHARED_CHECK
      • IOT_POLICY_OVERLY_PERMISSIVE_CHECK
      • IOT_ROLE_ALIAS_ALLOWS_ACCESS_TO_UNUSED_SERVICES_CHECK
      • IOT_ROLE_ALIAS_OVERLY_PERMISSIVE_CHECK
      • LOGGING_DISABLED_CHECK
      • REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK
      • REVOKED_DEVICE_CERTIFICATE_STILL_ACTIVE_CHECK
      • UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK

    • getDayOfMonth

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

      If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.

    • getDayOfWeek

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

    • getScheduledAuditName

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

    • getTags

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

    • builder

      @Stability(Stable) static CfnScheduledAuditProps.Builder builder()
      Returns:
      a CfnScheduledAuditProps.Builder of CfnScheduledAuditProps