Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Hsdp Provider
  3. API Docs
  4. EdgeSync
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

hsdp.EdgeSync

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

    Synchronizes device configuration. This resource can be used to batch sync requests of a device e.g. you can add all resource configs to the trigger hash and disable sync per resource to batch syncs down to a single one as part of the apply stage.

    Create EdgeSync Resource

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

    Constructor syntax

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

@overload
def EdgeSync(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             serial_number: Optional[str] = None,
             triggers: Optional[Mapping[str, str]] = None,
             edge_sync_id: Optional[str] = None,
             principal: Optional[EdgeSyncPrincipalArgs] = None)
    func NewEdgeSync(ctx *Context, name string, args EdgeSyncArgs, opts ...ResourceOption) (*EdgeSync, error)
    public EdgeSync(string name, EdgeSyncArgs args, CustomResourceOptions? opts = null)
    public EdgeSync(String name, EdgeSyncArgs args)
public EdgeSync(String name, EdgeSyncArgs args, CustomResourceOptions options)

    type: hsdp:EdgeSync
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 EdgeSyncArgs
    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 EdgeSyncArgs
    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 EdgeSyncArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeSyncArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeSyncArgs
    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 edgeSyncResource = new Hsdp.EdgeSync("edgeSyncResource", new()
{
    SerialNumber = "string",
    Triggers = 
    {
        { "string", "string" },
    },
    EdgeSyncId = "string",
    Principal = new Hsdp.Inputs.EdgeSyncPrincipalArgs
    {
        Endpoint = "string",
        Environment = "string",
        Oauth2ClientId = "string",
        Oauth2Password = "string",
        Password = "string",
        Region = "string",
        ServiceId = "string",
        ServicePrivateKey = "string",
        UaaPassword = "string",
        UaaUsername = "string",
        Username = "string",
    },
});

    example, err := hsdp.NewEdgeSync(ctx, "edgeSyncResource", &hsdp.EdgeSyncArgs{
	SerialNumber: pulumi.String("string"),
	Triggers: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	EdgeSyncId: pulumi.String("string"),
	Principal: &hsdp.EdgeSyncPrincipalArgs{
		Endpoint:          pulumi.String("string"),
		Environment:       pulumi.String("string"),
		Oauth2ClientId:    pulumi.String("string"),
		Oauth2Password:    pulumi.String("string"),
		Password:          pulumi.String("string"),
		Region:            pulumi.String("string"),
		ServiceId:         pulumi.String("string"),
		ServicePrivateKey: pulumi.String("string"),
		UaaPassword:       pulumi.String("string"),
		UaaUsername:       pulumi.String("string"),
		Username:          pulumi.String("string"),
	},
})

    var edgeSyncResource = new EdgeSync("edgeSyncResource", EdgeSyncArgs.builder()
    .serialNumber("string")
    .triggers(Map.of("string", "string"))
    .edgeSyncId("string")
    .principal(EdgeSyncPrincipalArgs.builder()
        .endpoint("string")
        .environment("string")
        .oauth2ClientId("string")
        .oauth2Password("string")
        .password("string")
        .region("string")
        .serviceId("string")
        .servicePrivateKey("string")
        .uaaPassword("string")
        .uaaUsername("string")
        .username("string")
        .build())
    .build());

    edge_sync_resource = hsdp.EdgeSync("edgeSyncResource",
    serial_number="string",
    triggers={
        "string": "string",
    },
    edge_sync_id="string",
    principal={
        "endpoint": "string",
        "environment": "string",
        "oauth2_client_id": "string",
        "oauth2_password": "string",
        "password": "string",
        "region": "string",
        "service_id": "string",
        "service_private_key": "string",
        "uaa_password": "string",
        "uaa_username": "string",
        "username": "string",
    })

    const edgeSyncResource = new hsdp.EdgeSync("edgeSyncResource", {
    serialNumber: "string",
    triggers: {
        string: "string",
    },
    edgeSyncId: "string",
    principal: {
        endpoint: "string",
        environment: "string",
        oauth2ClientId: "string",
        oauth2Password: "string",
        password: "string",
        region: "string",
        serviceId: "string",
        servicePrivateKey: "string",
        uaaPassword: "string",
        uaaUsername: "string",
        username: "string",
    },
});

    type: hsdp:EdgeSync
