Experimental
@aws-cdk/aws-iot-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
Frequency Enum
The frequency at which the scheduled audit takes place.
| Stability | Experimental |
|---|---|
| Source | lib/scheduled-audit.ts |
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,
],
});
python
# config: iot.AccountAuditConfiguration
# Daily audit
daily_audit = iot.ScheduledAudit(self, "DailyAudit",
account_audit_configuration=config,
frequency=iot.Frequency.DAILY,
audit_checks=[iot.AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK
]
)
# Weekly audit
weekly_audit = iot.ScheduledAudit(self, "WeeklyAudit",
account_audit_configuration=config,
frequency=iot.Frequency.WEEKLY,
day_of_week=iot.DayOfWeek.SUNDAY,
audit_checks=[iot.AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK
]
)
# Monthly audit
monthly_audit = iot.ScheduledAudit(self, "MonthlyAudit",
account_audit_configuration=config,
frequency=iot.Frequency.MONTHLY,
day_of_month=iot.DayOfMonth.of(1),
audit_checks=[iot.AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK
]
)
java
AccountAuditConfiguration config;
// Daily audit
ScheduledAudit dailyAudit = ScheduledAudit.Builder.create(this, "DailyAudit")
.accountAuditConfiguration(config)
.frequency(Frequency.DAILY)
.auditChecks(List.of(AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK))
.build();
// Weekly audit
ScheduledAudit weeklyAudit = ScheduledAudit.Builder.create(this, "WeeklyAudit")
.accountAuditConfiguration(config)
.frequency(Frequency.WEEKLY)
.dayOfWeek(DayOfWeek.SUNDAY)
.auditChecks(List.of(AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK))
.build();
// Monthly audit
ScheduledAudit monthlyAudit = ScheduledAudit.Builder.create(this, "MonthlyAudit")
.accountAuditConfiguration(config)
.frequency(Frequency.MONTHLY)
.dayOfMonth(DayOfMonth.of(1))
.auditChecks(List.of(AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK))
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.IoT.Alpha
AccountAuditConfiguration config;
// Daily audit
var dailyAudit = new ScheduledAudit(this, "DailyAudit", new ScheduledAuditProps {
AccountAuditConfiguration = config,
Frequency = Frequency.DAILY,
AuditChecks = new [] { AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK }
});
// Weekly audit
var weeklyAudit = new ScheduledAudit(this, "WeeklyAudit", new ScheduledAuditProps {
AccountAuditConfiguration = config,
Frequency = Frequency.WEEKLY,
DayOfWeek = DayOfWeek.SUNDAY,
AuditChecks = new [] { AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK }
});
// Monthly audit
var monthlyAudit = new ScheduledAudit(this, "MonthlyAudit", new ScheduledAuditProps {
AccountAuditConfiguration = config,
Frequency = Frequency.MONTHLY,
DayOfMonth = DayOfMonth.Of(1),
AuditChecks = new [] { AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkiotalpha/v2
var config AccountAuditConfiguration
// Daily audit
dailyAudit := iot.NewScheduledAudit(this, jsii.String("DailyAudit"), &ScheduledAuditProps{
AccountAuditConfiguration: config,
Frequency: iot.Frequency_DAILY,
AuditChecks: []AuditCheck{
iot.AuditCheck_AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK,
},
})
// Weekly audit
weeklyAudit := iot.NewScheduledAudit(this, jsii.String("WeeklyAudit"), &ScheduledAuditProps{
AccountAuditConfiguration: config,
Frequency: iot.Frequency_WEEKLY,
DayOfWeek: iot.DayOfWeek_SUNDAY,
AuditChecks: []AuditCheck{
iot.AuditCheck_CA_CERTIFICATE_EXPIRING_CHECK,
},
})
// Monthly audit
monthlyAudit := iot.NewScheduledAudit(this, jsii.String("MonthlyAudit"), &ScheduledAuditProps{
AccountAuditConfiguration: config,
Frequency: iot.Frequency_MONTHLY,
DayOfMonth: iot.DayOfMonth_Of(jsii.Number(1)),
AuditChecks: []AuditCheck{
iot.AuditCheck_CA_CERTIFICATE_KEY_QUALITY_CHECK,
},
})
Members
| Member | Description |
|---|---|
DAILY | Daily. |
WEEKLY | Weekly. |
BI_WEEKLY | Bi-weekly. |
MONTHLY | Monthly. |
Referenced by
ScheduledAuditProps.frequencyfrequencyfrequencyFrequencyFrequency