Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. iot
  5. ScheduledAudit

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.ScheduledAudit

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    Scheduled audits can be used to specify the checks you want to perform during an audit and how often the audit should be run.

    Create ScheduledAudit Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScheduledAudit(name: string, args: ScheduledAuditArgs, opts?: CustomResourceOptions);
    @overload
def ScheduledAudit(resource_name: str,
                   args: ScheduledAuditArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ScheduledAudit(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   frequency: Optional[ScheduledAuditFrequency] = None,
                   target_check_names: Optional[Sequence[str]] = None,
                   day_of_month: Optional[str] = None,
                   day_of_week: Optional[ScheduledAuditDayOfWeek] = None,
                   scheduled_audit_name: Optional[str] = None,
                   tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewScheduledAudit(ctx *Context, name string, args ScheduledAuditArgs, opts ...ResourceOption) (*ScheduledAudit, error)
    public ScheduledAudit(string name, ScheduledAuditArgs args, CustomResourceOptions? opts = null)
    public ScheduledAudit(String name, ScheduledAuditArgs args)
public ScheduledAudit(String name, ScheduledAuditArgs args, CustomResourceOptions options)

    type: aws-native:iot:ScheduledAudit
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ScheduledAuditArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScheduledAuditArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScheduledAuditArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduledAuditArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduledAuditArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const scheduledAuditResource = new aws_native.iot.ScheduledAudit("scheduledAuditResource", {
    frequency: aws_native.iot.ScheduledAuditFrequency.Daily,
    targetCheckNames: ["string"],
    dayOfMonth: "string",
    dayOfWeek: aws_native.iot.ScheduledAuditDayOfWeek.Sun,
    scheduledAuditName: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

    Coming soon!

    ScheduledAudit Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ScheduledAudit resource accepts the following input properties:

    Frequency Pulumi.AwsNative.IoT.ScheduledAuditFrequency
    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
    TargetCheckNames List<string>
    Which checks are performed during the scheduled audit. Checks must be enabled for your account.
    DayOfMonth 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.
    DayOfWeek Pulumi.AwsNative.IoT.ScheduledAuditDayOfWeek
    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.
    ScheduledAuditName string
    The name you want to give to the scheduled audit.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    Frequency ScheduledAuditFrequency
    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
    TargetCheckNames []string
    Which checks are performed during the scheduled audit. Checks must be enabled for your account.
    DayOfMonth 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.
    DayOfWeek ScheduledAuditDayOfWeek
    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.
    ScheduledAuditName string
    The name you want to give to the scheduled audit.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    frequency ScheduledAuditFrequency
    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
    targetCheckNames List<String>
    Which checks are performed during the scheduled audit. Checks must be enabled for your account.
    dayOfMonth 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.
    dayOfWeek ScheduledAuditDayOfWeek
    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.
    scheduledAuditName String
    The name you want to give to the scheduled audit.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    frequency ScheduledAuditFrequency
    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
    targetCheckNames string[]
    Which checks are performed during the scheduled audit. Checks must be enabled for your account.
    dayOfMonth 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.
    dayOfWeek ScheduledAuditDayOfWeek
    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.
    scheduledAuditName string
    The name you want to give to the scheduled audit.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    frequency ScheduledAuditFrequency
    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
    target_check_names Sequence[str]
    Which checks are performed during the scheduled audit. Checks must be enabled for your account.
    day_of_month str
    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 ScheduledAuditDayOfWeek
    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.
    scheduled_audit_name str
    The name you want to give to the scheduled audit.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    frequency "DAILY" | "WEEKLY" | "BIWEEKLY" | "MONTHLY"
    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.
    targetCheckNames List<String>
    Which checks are performed during the scheduled audit. Checks must be enabled for your account.
    dayOfMonth 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.
    dayOfWeek "SUN" | "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "UNSET_VALUE"
    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.
    scheduledAuditName String
    The name you want to give to the scheduled audit.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScheduledAudit resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ScheduledAuditArn string
    The ARN (Amazon resource name) of the scheduled audit.
    Id string
    The provider-assigned unique ID for this managed resource.
    ScheduledAuditArn string
    The ARN (Amazon resource name) of the scheduled audit.
    id String
    The provider-assigned unique ID for this managed resource.
    scheduledAuditArn String
    The ARN (Amazon resource name) of the scheduled audit.
    id string
    The provider-assigned unique ID for this managed resource.
    scheduledAuditArn string
    The ARN (Amazon resource name) of the scheduled audit.
    id str
    The provider-assigned unique ID for this managed resource.
    scheduled_audit_arn str
    The ARN (Amazon resource name) of the scheduled audit.
    id String
    The provider-assigned unique ID for this managed resource.
    scheduledAuditArn String
    The ARN (Amazon resource name) of the scheduled audit.

    Supporting Types

    ScheduledAuditDayOfWeek, ScheduledAuditDayOfWeekArgs

    Sun
    SUN
    Mon
    MON
    Tue
    TUE
    Wed
    WED
    Thu
    THU
    Fri
    FRI
    Sat
    SAT
    UnsetValue
    UNSET_VALUE
    ScheduledAuditDayOfWeekSun
    SUN
    ScheduledAuditDayOfWeekMon
    MON
    ScheduledAuditDayOfWeekTue
    TUE
    ScheduledAuditDayOfWeekWed
    WED
    ScheduledAuditDayOfWeekThu
    THU
    ScheduledAuditDayOfWeekFri
    FRI
    ScheduledAuditDayOfWeekSat
    SAT
    ScheduledAuditDayOfWeekUnsetValue
    UNSET_VALUE
    Sun
    SUN
    Mon
    MON
    Tue
    TUE
    Wed
    WED
    Thu
    THU
    Fri
    FRI
    Sat
    SAT
    UnsetValue
    UNSET_VALUE
    Sun
    SUN
    Mon
    MON
    Tue
    TUE
    Wed
    WED
    Thu
    THU
    Fri
    FRI
    Sat
    SAT
    UnsetValue
    UNSET_VALUE
    SUN
    SUN
    MON
    MON
    TUE
    TUE
    WED
    WED
    THU
    THU
    FRI
    FRI
    SAT
    SAT
    UNSET_VALUE
    UNSET_VALUE
    "SUN"
    SUN
    "MON"
    MON
    "TUE"
    TUE
    "WED"
    WED
    "THU"
    THU
    "FRI"
    FRI
    "SAT"
    SAT
    "UNSET_VALUE"
    UNSET_VALUE

    ScheduledAuditFrequency, ScheduledAuditFrequencyArgs

    Daily
    DAILY
    Weekly
    WEEKLY
    Biweekly
    BIWEEKLY
    Monthly
    MONTHLY
    ScheduledAuditFrequencyDaily
    DAILY
    ScheduledAuditFrequencyWeekly
    WEEKLY
    ScheduledAuditFrequencyBiweekly
    BIWEEKLY
    ScheduledAuditFrequencyMonthly
    MONTHLY
    Daily
    DAILY
    Weekly
    WEEKLY
    Biweekly
    BIWEEKLY
    Monthly
    MONTHLY
    Daily
    DAILY
    Weekly
    WEEKLY
    Biweekly
    BIWEEKLY
    Monthly
    MONTHLY
    DAILY
    DAILY
    WEEKLY
    WEEKLY
    BIWEEKLY
    BIWEEKLY
    MONTHLY
    MONTHLY
    "DAILY"
    DAILY
    "WEEKLY"
    WEEKLY
    "BIWEEKLY"
    BIWEEKLY
    "MONTHLY"
    MONTHLY

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native