properties:
    edgeSyncId: string
    principal:
        endpoint: string
        environment: string
        oauth2ClientId: string
        oauth2Password: string
        password: string
        region: string
        serviceId: string
        servicePrivateKey: string
        uaaPassword: string
        uaaUsername: string
        username: string
    serialNumber: string
    triggers:
        string: string

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

    SerialNumber string
    Serial number of the device to sync
    Triggers Dictionary<string, string>
    Create dependencies on other resources
    EdgeSyncId string
    Principal EdgeSyncPrincipal
    The optional principal to use for this resource
    SerialNumber string
    Serial number of the device to sync
    Triggers map[string]string
    Create dependencies on other resources
    EdgeSyncId string
    Principal EdgeSyncPrincipalArgs
    The optional principal to use for this resource
    serialNumber String
    Serial number of the device to sync
    triggers Map<String,String>
    Create dependencies on other resources
    edgeSyncId String
    principal EdgeSyncPrincipal
    The optional principal to use for this resource
    serialNumber string
    Serial number of the device to sync
    triggers {[key: string]: string}
    Create dependencies on other resources
    edgeSyncId string
    principal EdgeSyncPrincipal
    The optional principal to use for this resource
    serial_number str
    Serial number of the device to sync
    triggers Mapping[str, str]
    Create dependencies on other resources
    edge_sync_id str
    principal EdgeSyncPrincipalArgs
    The optional principal to use for this resource
    serialNumber String
    Serial number of the device to sync
    triggers Map<String>
    Create dependencies on other resources
    edgeSyncId String
    principal Property Map
    The optional principal to use for this resource

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EdgeSync 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EdgeSync Resource

    Get an existing EdgeSync 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?: EdgeSyncState, opts?: CustomResourceOptions): EdgeSync
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        edge_sync_id: Optional[str] = None,
        principal: Optional[EdgeSyncPrincipalArgs] = None,
        serial_number: Optional[str] = None,
        triggers: Optional[Mapping[str, str]] = None) -> EdgeSync
    func GetEdgeSync(ctx *Context, name string, id IDInput, state *EdgeSyncState, opts ...ResourceOption) (*EdgeSync, error)
    public static EdgeSync Get(string name, Input<string> id, EdgeSyncState? state, CustomResourceOptions? opts = null)
    public static EdgeSync get(String name, Output<String> id, EdgeSyncState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:EdgeSync    get:      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:
    EdgeSyncId string
    Principal EdgeSyncPrincipal
    The optional principal to use for this resource
    SerialNumber string
    Serial number of the device to sync
    Triggers Dictionary<string, string>
    Create dependencies on other resources
    EdgeSyncId string
    Principal EdgeSyncPrincipalArgs
    The optional principal to use for this resource
    SerialNumber string
    Serial number of the device to sync
    Triggers map[string]string
    Create dependencies on other resources
    edgeSyncId String
    principal EdgeSyncPrincipal
    The optional principal to use for this resource
    serialNumber String
    Serial number of the device to sync
    triggers Map<String,String>
    Create dependencies on other resources
    edgeSyncId string
    principal EdgeSyncPrincipal
    The optional principal to use for this resource
    serialNumber string
    Serial number of the device to sync
    triggers {[key: string]: string}
    Create dependencies on other resources
    edge_sync_id str
    principal EdgeSyncPrincipalArgs
    The optional principal to use for this resource
    serial_number str
    Serial number of the device to sync
    triggers Mapping[str, str]
    Create dependencies on other resources
    edgeSyncId String
    principal Property Map
    The optional principal to use for this resource
    serialNumber String
    Serial number of the device to sync
    triggers Map<String>
    Create dependencies on other resources

    Supporting Types

    EdgeSyncPrincipal, EdgeSyncPrincipalArgs

    Endpoint string
    The endpoint URL to use if applicable. When not set, the provider config is used
    Environment string
    Oauth2ClientId string
    Oauth2Password string
    Password string
    Region string
    Region to use. When not set, the provider config is used
    ServiceId string
    ServicePrivateKey string
    UaaPassword string
    The UAA password to use
    UaaUsername string
    The UAA username to use
    Username string
    Endpoint string
    The endpoint URL to use if applicable. When not set, the provider config is used
    Environment string
    Oauth2ClientId string
    Oauth2Password string
    Password string
    Region string
    Region to use. When not set, the provider config is used
    ServiceId string
    ServicePrivateKey string
    UaaPassword string
    The UAA password to use
    UaaUsername string
    The UAA username to use
    Username string
    endpoint String
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment String
    oauth2ClientId String
    oauth2Password String
    password String
    region String
    Region to use. When not set, the provider config is used
    serviceId String
    servicePrivateKey String
    uaaPassword String
    The UAA password to use
    uaaUsername String
    The UAA username to use
    username String
    endpoint string
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment string
    oauth2ClientId string
    oauth2Password string
    password string
    region string
    Region to use. When not set, the provider config is used
    serviceId string
    servicePrivateKey string
    uaaPassword string
    The UAA password to use
    uaaUsername string
    The UAA username to use
    username string
    endpoint str
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment str
    oauth2_client_id str
    oauth2_password str
    password str
    region str
    Region to use. When not set, the provider config is used
    service_id str
    service_private_key str
    uaa_password str
    The UAA password to use
    uaa_username str
    The UAA username to use
    username str
    endpoint String
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment String
    oauth2ClientId String
    oauth2Password String
    password String
    region String
    Region to use. When not set, the provider config is used
    serviceId String
    servicePrivateKey String
    uaaPassword String
    The UAA password to use
    uaaUsername String
    The UAA username to use
    username String

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
    philips-software/terraform-provider-hsdp