Class: Aws::IoT::Types::CreateScheduledAuditRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::CreateScheduledAuditRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass CreateScheduledAuditRequest data as a 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",
    },
  ],
}

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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, either `SUN`, `MON`, `TUE`, `WED`, `THU`, `FRI`, or `SAT`.

• #frequency ⇒ String

  How often the scheduled audit takes place, either `DAILY`, `WEEKLY`, `BIWEEKLY` or `MONTHLY`.

• #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. This can be “1” through “31” or “LAST”. This field is required if the “frequency” parameter is set to `MONTHLY`. If days 29 to 31 are specified, and the month doesn't have that many days, the audit takes place on the `LAST` day of the month.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 4752

class CreateScheduledAuditRequest < Struct.new(
  :frequency,
  :day_of_month,
  :day_of_week,
  :target_check_names,
  :scheduled_audit_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#day_of_week ⇒ String

The day of the week on which the scheduled audit takes place, either `SUN`, `MON`, `TUE`, `WED`, `THU`, `FRI`, or `SAT`. This field is required if the `frequency` parameter is set to `WEEKLY` or `BIWEEKLY`.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 4752

class CreateScheduledAuditRequest < Struct.new(
  :frequency,
  :day_of_month,
  :day_of_week,
  :target_check_names,
  :scheduled_audit_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#frequency ⇒ String

How often the scheduled audit takes place, either `DAILY`, `WEEKLY`, `BIWEEKLY` or `MONTHLY`. The start time of each audit is determined by the system.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 4752

class CreateScheduledAuditRequest < Struct.new(
  :frequency,
  :day_of_month,
  :day_of_week,
  :target_check_names,
  :scheduled_audit_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_audit_name ⇒ String

The name you want to give to the scheduled audit. (Max. 128 chars)

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 4752

class CreateScheduledAuditRequest < Struct.new(
  :frequency,
  :day_of_month,
  :day_of_week,
  :target_check_names,
  :scheduled_audit_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Metadata that can be used to manage the scheduled audit.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-iot/types.rb', line 4752

class CreateScheduledAuditRequest < Struct.new(
  :frequency,
  :day_of_month,
  :day_of_week,
  :target_check_names,
  :scheduled_audit_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-iot/types.rb', line 4752

class CreateScheduledAuditRequest < Struct.new(
  :frequency,
  :day_of_month,
  :day_of_week,
  :target_check_names,
  :scheduled_audit_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end