@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:36.843Z") public class CfnScheduledAudit extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnScheduledAudit.Builder
A fluent builder for
CfnScheduledAudit . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnScheduledAudit(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnScheduledAudit(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnScheduledAudit(Construct scope, java.lang.String id, CfnScheduledAuditProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrScheduledAuditArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getFrequency()
public void setFrequency(java.lang.String value)
public java.util.List<java.lang.String> getTargetCheckNames()
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
public void setTargetCheckNames(java.util.List<java.lang.String> value)
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
public java.lang.String getDayOfMonth()
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.
public void setDayOfMonth(java.lang.String value)
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.
public java.lang.String getDayOfWeek()
public void setDayOfWeek(java.lang.String value)
public java.lang.String getScheduledAuditName()
public void setScheduledAuditName(java.lang.String value)