Class CfnScheduledAudit
A CloudFormation AWS::IoT::ScheduledAudit
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public class CfnScheduledAudit : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnScheduledAudit
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::IoT::ScheduledAudit
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-scheduledaudit.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var cfnScheduledAudit = new CfnScheduledAudit(this, "MyCfnScheduledAudit", new CfnScheduledAuditProps {
Frequency = "frequency",
TargetCheckNames = new [] { "targetCheckNames" },
// the properties below are optional
DayOfMonth = "dayOfMonth",
DayOfWeek = "dayOfWeek",
ScheduledAuditName = "scheduledAuditName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnScheduledAudit(Construct, String, ICfnScheduledAuditProps) | Create a new |
CfnScheduledAudit(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnScheduledAudit(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrScheduledAuditArn | The ARN of the scheduled audit. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DayOfMonth | The day of the month on which the scheduled audit is run (if the |
DayOfWeek | The day of the week on which the scheduled audit is run (if the |
Frequency | How often the scheduled audit occurs. |
ScheduledAuditName | The name of the scheduled audit. |
Tags | Metadata that can be used to manage the scheduled audit. |
TargetCheckNames | Which checks are performed during the scheduled audit. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnScheduledAudit(Construct, String, ICfnScheduledAuditProps)
Create a new AWS::IoT::ScheduledAudit
.
public CfnScheduledAudit(Construct scope, string id, ICfnScheduledAuditProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnScheduledAuditProps
- resource properties.
CfnScheduledAudit(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnScheduledAudit(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnScheduledAudit(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnScheduledAudit(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrScheduledAuditArn
The ARN of the scheduled audit.
public virtual string AttrScheduledAuditArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ScheduledAuditArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DayOfMonth
The day of the month on which the scheduled audit is run (if the frequency
is "MONTHLY").
public virtual string DayOfMonth { get; set; }
Property Value
System.String
Remarks
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.
DayOfWeek
The day of the week on which the scheduled audit is run (if the frequency
is "WEEKLY" or "BIWEEKLY").
public virtual string DayOfWeek { get; set; }
Property Value
System.String
Remarks
Frequency
How often the scheduled audit occurs.
public virtual string Frequency { get; set; }
Property Value
System.String
Remarks
ScheduledAuditName
The name of the scheduled audit.
public virtual string ScheduledAuditName { get; set; }
Property Value
System.String
Remarks
Tags
Metadata that can be used to manage the scheduled audit.
public virtual TagManager Tags { get; }
Property Value
Remarks
TargetCheckNames
Which checks are performed during the scheduled audit.
public virtual string[] TargetCheckNames { get; set; }
Property Value
System.String[]
Remarks
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:
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>