scheduled_audits

Creates, updates, deletes or gets a scheduled_audit resource or lists scheduled_audits in a region

Overview

Name	scheduled_audits
Type	Resource
Description	Scheduled audits can be used to specify the checks you want to perform during an audit and how often the audit should be run.
Id	aws.iot.scheduled_audits

Fields

Name	Datatype	Description
scheduled_audit_name	string	The name you want to give to the scheduled audit.
frequency	string	How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
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.
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.
target_check_names	array	Which checks are performed during the scheduled audit. Checks must be enabled for your account.
scheduled_audit_arn	string	The ARN (Amazon resource name) of the scheduled audit.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Frequency, TargetCheckNames, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all scheduled_audits in a region.

SELECT
region,
scheduled_audit_name,
frequency,
day_of_month,
day_of_week,
target_check_names,
scheduled_audit_arn,
tags
FROM aws.iot.scheduled_audits
WHERE region = 'us-east-1';

Gets all properties from an individual scheduled_audit.

SELECT
region,
scheduled_audit_name,
frequency,
day_of_month,
day_of_week,
target_check_names,
scheduled_audit_arn,
tags
FROM aws.iot.scheduled_audits
WHERE region = 'us-east-1' AND data__Identifier = '<ScheduledAuditName>';

INSERT example

Use the following StackQL query and manifest file to create a new scheduled_audit resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.iot.scheduled_audits (
 Frequency,
 TargetCheckNames,
 region
)
SELECT 
'{{ Frequency }}',
 '{{ TargetCheckNames }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iot.scheduled_audits (
 ScheduledAuditName,
 Frequency,
 DayOfMonth,
 DayOfWeek,
 TargetCheckNames,
 Tags,
 region
)
SELECT 
 '{{ ScheduledAuditName }}',
 '{{ Frequency }}',
 '{{ DayOfMonth }}',
 '{{ DayOfWeek }}',
 '{{ TargetCheckNames }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: scheduled_audit
    props:
      - name: ScheduledAuditName
        value: '{{ ScheduledAuditName }}'
      - name: Frequency
        value: '{{ Frequency }}'
      - name: DayOfMonth
        value: '{{ DayOfMonth }}'
      - name: DayOfWeek
        value: '{{ DayOfWeek }}'
      - name: TargetCheckNames
        value:
          - '{{ TargetCheckNames[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iot.scheduled_audits
WHERE data__Identifier = '<ScheduledAuditName>'
AND region = 'us-east-1';

Permissions

To operate on the scheduled_audits resource, the following permissions are required:

Create

iot:CreateScheduledAudit,
iot:DescribeScheduledAudit,
iot:TagResource

Read

iot:DescribeScheduledAudit,
iot:ListTagsForResource

Update

iot:UpdateScheduledAudit,
iot:ListTagsForResource,
iot:UntagResource,
iot:TagResource

Delete

iot:DescribeScheduledAudit,
iot:DeleteScheduledAudit

List

iot:ListScheduledAudits