1. Packages
  2. Packages
  3. Pulumi Cloud (Pulumi Service provider)
  4. API Docs
  5. api
  6. api/insights
  7. ScheduledScanSettings

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
pulumiservice logo

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi

    Updates the scheduled scan configuration for an Insights account, such as scan frequency and schedule.

    Create ScheduledScanSettings Resource

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

    Constructor syntax

    new ScheduledScanSettings(name: string, args: ScheduledScanSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def ScheduledScanSettings(resource_name: str,
                              args: ScheduledScanSettingsArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def ScheduledScanSettings(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              account_name: Optional[str] = None,
                              org_name: Optional[str] = None,
                              paused: Optional[bool] = None,
                              batch_size: Optional[int] = None,
                              list_concurrency: Optional[int] = None,
                              read_concurrency: Optional[int] = None,
                              read_timeout: Optional[str] = None,
                              schedule_cron: Optional[str] = None)
    func NewScheduledScanSettings(ctx *Context, name string, args ScheduledScanSettingsArgs, opts ...ResourceOption) (*ScheduledScanSettings, error)
    public ScheduledScanSettings(string name, ScheduledScanSettingsArgs args, CustomResourceOptions? opts = null)
    public ScheduledScanSettings(String name, ScheduledScanSettingsArgs args)
    public ScheduledScanSettings(String name, ScheduledScanSettingsArgs args, CustomResourceOptions options)
    
    type: pulumiservice:api/insights:ScheduledScanSettings
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "pulumiservice_api_insights_scheduledscansettings" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ScheduledScanSettingsArgs
    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 ScheduledScanSettingsArgs
    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 ScheduledScanSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduledScanSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduledScanSettingsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var scheduledScanSettingsResource = new PulumiService.Api.Insights.ScheduledScanSettings("scheduledScanSettingsResource", new()
    {
        AccountName = "string",
        OrgName = "string",
        Paused = false,
        BatchSize = 0,
        ListConcurrency = 0,
        ReadConcurrency = 0,
        ReadTimeout = "string",
        ScheduleCron = "string",
    });
    
    example, err := insights.NewScheduledScanSettings(ctx, "scheduledScanSettingsResource", &insights.ScheduledScanSettingsArgs{
    	AccountName:     pulumi.String("string"),
    	OrgName:         pulumi.String("string"),
    	Paused:          pulumi.Bool(false),
    	BatchSize:       pulumi.Int(0),
    	ListConcurrency: pulumi.Int(0),
    	ReadConcurrency: pulumi.Int(0),
    	ReadTimeout:     pulumi.String("string"),
    	ScheduleCron:    pulumi.String("string"),
    })
    
    resource "pulumiservice_api_insights_scheduledscansettings" "scheduledScanSettingsResource" {
      account_name     = "string"
      org_name         = "string"
      paused           = false
      batch_size       = 0
      list_concurrency = 0
      read_concurrency = 0
      read_timeout     = "string"
      schedule_cron    = "string"
    }
    
    var scheduledScanSettingsResource = new ScheduledScanSettings("scheduledScanSettingsResource", ScheduledScanSettingsArgs.builder()
        .accountName("string")
        .orgName("string")
        .paused(false)
        .batchSize(0)
        .listConcurrency(0)
        .readConcurrency(0)
        .readTimeout("string")
        .scheduleCron("string")
        .build());
    
    scheduled_scan_settings_resource = pulumiservice.api.insights.ScheduledScanSettings("scheduledScanSettingsResource",
        account_name="string",
        org_name="string",
        paused=False,
        batch_size=0,
        list_concurrency=0,
        read_concurrency=0,
        read_timeout="string",
        schedule_cron="string")
    
    const scheduledScanSettingsResource = new pulumiservice.api.insights.ScheduledScanSettings("scheduledScanSettingsResource", {
        accountName: "string",
        orgName: "string",
        paused: false,
        batchSize: 0,
        listConcurrency: 0,
        readConcurrency: 0,
        readTimeout: "string",
        scheduleCron: "string",
    });
    
    type: pulumiservice:api/insights:ScheduledScanSettings
    properties:
        accountName: string
        batchSize: 0
        listConcurrency: 0
        orgName: string
        paused: false
        readConcurrency: 0
        readTimeout: string
        scheduleCron: string
    

    ScheduledScanSettings Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ScheduledScanSettings resource accepts the following input properties:

    AccountName string
    The Insights account name
    OrgName string
    The organization name
    Paused bool
    Whether the scheduled scan is paused.
    BatchSize int
    The batch size for processing resources during the scan.
    ListConcurrency int
    The concurrency level for list operations during the scan.
    ReadConcurrency int
    The concurrency level for read operations during the scan.
    ReadTimeout string
    The timeout duration for read operations, as a Go duration string (e.g., '30s', '5m').
    ScheduleCron string
    The cron expression defining the scan schedule.
    AccountName string
    The Insights account name
    OrgName string
    The organization name
    Paused bool
    Whether the scheduled scan is paused.
    BatchSize int
    The batch size for processing resources during the scan.
    ListConcurrency int
    The concurrency level for list operations during the scan.
    ReadConcurrency int
    The concurrency level for read operations during the scan.
    ReadTimeout string
    The timeout duration for read operations, as a Go duration string (e.g., '30s', '5m').
    ScheduleCron string
    The cron expression defining the scan schedule.
    account_name string
    The Insights account name
    org_name string
    The organization name
    paused bool
    Whether the scheduled scan is paused.
    batch_size number
    The batch size for processing resources during the scan.
    list_concurrency number
    The concurrency level for list operations during the scan.
    read_concurrency number
    The concurrency level for read operations during the scan.
    read_timeout string
    The timeout duration for read operations, as a Go duration string (e.g., '30s', '5m').
    schedule_cron string
    The cron expression defining the scan schedule.
    accountName String
    The Insights account name
    orgName String
    The organization name
    paused Boolean
    Whether the scheduled scan is paused.
    batchSize Integer
    The batch size for processing resources during the scan.
    listConcurrency Integer
    The concurrency level for list operations during the scan.
    readConcurrency Integer
    The concurrency level for read operations during the scan.
    readTimeout String
    The timeout duration for read operations, as a Go duration string (e.g., '30s', '5m').
    scheduleCron String
    The cron expression defining the scan schedule.
    accountName string
    The Insights account name
    orgName string
    The organization name
    paused boolean
    Whether the scheduled scan is paused.
    batchSize number
    The batch size for processing resources during the scan.
    listConcurrency number
    The concurrency level for list operations during the scan.
    readConcurrency number
    The concurrency level for read operations during the scan.
    readTimeout string
    The timeout duration for read operations, as a Go duration string (e.g., '30s', '5m').
    scheduleCron string
    The cron expression defining the scan schedule.
    account_name str
    The Insights account name
    org_name str
    The organization name
    paused bool
    Whether the scheduled scan is paused.
    batch_size int
    The batch size for processing resources during the scan.
    list_concurrency int
    The concurrency level for list operations during the scan.
    read_concurrency int
    The concurrency level for read operations during the scan.
    read_timeout str
    The timeout duration for read operations, as a Go duration string (e.g., '30s', '5m').
    schedule_cron str
    The cron expression defining the scan schedule.
    accountName String
    The Insights account name
    orgName String
    The organization name
    paused Boolean
    Whether the scheduled scan is paused.
    batchSize Number
    The batch size for processing resources during the scan.
    listConcurrency Number
    The concurrency level for list operations during the scan.
    readConcurrency Number
    The concurrency level for read operations during the scan.
    readTimeout String
    The timeout duration for read operations, as a Go duration string (e.g., '30s', '5m').
    scheduleCron String
    The cron expression defining the scan schedule.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo

    This provider is currently in preview.

    Viewing docs for Pulumi Cloud v1.1.0
    published on Thursday, May 21, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial