Package software.amazon.awscdk.services.iot

Class CfnScheduledAudit

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iot.CfnScheduledAudit
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.597Z") @Stability(Stable) public class CfnScheduledAudit extends CfnResource implements IInspectable
A CloudFormation AWS::IoT::ScheduledAudit.

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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata that can be used to manage the scheduled audit.

    • 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.

      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

    • setTargetCheckNames

      @Stability(Stable) public void setTargetCheckNames(@NotNull List<String> value)
      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 public 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.

    • 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").

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