CfnScheduledAuditProps

class aws_cdk.aws_iot.CfnScheduledAuditProps(*, frequency, target_check_names, day_of_month=None, day_of_week=None, scheduled_audit_name=None, tags=None)

Bases: object

Properties for defining a CfnScheduledAudit.

Parameters
  • frequency (str) – How often the scheduled audit occurs.

  • target_check_names (Sequence[str]) – 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

  • day_of_month (Optional[str]) – 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.

  • day_of_week (Optional[str]) – The day of the week on which the scheduled audit is run (if the frequency is “WEEKLY” or “BIWEEKLY”).

  • scheduled_audit_name (Optional[str]) – The name of the scheduled audit.

  • tags (Optional[Sequence[CfnTag]]) – Metadata that can be used to manage the scheduled audit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-scheduledaudit.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot as iot

cfn_scheduled_audit_props = iot.CfnScheduledAuditProps(
    frequency="frequency",
    target_check_names=["targetCheckNames"],

    # the properties below are optional
    day_of_month="dayOfMonth",
    day_of_week="dayOfWeek",
    scheduled_audit_name="scheduledAuditName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

day_of_month

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-scheduledaudit.html#cfn-iot-scheduledaudit-dayofmonth

Return type

Optional[str]

day_of_week

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-scheduledaudit.html#cfn-iot-scheduledaudit-dayofweek

Return type

Optional[str]

frequency

How often the scheduled audit occurs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-scheduledaudit.html#cfn-iot-scheduledaudit-frequency

Return type

str

scheduled_audit_name

The name of the scheduled audit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-scheduledaudit.html#cfn-iot-scheduledaudit-scheduledauditname

Return type

Optional[str]

tags

Metadata that can be used to manage the scheduled audit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-scheduledaudit.html#cfn-iot-scheduledaudit-tags

Return type

Optional[List[CfnTag]]

target_check_names

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-scheduledaudit.html#cfn-iot-scheduledaudit-targetchecknames

Return type

List[str]