1. Packages
  2. Formal Provider
  3. API Docs
  4. SatelliteHostname
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

    Manage a Satellite Hostname.

    Create SatelliteHostname Resource

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

    Constructor syntax

    new SatelliteHostname(name: string, args: SatelliteHostnameArgs, opts?: CustomResourceOptions);
    @overload
    def SatelliteHostname(resource_name: str,
                          args: SatelliteHostnameArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def SatelliteHostname(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          hostname: Optional[str] = None,
                          satellite_id: Optional[str] = None,
                          termination_protection: Optional[bool] = None)
    func NewSatelliteHostname(ctx *Context, name string, args SatelliteHostnameArgs, opts ...ResourceOption) (*SatelliteHostname, error)
    public SatelliteHostname(string name, SatelliteHostnameArgs args, CustomResourceOptions? opts = null)
    public SatelliteHostname(String name, SatelliteHostnameArgs args)
    public SatelliteHostname(String name, SatelliteHostnameArgs args, CustomResourceOptions options)
    
    type: formal:SatelliteHostname
    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 SatelliteHostnameArgs
    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 SatelliteHostnameArgs
    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 SatelliteHostnameArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SatelliteHostnameArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SatelliteHostnameArgs
    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 satelliteHostnameResource = new Pulumi.SatelliteHostname("satelliteHostnameResource", new()
    {
        Hostname = "string",
        SatelliteId = "string",
        TerminationProtection = false,
    });
    
    example, err := formal.NewSatelliteHostname(ctx, "satelliteHostnameResource", &formal.SatelliteHostnameArgs{
    	Hostname:              pulumi.String("string"),
    	SatelliteId:           pulumi.String("string"),
    	TerminationProtection: pulumi.Bool(false),
    })
    
    var satelliteHostnameResource = new SatelliteHostname("satelliteHostnameResource", SatelliteHostnameArgs.builder()
        .hostname("string")
        .satelliteId("string")
        .terminationProtection(false)
        .build());
    
    satellite_hostname_resource = formal.SatelliteHostname("satelliteHostnameResource",
        hostname="string",
        satellite_id="string",
        termination_protection=False)
    
    const satelliteHostnameResource = new formal.SatelliteHostname("satelliteHostnameResource", {
        hostname: "string",
        satelliteId: "string",
        terminationProtection: false,
    });
    
    type: formal:SatelliteHostname
    properties:
        hostname: string
        satelliteId: string
        terminationProtection: false
    

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

    Hostname string
    The hostname for the satellite.
    SatelliteId string
    The ID of the Satellite to create the hostname for.
    TerminationProtection bool
    If set to true, this satellite hostname cannot be deleted.
    Hostname string
    The hostname for the satellite.
    SatelliteId string
    The ID of the Satellite to create the hostname for.
    TerminationProtection bool
    If set to true, this satellite hostname cannot be deleted.
    hostname String
    The hostname for the satellite.
    satelliteId String
    The ID of the Satellite to create the hostname for.
    terminationProtection Boolean
    If set to true, this satellite hostname cannot be deleted.
    hostname string
    The hostname for the satellite.
    satelliteId string
    The ID of the Satellite to create the hostname for.
    terminationProtection boolean
    If set to true, this satellite hostname cannot be deleted.
    hostname str
    The hostname for the satellite.
    satellite_id str
    The ID of the Satellite to create the hostname for.
    termination_protection bool
    If set to true, this satellite hostname cannot be deleted.
    hostname String
    The hostname for the satellite.
    satelliteId String
    The ID of the Satellite to create the hostname for.
    terminationProtection Boolean
    If set to true, this satellite hostname cannot be deleted.

    Outputs

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

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

    Look up Existing SatelliteHostname Resource

    Get an existing SatelliteHostname 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?: SatelliteHostnameState, opts?: CustomResourceOptions): SatelliteHostname
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            hostname: Optional[str] = None,
            satellite_id: Optional[str] = None,
            termination_protection: Optional[bool] = None,
            updated_at: Optional[str] = None) -> SatelliteHostname
    func GetSatelliteHostname(ctx *Context, name string, id IDInput, state *SatelliteHostnameState, opts ...ResourceOption) (*SatelliteHostname, error)
    public static SatelliteHostname Get(string name, Input<string> id, SatelliteHostnameState? state, CustomResourceOptions? opts = null)
    public static SatelliteHostname get(String name, Output<String> id, SatelliteHostnameState state, CustomResourceOptions options)
    resources:  _:    type: formal:SatelliteHostname    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 hostname was created.
    Hostname string
    The hostname for the satellite.
    SatelliteId string
    The ID of the Satellite to create the hostname for.
    TerminationProtection bool
    If set to true, this satellite hostname cannot be deleted.
    UpdatedAt string
    The timestamp when the satellite hostname was last updated.
    CreatedAt string
    The timestamp when the satellite hostname was created.
    Hostname string
    The hostname for the satellite.
    SatelliteId string
    The ID of the Satellite to create the hostname for.
    TerminationProtection bool
    If set to true, this satellite hostname cannot be deleted.
    UpdatedAt string
    The timestamp when the satellite hostname was last updated.
    createdAt String
    The timestamp when the satellite hostname was created.
    hostname String
    The hostname for the satellite.
    satelliteId String
    The ID of the Satellite to create the hostname for.
    terminationProtection Boolean
    If set to true, this satellite hostname cannot be deleted.
    updatedAt String
    The timestamp when the satellite hostname was last updated.
    createdAt string
    The timestamp when the satellite hostname was created.
    hostname string
    The hostname for the satellite.
    satelliteId string
    The ID of the Satellite to create the hostname for.
    terminationProtection boolean
    If set to true, this satellite hostname cannot be deleted.
    updatedAt string
    The timestamp when the satellite hostname was last updated.
    created_at str
    The timestamp when the satellite hostname was created.
    hostname str
    The hostname for the satellite.
    satellite_id str
    The ID of the Satellite to create the hostname for.
    termination_protection bool
    If set to true, this satellite hostname cannot be deleted.
    updated_at str
    The timestamp when the satellite hostname was last updated.
    createdAt String
    The timestamp when the satellite hostname was created.
    hostname String
    The hostname for the satellite.
    satelliteId String
    The ID of the Satellite to create the hostname for.
    terminationProtection Boolean
    If set to true, this satellite hostname cannot be deleted.
    updatedAt String
    The timestamp when the satellite hostname 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