interface ScheduledAuditProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IoT.Alpha.ScheduledAuditProps |
![]() | github.com/aws/aws-cdk-go/awscdkiotalpha/v2#ScheduledAuditProps |
![]() | software.amazon.awscdk.services.iot.alpha.ScheduledAuditProps |
![]() | aws_cdk.aws_iot_alpha.ScheduledAuditProps |
![]() | @aws-cdk/aws-iot-alpha ยป ScheduledAuditProps |
Properties for defining AWS IoT Scheduled Audit.
Example
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
Name | Type | Description |
---|---|---|
account | IAccount | Account audit configuration. |
audit | Audit [] | Which checks are performed during the scheduled audit. |
frequency | Frequency | How often the scheduled audit occurs. |
day | Day | The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY"). |
day | Day | The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY"). |
scheduled | string | The name of the scheduled audit. |
accountAuditConfiguration
Type:
IAccount
Account audit configuration.
The audit checks specified in auditChecks
must be enabled in this configuration.
auditChecks
Type:
Audit
[]
Which checks are performed during the scheduled audit.
Checks must be enabled for your account.
frequency
Type:
Frequency
How often the scheduled audit occurs.
dayOfMonth?
Type:
Day
(optional, default: required if frequency is "MONTHLY", not allowed otherwise)
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.
dayOfWeek?
Type:
Day
(optional, default: required if frequency is "WEEKLY" or "BIWEEKLY", not allowed otherwise)
The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").
scheduledAuditName?
Type:
string
(optional, default: auto generated name)
The name of the scheduled audit.