ScheduledAuditProps

class aws_cdk.aws_iot_alpha.ScheduledAuditProps(*, account_audit_configuration, audit_checks, frequency, day_of_month=None, day_of_week=None, scheduled_audit_name=None)

Bases: object

(experimental) Properties for defining AWS IoT Scheduled Audit.

Parameters:
  • account_audit_configuration (IAccountAuditConfiguration) – (experimental) Account audit configuration. The audit checks specified in auditChecks must be enabled in this configuration.

  • audit_checks (Sequence[AuditCheck]) – (experimental) Which checks are performed during the scheduled audit. Checks must be enabled for your account.

  • frequency (Frequency) – (experimental) How often the scheduled audit occurs.

  • day_of_month (Optional[DayOfMonth]) – (experimental) 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. Default: - required if frequency is “MONTHLY”, not allowed otherwise

  • day_of_week (Optional[DayOfWeek]) – (experimental) 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

  • scheduled_audit_name (Optional[str]) – (experimental) The name of the scheduled audit. Default: - auto generated name

Stability:

experimental

ExampleMetadata:

infused

Example:

# 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
    ]
)

Attributes

account_audit_configuration

(experimental) Account audit configuration.

The audit checks specified in auditChecks must be enabled in this configuration.

Stability:

experimental

audit_checks

(experimental) Which checks are performed during the scheduled audit.

Checks must be enabled for your account.

Stability:

experimental

day_of_month

(experimental) 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.

Default:
  • required if frequency is “MONTHLY”, not allowed otherwise

Stability:

experimental

day_of_week

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

Stability:

experimental

frequency

(experimental) How often the scheduled audit occurs.

Stability:

experimental

scheduled_audit_name

(experimental) The name of the scheduled audit.

Default:
  • auto generated name

Stability:

experimental