1. Packages
  2. Formal Provider
  3. API Docs
  4. SatelliteLink
Formal v1.1.0 published on Sunday, Mar 1, 2026 by Formal
formal logo
Formal v1.1.0 published on Sunday, Mar 1, 2026 by Formal

    Link a Satellite to another Satellite. For example, link a Data Discovery Satellite to an AI Satellite for column classification.

    Create SatelliteLink Resource

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

    Constructor syntax

    new SatelliteLink(name: string, args: SatelliteLinkArgs, opts?: CustomResourceOptions);
    @overload
    def SatelliteLink(resource_name: str,
                      args: SatelliteLinkArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def SatelliteLink(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      source_satellite_id: Optional[str] = None,
                      target_satellite_id: Optional[str] = None)
    func NewSatelliteLink(ctx *Context, name string, args SatelliteLinkArgs, opts ...ResourceOption) (*SatelliteLink, error)
    public SatelliteLink(string name, SatelliteLinkArgs args, CustomResourceOptions? opts = null)
    public SatelliteLink(String name, SatelliteLinkArgs args)
    public SatelliteLink(String name, SatelliteLinkArgs args, CustomResourceOptions options)
    
    type: formal:SatelliteLink
    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 SatelliteLinkArgs
    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 SatelliteLinkArgs
    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 SatelliteLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SatelliteLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SatelliteLinkArgs
    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 satelliteLinkResource = new Pulumi.SatelliteLink("satelliteLinkResource", new()
    {
        SourceSatelliteId = "string",
        TargetSatelliteId = "string",
    });
    
    example, err := formal.NewSatelliteLink(ctx, "satelliteLinkResource", &formal.SatelliteLinkArgs{
    	SourceSatelliteId: pulumi.String("string"),
    	TargetSatelliteId: pulumi.String("string"),
    })
    
    var satelliteLinkResource = new SatelliteLink("satelliteLinkResource", SatelliteLinkArgs.builder()
        .sourceSatelliteId("string")
        .targetSatelliteId("string")
        .build());
    
    satellite_link_resource = formal.SatelliteLink("satelliteLinkResource",
        source_satellite_id="string",
        target_satellite_id="string")
    
    const satelliteLinkResource = new formal.SatelliteLink("satelliteLinkResource", {
        sourceSatelliteId: "string",
        targetSatelliteId: "string",
    });
    
    type: formal:SatelliteLink
    properties:
        sourceSatelliteId: string
        targetSatelliteId: string
    

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

    SourceSatelliteId string
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    TargetSatelliteId string
    The ID of the target Satellite (e.g., AI Satellite).
    SourceSatelliteId string
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    TargetSatelliteId string
    The ID of the target Satellite (e.g., AI Satellite).
    sourceSatelliteId String
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    targetSatelliteId String
    The ID of the target Satellite (e.g., AI Satellite).
    sourceSatelliteId string
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    targetSatelliteId string
    The ID of the target Satellite (e.g., AI Satellite).
    source_satellite_id str
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    target_satellite_id str
    The ID of the target Satellite (e.g., AI Satellite).
    sourceSatelliteId String
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    targetSatelliteId String
    The ID of the target Satellite (e.g., AI Satellite).

    Outputs

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

    CreatedAt string
    The timestamp when the satellite link was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The timestamp when the satellite link was last updated.
    CreatedAt string
    The timestamp when the satellite link was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The timestamp when the satellite link was last updated.
    createdAt String
    The timestamp when the satellite link was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The timestamp when the satellite link was last updated.
    createdAt string
    The timestamp when the satellite link was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    The timestamp when the satellite link was last updated.
    created_at str
    The timestamp when the satellite link was created.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    The timestamp when the satellite link was last updated.
    createdAt String
    The timestamp when the satellite link was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The timestamp when the satellite link was last updated.

    Look up Existing SatelliteLink Resource

    Get an existing SatelliteLink 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?: SatelliteLinkState, opts?: CustomResourceOptions): SatelliteLink
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            source_satellite_id: Optional[str] = None,
            target_satellite_id: Optional[str] = None,
            updated_at: Optional[str] = None) -> SatelliteLink
    func GetSatelliteLink(ctx *Context, name string, id IDInput, state *SatelliteLinkState, opts ...ResourceOption) (*SatelliteLink, error)
    public static SatelliteLink Get(string name, Input<string> id, SatelliteLinkState? state, CustomResourceOptions? opts = null)
    public static SatelliteLink get(String name, Output<String> id, SatelliteLinkState state, CustomResourceOptions options)
    resources:  _:    type: formal:SatelliteLink    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:
    CreatedAt string
    The timestamp when the satellite link was created.
    SourceSatelliteId string
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    TargetSatelliteId string
    The ID of the target Satellite (e.g., AI Satellite).
    UpdatedAt string
    The timestamp when the satellite link was last updated.
    CreatedAt string
    The timestamp when the satellite link was created.
    SourceSatelliteId string
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    TargetSatelliteId string
    The ID of the target Satellite (e.g., AI Satellite).
    UpdatedAt string
    The timestamp when the satellite link was last updated.
    createdAt String
    The timestamp when the satellite link was created.
    sourceSatelliteId String
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    targetSatelliteId String
    The ID of the target Satellite (e.g., AI Satellite).
    updatedAt String
    The timestamp when the satellite link was last updated.
    createdAt string
    The timestamp when the satellite link was created.
    sourceSatelliteId string
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    targetSatelliteId string
    The ID of the target Satellite (e.g., AI Satellite).
    updatedAt string
    The timestamp when the satellite link was last updated.
    created_at str
    The timestamp when the satellite link was created.
    source_satellite_id str
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    target_satellite_id str
    The ID of the target Satellite (e.g., AI Satellite).
    updated_at str
    The timestamp when the satellite link was last updated.
    createdAt String
    The timestamp when the satellite link was created.
    sourceSatelliteId String
    The ID of the source Satellite (e.g., Data Discovery Satellite).
    targetSatelliteId String
    The ID of the target Satellite (e.g., AI Satellite).
    updatedAt String
    The timestamp when the satellite link was last updated.

    Package Details

    Repository
    formal formalco/pulumi-formal
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the formal Terraform Provider.
    formal logo
    Formal v1.1.0 published on Sunday, Mar 1, 2026 by Formal
      Meet Neo: Your AI Platform Teammate