Experimental
@aws-cdk/aws-iot-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ScheduledAuditProps Struct
Properties for defining AWS IoT Scheduled Audit.
Example
ts
declare const config: iot.AccountAuditConfiguration;
// Daily audit
const dailyAudit = new iot.ScheduledAudit(this, 'DailyAudit', {
accountAuditConfiguration: config,
frequency: iot.Frequency.DAILY,
auditChecks: [
iot.AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK,
],
})
// Weekly audit
const weeklyAudit = new iot.ScheduledAudit(this, 'WeeklyAudit', {
accountAuditConfiguration: config,
frequency: iot.Frequency.WEEKLY,
dayOfWeek: iot.DayOfWeek.SUNDAY,
auditChecks: [
iot.AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK,
],
});
// Monthly audit
const monthlyAudit = new iot.ScheduledAudit(this, 'MonthlyAudit', {
accountAuditConfiguration: config,
frequency: iot.Frequency.MONTHLY,
dayOfMonth: iot.DayOfMonth.of(1),
auditChecks: [
iot.AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK,
],
});
Properties
accountAuditConfigurationIAccountAuditConfigurationaccount_audit_configurationIAccountAuditConfigurationaccountAuditConfigurationIAccountAuditConfigurationAccountAuditConfigurationIAccountAuditConfigurationAccountAuditConfigurationIAccountAuditConfigurationrequired#Account audit configuration.
The audit checks specified in auditChecks must be enabled in this configuration.
auditChecksAuditCheck[]audit_checkstyping.List[AuditCheck]auditChecksList<AuditCheck>AuditChecksAuditCheck[]AuditChecks*[]AuditCheckrequired#Which checks are performed during the scheduled audit.
Checks must be enabled for your account.
dayOfMonthoptionalDayOfMonthday_of_monthoptionalDayOfMonthdayOfMonthoptionalDayOfMonthDayOfMonthoptionalDayOfMonthDayOfMonthoptionalDayOfMonth#The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY").
Default: required if frequency is "MONTHLY", not allowed otherwise
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.
dayOfWeekoptionalDayOfWeekday_of_weekoptionalDayOfWeekdayOfWeekoptionalDayOfWeekDayOfWeekoptionalDayOfWeekDayOfWeekoptionalDayOfWeek#The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").
Default: required if frequency is "WEEKLY" or "BIWEEKLY", not allowed otherwise
How often the scheduled audit occurs.
scheduledAuditNameoptionalstringscheduled_audit_nameoptionalstrscheduledAuditNameoptionalStringScheduledAuditNameoptionalstringScheduledAuditNameoptional*string#The name of the scheduled audit.
Default: auto generated name