1.204.0

interface CfnScheduledAuditProps

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnScheduledAuditProps
Javasoftware.amazon.awscdk.services.iot.CfnScheduledAuditProps
Pythonaws_cdk.aws_iot.CfnScheduledAuditProps
TypeScript @aws-cdk/aws-iot » CfnScheduledAuditProps

Properties for defining a CfnScheduledAudit.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iot from '@aws-cdk/aws-iot';
const cfnScheduledAuditProps: iot.CfnScheduledAuditProps = {
  frequency: 'frequency',
  targetCheckNames: ['targetCheckNames'],

  // the properties below are optional
  dayOfMonth: 'dayOfMonth',
  dayOfWeek: 'dayOfWeek',
  scheduledAuditName: 'scheduledAuditName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
frequencystringHow often the scheduled audit occurs.
targetCheckNamesstring[]Which checks are performed during the scheduled audit.
dayOfMonth?stringThe day of the month on which the scheduled audit is run (if the frequency is "MONTHLY").
dayOfWeek?stringThe day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").
scheduledAuditName?stringThe name of the scheduled audit.
tags?CfnTag[]Metadata that can be used to manage the scheduled audit.

frequency

Type: string

How often the scheduled audit occurs.

targetCheckNames

Type: string[]

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

dayOfMonth?

Type: string (optional)

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: string (optional)

The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").

scheduledAuditName?

Type: string (optional)

The name of the scheduled audit.

tags?

Type: CfnTag[] (optional)

Metadata that can be used to manage the scheduled audit.

← PreviousNext →