Formal v1.0.2, Aug 14 25

Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal

formal.Satellite

Explore with Pulumi AI

Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal

Create Satellite Resource

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

Constructor syntax

new Satellite(name: string, args?: SatelliteArgs, opts?: CustomResourceOptions);

@overload
def Satellite(resource_name: str,
              args: Optional[SatelliteArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def Satellite(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              name: Optional[str] = None,
              space_id: Optional[str] = None,
              termination_protection: Optional[bool] = None)

func NewSatellite(ctx *Context, name string, args *SatelliteArgs, opts ...ResourceOption) (*Satellite, error)

public Satellite(string name, SatelliteArgs? args = null, CustomResourceOptions? opts = null)

public Satellite(String name, SatelliteArgs args)
public Satellite(String name, SatelliteArgs args, CustomResourceOptions options)

type: formal:Satellite
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 SatelliteArgs: 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 SatelliteArgs: 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 SatelliteArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SatelliteArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SatelliteArgs: 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 satelliteResource = new Pulumi.Satellite("satelliteResource", new()
{
    Name = "string",
    SpaceId = "string",
    TerminationProtection = false,
});

example, err := formal.NewSatellite(ctx, "satelliteResource", &formal.SatelliteArgs{
	Name:                  pulumi.String("string"),
	SpaceId:               pulumi.String("string"),
	TerminationProtection: pulumi.Bool(false),
})

var satelliteResource = new Satellite("satelliteResource", SatelliteArgs.builder()
    .name("string")
    .spaceId("string")
    .terminationProtection(false)
    .build());

satellite_resource = formal.Satellite("satelliteResource",
    name="string",
    space_id="string",
    termination_protection=False)

const satelliteResource = new formal.Satellite("satelliteResource", {
    name: "string",
    spaceId: "string",
    terminationProtection: false,
});

type: formal:Satellite
properties:
    name: string
    spaceId: string
    terminationProtection: false

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

Name string: Friendly name for the Satellite.
SpaceId string: The ID of the Space to create the Satellite in.
TerminationProtection bool: If set to true, this Satellite cannot be deleted.

Name string: Friendly name for the Satellite.
SpaceId string: The ID of the Space to create the Satellite in.
TerminationProtection bool: If set to true, this Satellite cannot be deleted.

name String: Friendly name for the Satellite.
spaceId String: The ID of the Space to create the Satellite in.
terminationProtection Boolean: If set to true, this Satellite cannot be deleted.

name string: Friendly name for the Satellite.
spaceId string: The ID of the Space to create the Satellite in.
terminationProtection boolean: If set to true, this Satellite cannot be deleted.

name str: Friendly name for the Satellite.
space_id str: The ID of the Space to create the Satellite in.
termination_protection bool: If set to true, this Satellite cannot be deleted.

name String: Friendly name for the Satellite.
spaceId String: The ID of the Space to create the Satellite in.
terminationProtection Boolean: If set to true, this Satellite cannot be deleted.

Outputs

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

ApiKey string: Api key of the Satellite.
Id string: The provider-assigned unique ID for this managed resource.
TlsCert string: TLS certificate of the Satellite.

ApiKey string: Api key of the Satellite.
Id string: The provider-assigned unique ID for this managed resource.
TlsCert string: TLS certificate of the Satellite.

apiKey String: Api key of the Satellite.
id String: The provider-assigned unique ID for this managed resource.
tlsCert String: TLS certificate of the Satellite.

apiKey string: Api key of the Satellite.
id string: The provider-assigned unique ID for this managed resource.
tlsCert string: TLS certificate of the Satellite.

api_key str: Api key of the Satellite.
id str: The provider-assigned unique ID for this managed resource.
tls_cert str: TLS certificate of the Satellite.

apiKey String: Api key of the Satellite.
id String: The provider-assigned unique ID for this managed resource.
tlsCert String: TLS certificate of the Satellite.

Look up Existing Satellite Resource

Get an existing Satellite 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?: SatelliteState, opts?: CustomResourceOptions): Satellite

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key: Optional[str] = None,
        name: Optional[str] = None,
        space_id: Optional[str] = None,
        termination_protection: Optional[bool] = None,
        tls_cert: Optional[str] = None) -> Satellite

func GetSatellite(ctx *Context, name string, id IDInput, state *SatelliteState, opts ...ResourceOption) (*Satellite, error)

public static Satellite Get(string name, Input<string> id, SatelliteState? state, CustomResourceOptions? opts = null)

public static Satellite get(String name, Output<String> id, SatelliteState state, CustomResourceOptions options)

resources:  _:    type: formal:Satellite    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:

ApiKey string: Api key of the Satellite.
Name string: Friendly name for the Satellite.
SpaceId string: The ID of the Space to create the Satellite in.
TerminationProtection bool: If set to true, this Satellite cannot be deleted.
TlsCert string: TLS certificate of the Satellite.

ApiKey string: Api key of the Satellite.
Name string: Friendly name for the Satellite.
SpaceId string: The ID of the Space to create the Satellite in.
TerminationProtection bool: If set to true, this Satellite cannot be deleted.
TlsCert string: TLS certificate of the Satellite.

apiKey String: Api key of the Satellite.
name String: Friendly name for the Satellite.
spaceId String: The ID of the Space to create the Satellite in.
terminationProtection Boolean: If set to true, this Satellite cannot be deleted.
tlsCert String: TLS certificate of the Satellite.

apiKey string: Api key of the Satellite.
name string: Friendly name for the Satellite.
spaceId string: The ID of the Space to create the Satellite in.
terminationProtection boolean: If set to true, this Satellite cannot be deleted.
tlsCert string: TLS certificate of the Satellite.

api_key str: Api key of the Satellite.
name str: Friendly name for the Satellite.
space_id str: The ID of the Space to create the Satellite in.
termination_protection bool: If set to true, this Satellite cannot be deleted.
tls_cert str: TLS certificate of the Satellite.

apiKey String: Api key of the Satellite.
name String: Friendly name for the Satellite.
spaceId String: The ID of the Space to create the Satellite in.
terminationProtection Boolean: If set to true, this Satellite cannot be deleted.
tlsCert String: TLS certificate of the Satellite.

Package Details

Repository: formal formalco/pulumi-formal
License: MPL-2.0
Notes: This Pulumi package is based on the formal Terraform Provider.

Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal

formalco/pulumi-formal

formal.Satellite

On this page

On this page

Create Satellite Resource

Constructor syntax

Parameters

Constructor example

Satellite Resource Properties

Inputs

Outputs

Look up Existing Satellite Resource

Package Details

On this page

On this page