software.amazon.awscdk.services.iot

Class CfnScheduledAudit

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.iot.CfnScheduledAudit

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.843Z")
public class CfnScheduledAudit
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoT::ScheduledAudit`.

Use the AWS::IoT::ScheduledAudit resource to create a scheduled audit that is run at a specified time interval. For API reference, see CreateScheduleAudit and for general information, see Audit .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 CfnScheduledAudit cfnScheduledAudit = CfnScheduledAudit.Builder.create(this, "MyCfnScheduledAudit")
         .frequency("frequency")
         .targetCheckNames(List.of("targetCheckNames"))
         // the properties below are optional
         .dayOfMonth("dayOfMonth")
         .dayOfWeek("dayOfWeek")
         .scheduledAuditName("scheduledAuditName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnScheduledAudit.Builder A fluent builder for CfnScheduledAudit.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnScheduledAudit(Construct scope, java.lang.String id, CfnScheduledAuditProps props) Create a new `AWS::IoT::ScheduledAudit`.
protected	CfnScheduledAudit(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnScheduledAudit(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrScheduledAuditArn() The ARN of the scheduled audit.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDayOfMonth() The day of the month on which the scheduled audit is run (if the `frequency` is "MONTHLY").
java.lang.String	getDayOfWeek() The day of the week on which the scheduled audit is run (if the `frequency` is "WEEKLY" or "BIWEEKLY").
java.lang.String	getFrequency() How often the scheduled audit occurs.
java.lang.String	getScheduledAuditName() The name of the scheduled audit.
TagManager	getTags() Metadata that can be used to manage the scheduled audit.
java.util.List<java.lang.String>	getTargetCheckNames() Which checks are performed during the scheduled audit.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDayOfMonth(java.lang.String value) The day of the month on which the scheduled audit is run (if the `frequency` is "MONTHLY").
void	setDayOfWeek(java.lang.String value) The day of the week on which the scheduled audit is run (if the `frequency` is "WEEKLY" or "BIWEEKLY").
void	setFrequency(java.lang.String value) How often the scheduled audit occurs.
void	setScheduledAuditName(java.lang.String value) The name of the scheduled audit.
void	setTargetCheckNames(java.util.List<java.lang.String> value) Which checks are performed during the scheduled audit.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnScheduledAudit

protected CfnScheduledAudit(software.amazon.jsii.JsiiObjectRef objRef)

CfnScheduledAudit

protected CfnScheduledAudit(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnScheduledAudit

public CfnScheduledAudit(Construct scope,
                         java.lang.String id,
                         CfnScheduledAuditProps props)

Create a new `AWS::IoT::ScheduledAudit`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrScheduledAuditArn

public java.lang.String getAttrScheduledAuditArn()

The ARN of the scheduled audit.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Metadata that can be used to manage the scheduled audit.

getFrequency

public java.lang.String getFrequency()

How often the scheduled audit occurs.

setFrequency

public void setFrequency(java.lang.String value)

How often the scheduled audit occurs.

getTargetCheckNames

public java.util.List<java.lang.String> getTargetCheckNames()

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

setTargetCheckNames

public void setTargetCheckNames(java.util.List<java.lang.String> value)

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

getDayOfMonth

public java.lang.String getDayOfMonth()

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.

setDayOfMonth

public void setDayOfMonth(java.lang.String value)

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.

getDayOfWeek

public java.lang.String getDayOfWeek()

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

setDayOfWeek

public void setDayOfWeek(java.lang.String value)

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

getScheduledAuditName

public java.lang.String getScheduledAuditName()

The name of the scheduled audit.

setScheduledAuditName

public void setScheduledAuditName(java.lang.String value)

The name of the scheduled audit.