ScheduledAudit

class aws_cdk.aws_iot_alpha.ScheduledAudit(scope, id, *, account_audit_configuration, audit_checks, frequency, day_of_month=None, day_of_week=None, scheduled_audit_name=None)

Bases: Resource

(experimental) Defines AWS IoT Scheduled Audit.

Stability:: experimental
ExampleMetadata:: infused

Example:

# config: iot.AccountAuditConfiguration


# Daily audit
daily_audit = iot.ScheduledAudit(self, "DailyAudit",
    account_audit_configuration=config,
    frequency=iot.Frequency.DAILY,
    audit_checks=[iot.AuditCheck.AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK
    ]
)

# Weekly audit
weekly_audit = iot.ScheduledAudit(self, "WeeklyAudit",
    account_audit_configuration=config,
    frequency=iot.Frequency.WEEKLY,
    day_of_week=iot.DayOfWeek.SUNDAY,
    audit_checks=[iot.AuditCheck.CA_CERTIFICATE_EXPIRING_CHECK
    ]
)

# Monthly audit
monthly_audit = iot.ScheduledAudit(self, "MonthlyAudit",
    account_audit_configuration=config,
    frequency=iot.Frequency.MONTHLY,
    day_of_month=iot.DayOfMonth.of(1),
    audit_checks=[iot.AuditCheck.CA_CERTIFICATE_KEY_QUALITY_CHECK
    ]
)

Parameters:

scope (Construct) –
id (str) –
account_audit_configuration (IAccountAuditConfiguration) – (experimental) Account audit configuration. The audit checks specified in auditChecks must be enabled in this configuration.
audit_checks (Sequence[AuditCheck]) – (experimental) Which checks are performed during the scheduled audit. Checks must be enabled for your account.
frequency (Frequency) – (experimental) How often the scheduled audit occurs.
day_of_month (Optional[DayOfMonth]) – (experimental) 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. Default: - required if frequency is “MONTHLY”, not allowed otherwise
day_of_week (Optional[DayOfWeek]) – (experimental) The day of the week on which the scheduled audit is run (if the frequency is “WEEKLY” or “BIWEEKLY”). Default: - required if frequency is “WEEKLY” or “BIWEEKLY”, not allowed otherwise
scheduled_audit_name (Optional[str]) – (experimental) The name of the scheduled audit. Default: - auto generated name

Stability:

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The tree node.

scheduled_audit_arn

(experimental) The ARN of the scheduled audit.

Stability:: experimental
Attribute:: true

scheduled_audit_name

(experimental) The scheduled audit name.

Stability:: experimental
Attribute:: true

stack: The stack in which this resource is defined.

Static Methods

classmethod from_scheduled_audit_arn(scope, id, scheduled_audit_arn)

(experimental) Import an existing AWS IoT Scheduled Audit from its ARN.

Parameters:

scope (Construct) – The parent creating construct (usually this).
id (str) – The construct’s name.
scheduled_audit_arn (str) – The ARN of the scheduled audit.

Stability:

experimental

Return type:

IScheduledAudit

classmethod from_scheduled_audit_attributes(scope, id, *, scheduled_audit_arn, scheduled_audit_name)

(experimental) Import an existing AWS IoT Scheduled Audit from its attributes.

Parameters:

scope (Construct) – The parent creating construct (usually this).
id (str) – The construct’s name.
scheduled_audit_arn (str) – (experimental) The ARN of the scheduled audit.
scheduled_audit_name (str) – (experimental) The scheduled audit name.

Stability:

experimental

Return type:

IScheduledAudit

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool