You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::CreateScheduledAuditRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::CreateScheduledAuditRequest
- Defined in:
- (unknown)
Overview
When passing CreateScheduledAuditRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
frequency: "DAILY", # required, accepts DAILY, WEEKLY, BIWEEKLY, MONTHLY
day_of_month: "DayOfMonth",
day_of_week: "SUN", # accepts SUN, MON, TUE, WED, THU, FRI, SAT
target_check_names: ["AuditCheckName"], # required
scheduled_audit_name: "ScheduledAuditName", # required
tags: [
{
key: "TagKey", # required
value: "TagValue",
},
],
}
Instance Attribute Summary collapse
-
#day_of_month ⇒ String
The day of the month on which the scheduled audit takes place.
-
#day_of_week ⇒ String
The day of the week on which the scheduled audit takes place.
-
#frequency ⇒ String
How often the scheduled audit takes place.
-
#scheduled_audit_name ⇒ String
The name you want to give to the scheduled audit.
-
#tags ⇒ Array<Types::Tag>
Metadata that can be used to manage the scheduled audit.
-
#target_check_names ⇒ Array<String>
Which checks are performed during the scheduled audit.
Instance Attribute Details
#day_of_month ⇒ String
The day of the month on which the scheduled audit takes place. Can be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is set to \"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 ⇒ String
The day of the week on which the scheduled audit takes place. Can be one of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\", or \"SAT\". This field is required if the \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".
Possible values:
- SUN
- MON
- TUE
- WED
- THU
- FRI
- SAT
#frequency ⇒ String
How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The start time of each audit is determined by the system.
Possible values:
- DAILY
- WEEKLY
- BIWEEKLY
- MONTHLY
#scheduled_audit_name ⇒ String
The name you want to give to the scheduled audit. (Max. 128 chars)
#tags ⇒ Array<Types::Tag>
Metadata that can be used to manage the scheduled audit.
#target_check_names ⇒ Array<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.)