1. Packages
  2. Packages
  3. Thoth
  4. API Docs
  5. mdm
  6. Sync
Viewing docs for Thoth v0.1.15
published on Thursday, Jul 23, 2026 by Aten Security
thoth logo
Viewing docs for Thoth v0.1.15
published on Thursday, Jul 23, 2026 by Aten Security

    Create Sync Resource

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

    Constructor syntax

    new Sync(name: string, args: SyncArgs, opts?: CustomResourceOptions);
    @overload
    def Sync(resource_name: str,
             args: SyncArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Sync(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             provider_name: Optional[str] = None,
             poll_interval_seconds: Optional[int] = None,
             timeout_seconds: Optional[int] = None,
             trigger: Optional[str] = None,
             wait_for_completion: Optional[bool] = None)
    func NewSync(ctx *Context, name string, args SyncArgs, opts ...ResourceOption) (*Sync, error)
    public Sync(string name, SyncArgs args, CustomResourceOptions? opts = null)
    public Sync(String name, SyncArgs args)
    public Sync(String name, SyncArgs args, CustomResourceOptions options)
    
    type: thoth:mdm:Sync
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "thoth_mdm_sync" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args SyncArgs
    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 SyncArgs
    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 SyncArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SyncArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SyncArgs
    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 syncResource = new Thoth.Mdm.Sync("syncResource", new()
    {
        ProviderName = "string",
        PollIntervalSeconds = 0,
        TimeoutSeconds = 0,
        Trigger = "string",
        WaitForCompletion = false,
    });
    
    example, err := mdm.NewSync(ctx, "syncResource", &mdm.SyncArgs{
    	ProviderName:        pulumi.String("string"),
    	PollIntervalSeconds: pulumi.Int(0),
    	TimeoutSeconds:      pulumi.Int(0),
    	Trigger:             pulumi.String("string"),
    	WaitForCompletion:   pulumi.Bool(false),
    })
    
    resource "thoth_mdm_sync" "syncResource" {
      lifecycle {
        create_before_destroy = true
      }
      provider_name         = "string"
      poll_interval_seconds = 0
      timeout_seconds       = 0
      trigger               = "string"
      wait_for_completion   = false
    }
    
    var syncResource = new Sync("syncResource", SyncArgs.builder()
        .providerName("string")
        .pollIntervalSeconds(0)
        .timeoutSeconds(0)
        .trigger("string")
        .waitForCompletion(false)
        .build());
    
    sync_resource = thoth.mdm.Sync("syncResource",
        provider_name="string",
        poll_interval_seconds=0,
        timeout_seconds=0,
        trigger="string",
        wait_for_completion=False)
    
    const syncResource = new thoth.mdm.Sync("syncResource", {
        providerName: "string",
        pollIntervalSeconds: 0,
        timeoutSeconds: 0,
        trigger: "string",
        waitForCompletion: false,
    });
    
    type: thoth:mdm:Sync
    properties:
        pollIntervalSeconds: 0
        providerName: string
        timeoutSeconds: 0
        trigger: string
        waitForCompletion: false
    

    Sync 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 Sync resource accepts the following input properties:

    ProviderName string
    MDM provider slug.
    PollIntervalSeconds int
    Polling interval when wait_for_completion=true.
    TimeoutSeconds int
    Polling timeout when wait_for_completion=true.
    Trigger string
    Arbitrary replacement trigger value.
    WaitForCompletion bool
    Wait for sync job completion before returning state.
    ProviderName string
    MDM provider slug.
    PollIntervalSeconds int
    Polling interval when wait_for_completion=true.
    TimeoutSeconds int
    Polling timeout when wait_for_completion=true.
    Trigger string
    Arbitrary replacement trigger value.
    WaitForCompletion bool
    Wait for sync job completion before returning state.
    provider_name string
    MDM provider slug.
    poll_interval_seconds number
    Polling interval when wait_for_completion=true.
    timeout_seconds number
    Polling timeout when wait_for_completion=true.
    trigger string
    Arbitrary replacement trigger value.
    wait_for_completion bool
    Wait for sync job completion before returning state.
    providerName String
    MDM provider slug.
    pollIntervalSeconds Integer
    Polling interval when wait_for_completion=true.
    timeoutSeconds Integer
    Polling timeout when wait_for_completion=true.
    trigger String
    Arbitrary replacement trigger value.
    waitForCompletion Boolean
    Wait for sync job completion before returning state.
    providerName string
    MDM provider slug.
    pollIntervalSeconds number
    Polling interval when wait_for_completion=true.
    timeoutSeconds number
    Polling timeout when wait_for_completion=true.
    trigger string
    Arbitrary replacement trigger value.
    waitForCompletion boolean
    Wait for sync job completion before returning state.
    provider_name str
    MDM provider slug.
    poll_interval_seconds int
    Polling interval when wait_for_completion=true.
    timeout_seconds int
    Polling timeout when wait_for_completion=true.
    trigger str
    Arbitrary replacement trigger value.
    wait_for_completion bool
    Wait for sync job completion before returning state.
    providerName String
    MDM provider slug.
    pollIntervalSeconds Number
    Polling interval when wait_for_completion=true.
    timeoutSeconds Number
    Polling timeout when wait_for_completion=true.
    trigger String
    Arbitrary replacement trigger value.
    waitForCompletion Boolean
    Wait for sync job completion before returning state.

    Outputs

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

    CompletedAt string
    Job completion timestamp.
    CreatedAt string
    Job creation timestamp.
    Error string
    Job error string when status=failed.
    Id string
    The provider-assigned unique ID for this managed resource.
    StartedAt string
    Job start timestamp.
    Status string
    Job status: queued, running, succeeded, failed.
    SyncedEndpoints int
    Number of endpoints synchronized by the job.
    TenantId string
    Tenant ID from provider configuration.
    UnassignedCount int
    Count of devices that could not be mapped.
    UpdatedAt string
    Job update timestamp.
    CompletedAt string
    Job completion timestamp.
    CreatedAt string
    Job creation timestamp.
    Error string
    Job error string when status=failed.
    Id string
    The provider-assigned unique ID for this managed resource.
    StartedAt string
    Job start timestamp.
    Status string
    Job status: queued, running, succeeded, failed.
    SyncedEndpoints int
    Number of endpoints synchronized by the job.
    TenantId string
    Tenant ID from provider configuration.
    UnassignedCount int
    Count of devices that could not be mapped.
    UpdatedAt string
    Job update timestamp.
    completed_at string
    Job completion timestamp.
    created_at string
    Job creation timestamp.
    error string
    Job error string when status=failed.
    id string
    The provider-assigned unique ID for this managed resource.
    started_at string
    Job start timestamp.
    status string
    Job status: queued, running, succeeded, failed.
    synced_endpoints number
    Number of endpoints synchronized by the job.
    tenant_id string
    Tenant ID from provider configuration.
    unassigned_count number
    Count of devices that could not be mapped.
    updated_at string
    Job update timestamp.
    completedAt String
    Job completion timestamp.
    createdAt String
    Job creation timestamp.
    error String
    Job error string when status=failed.
    id String
    The provider-assigned unique ID for this managed resource.
    startedAt String
    Job start timestamp.
    status String
    Job status: queued, running, succeeded, failed.
    syncedEndpoints Integer
    Number of endpoints synchronized by the job.
    tenantId String
    Tenant ID from provider configuration.
    unassignedCount Integer
    Count of devices that could not be mapped.
    updatedAt String
    Job update timestamp.
    completedAt string
    Job completion timestamp.
    createdAt string
    Job creation timestamp.
    error string
    Job error string when status=failed.
    id string
    The provider-assigned unique ID for this managed resource.
    startedAt string
    Job start timestamp.
    status string
    Job status: queued, running, succeeded, failed.
    syncedEndpoints number
    Number of endpoints synchronized by the job.
    tenantId string
    Tenant ID from provider configuration.
    unassignedCount number
    Count of devices that could not be mapped.
    updatedAt string
    Job update timestamp.
    completed_at str
    Job completion timestamp.
    created_at str
    Job creation timestamp.
    error str
    Job error string when status=failed.
    id str
    The provider-assigned unique ID for this managed resource.
    started_at str
    Job start timestamp.
    status str
    Job status: queued, running, succeeded, failed.
    synced_endpoints int
    Number of endpoints synchronized by the job.
    tenant_id str
    Tenant ID from provider configuration.
    unassigned_count int
    Count of devices that could not be mapped.
    updated_at str
    Job update timestamp.
    completedAt String
    Job completion timestamp.
    createdAt String
    Job creation timestamp.
    error String
    Job error string when status=failed.
    id String
    The provider-assigned unique ID for this managed resource.
    startedAt String
    Job start timestamp.
    status String
    Job status: queued, running, succeeded, failed.
    syncedEndpoints Number
    Number of endpoints synchronized by the job.
    tenantId String
    Tenant ID from provider configuration.
    unassignedCount Number
    Count of devices that could not be mapped.
    updatedAt String
    Job update timestamp.

    Look up Existing Sync Resource

    Get an existing Sync resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SyncState, opts?: CustomResourceOptions): Sync
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            completed_at: Optional[str] = None,
            created_at: Optional[str] = None,
            error: Optional[str] = None,
            poll_interval_seconds: Optional[int] = None,
            provider_name: Optional[str] = None,
            started_at: Optional[str] = None,
            status: Optional[str] = None,
            synced_endpoints: Optional[int] = None,
            tenant_id: Optional[str] = None,
            timeout_seconds: Optional[int] = None,
            trigger: Optional[str] = None,
            unassigned_count: Optional[int] = None,
            updated_at: Optional[str] = None,
            wait_for_completion: Optional[bool] = None) -> Sync
    func GetSync(ctx *Context, name string, id IDInput, state *SyncState, opts ...ResourceOption) (*Sync, error)
    public static Sync Get(string name, Input<string> id, SyncState? state, CustomResourceOptions? opts = null)
    public static Sync get(String name, Output<String> id, SyncState state, CustomResourceOptions options)
    resources:  _:    type: thoth:mdm:Sync    get:      id: ${id}
    import {
      to = thoth_mdm_sync.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompletedAt string
    Job completion timestamp.
    CreatedAt string
    Job creation timestamp.
    Error string
    Job error string when status=failed.
    PollIntervalSeconds int
    Polling interval when wait_for_completion=true.
    ProviderName string
    MDM provider slug.
    StartedAt string
    Job start timestamp.
    Status string
    Job status: queued, running, succeeded, failed.
    SyncedEndpoints int
    Number of endpoints synchronized by the job.
    TenantId string
    Tenant ID from provider configuration.
    TimeoutSeconds int
    Polling timeout when wait_for_completion=true.
    Trigger string
    Arbitrary replacement trigger value.
    UnassignedCount int
    Count of devices that could not be mapped.
    UpdatedAt string
    Job update timestamp.
    WaitForCompletion bool
    Wait for sync job completion before returning state.
    CompletedAt string
    Job completion timestamp.
    CreatedAt string
    Job creation timestamp.
    Error string
    Job error string when status=failed.
    PollIntervalSeconds int
    Polling interval when wait_for_completion=true.
    ProviderName string
    MDM provider slug.
    StartedAt string
    Job start timestamp.
    Status string
    Job status: queued, running, succeeded, failed.
    SyncedEndpoints int
    Number of endpoints synchronized by the job.
    TenantId string
    Tenant ID from provider configuration.
    TimeoutSeconds int
    Polling timeout when wait_for_completion=true.
    Trigger string
    Arbitrary replacement trigger value.
    UnassignedCount int
    Count of devices that could not be mapped.
    UpdatedAt string
    Job update timestamp.
    WaitForCompletion bool
    Wait for sync job completion before returning state.
    completed_at string
    Job completion timestamp.
    created_at string
    Job creation timestamp.
    error string
    Job error string when status=failed.
    poll_interval_seconds number
    Polling interval when wait_for_completion=true.
    provider_name string
    MDM provider slug.
    started_at string
    Job start timestamp.
    status string
    Job status: queued, running, succeeded, failed.
    synced_endpoints number
    Number of endpoints synchronized by the job.
    tenant_id string
    Tenant ID from provider configuration.
    timeout_seconds number
    Polling timeout when wait_for_completion=true.
    trigger string
    Arbitrary replacement trigger value.
    unassigned_count number
    Count of devices that could not be mapped.
    updated_at string
    Job update timestamp.
    wait_for_completion bool
    Wait for sync job completion before returning state.
    completedAt String
    Job completion timestamp.
    createdAt String
    Job creation timestamp.
    error String
    Job error string when status=failed.
    pollIntervalSeconds Integer
    Polling interval when wait_for_completion=true.
    providerName String
    MDM provider slug.
    startedAt String
    Job start timestamp.
    status String
    Job status: queued, running, succeeded, failed.
    syncedEndpoints Integer
    Number of endpoints synchronized by the job.
    tenantId String
    Tenant ID from provider configuration.
    timeoutSeconds Integer
    Polling timeout when wait_for_completion=true.
    trigger String
    Arbitrary replacement trigger value.
    unassignedCount Integer
    Count of devices that could not be mapped.
    updatedAt String
    Job update timestamp.
    waitForCompletion Boolean
    Wait for sync job completion before returning state.
    completedAt string
    Job completion timestamp.
    createdAt string
    Job creation timestamp.
    error string
    Job error string when status=failed.
    pollIntervalSeconds number
    Polling interval when wait_for_completion=true.
    providerName string
    MDM provider slug.
    startedAt string
    Job start timestamp.
    status string
    Job status: queued, running, succeeded, failed.
    syncedEndpoints number
    Number of endpoints synchronized by the job.
    tenantId string
    Tenant ID from provider configuration.
    timeoutSeconds number
    Polling timeout when wait_for_completion=true.
    trigger string
    Arbitrary replacement trigger value.
    unassignedCount number
    Count of devices that could not be mapped.
    updatedAt string
    Job update timestamp.
    waitForCompletion boolean
    Wait for sync job completion before returning state.
    completed_at str
    Job completion timestamp.
    created_at str
    Job creation timestamp.
    error str
    Job error string when status=failed.
    poll_interval_seconds int
    Polling interval when wait_for_completion=true.
    provider_name str
    MDM provider slug.
    started_at str
    Job start timestamp.
    status str
    Job status: queued, running, succeeded, failed.
    synced_endpoints int
    Number of endpoints synchronized by the job.
    tenant_id str
    Tenant ID from provider configuration.
    timeout_seconds int
    Polling timeout when wait_for_completion=true.
    trigger str
    Arbitrary replacement trigger value.
    unassigned_count int
    Count of devices that could not be mapped.
    updated_at str
    Job update timestamp.
    wait_for_completion bool
    Wait for sync job completion before returning state.
    completedAt String
    Job completion timestamp.
    createdAt String
    Job creation timestamp.
    error String
    Job error string when status=failed.
    pollIntervalSeconds Number
    Polling interval when wait_for_completion=true.
    providerName String
    MDM provider slug.
    startedAt String
    Job start timestamp.
    status String
    Job status: queued, running, succeeded, failed.
    syncedEndpoints Number
    Number of endpoints synchronized by the job.
    tenantId String
    Tenant ID from provider configuration.
    timeoutSeconds Number
    Polling timeout when wait_for_completion=true.
    trigger String
    Arbitrary replacement trigger value.
    unassignedCount Number
    Count of devices that could not be mapped.
    updatedAt String
    Job update timestamp.
    waitForCompletion Boolean
    Wait for sync job completion before returning state.

    Package Details

    Repository
    thoth atensecurity/pulumi-thoth
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the thoth Terraform Provider.
    thoth logo
    Viewing docs for Thoth v0.1.15
    published on Thursday, Jul 23, 2026 by Aten Security

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial