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

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

AWS Native v0.90.0 published on Monday, Dec 4, 2023 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.getScheduledAudit

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.90.0 published on Monday, Dec 4, 2023 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.

    Using getScheduledAudit

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getScheduledAudit(args: GetScheduledAuditArgs, opts?: InvokeOptions): Promise<GetScheduledAuditResult>
function getScheduledAuditOutput(args: GetScheduledAuditOutputArgs, opts?: InvokeOptions): Output<GetScheduledAuditResult>
    def get_scheduled_audit(scheduled_audit_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetScheduledAuditResult
def get_scheduled_audit_output(scheduled_audit_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetScheduledAuditResult]
    func LookupScheduledAudit(ctx *Context, args *LookupScheduledAuditArgs, opts ...InvokeOption) (*LookupScheduledAuditResult, error)
func LookupScheduledAuditOutput(ctx *Context, args *LookupScheduledAuditOutputArgs, opts ...InvokeOption) LookupScheduledAuditResultOutput

    > Note: This function is named LookupScheduledAudit in the Go SDK.

    public static class GetScheduledAudit 
{
    public static Task<GetScheduledAuditResult> InvokeAsync(GetScheduledAuditArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduledAuditResult> Invoke(GetScheduledAuditInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetScheduledAuditResult> getScheduledAudit(GetScheduledAuditArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:iot:getScheduledAudit
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ScheduledAuditName string

    The name you want to give to the scheduled audit.

    ScheduledAuditName string

    The name you want to give to the scheduled audit.

    scheduledAuditName String

    The name you want to give to the scheduled audit.

    scheduledAuditName string

    The name you want to give to the scheduled audit.

    scheduled_audit_name str

    The name you want to give to the scheduled audit.

    scheduledAuditName String

    The name you want to give to the scheduled audit.

    getScheduledAudit Result

    The following output properties are available:

    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.

    Frequency Pulumi.AwsNative.IoT.ScheduledAuditFrequency

    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.

    ScheduledAuditArn string

    The ARN (Amazon resource name) of the scheduled audit.

    Tags List<Pulumi.AwsNative.IoT.Outputs.ScheduledAuditTag>

    An array of key-value pairs to apply to this resource.

    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.

    Frequency ScheduledAuditFrequency

    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.

    ScheduledAuditArn string

    The ARN (Amazon resource name) of the scheduled audit.

    Tags []ScheduledAuditTag

    An array of key-value pairs to apply to this resource.

    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.

    frequency ScheduledAuditFrequency

    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.

    scheduledAuditArn String

    The ARN (Amazon resource name) of the scheduled audit.

    tags List<ScheduledAuditTag>

    An array of key-value pairs to apply to this resource.

    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.

    frequency ScheduledAuditFrequency

    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.

    scheduledAuditArn string

    The ARN (Amazon resource name) of the scheduled audit.

    tags ScheduledAuditTag[]

    An array of key-value pairs to apply to this resource.

    targetCheckNames string[]

    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.

    frequency ScheduledAuditFrequency

    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.

    scheduled_audit_arn str

    The ARN (Amazon resource name) of the scheduled audit.

    tags Sequence[ScheduledAuditTag]

    An array of key-value pairs to apply to this resource.

    target_check_names Sequence[str]

    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.

    frequency "DAILY" | "WEEKLY" | "BIWEEKLY" | "MONTHLY"

    How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.

    scheduledAuditArn String

    The ARN (Amazon resource name) of the scheduled audit.

    tags List<Property Map>

    An array of key-value pairs to apply to this resource.

    targetCheckNames List<String>

    Which checks are performed during the scheduled audit. Checks must be enabled for your account.

    Supporting Types

    ScheduledAuditDayOfWeek

    ScheduledAuditFrequency

    ScheduledAuditTag

    Key string

    The tag's key.

    Value string

    The tag's value.

    Key string

    The tag's key.

    Value string

    The tag's value.

    key String

    The tag's key.

    value String

    The tag's value.

    key string

    The tag's key.

    value string

    The tag's value.

    key str

    The tag's key.

    value str

    The tag's value.

    key String

    The tag's key.

    value String

    The tag's value.

    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.90.0 published on Monday, Dec 4, 2023 by Pulumi
    pulumi/pulumi-aws-native