Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Formal Provider
  3. API Docs
  4. Connector
Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal
formalco/pulumi-formal

formal.Connector

Explore with Pulumi AI

formal logo
Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal
formalco/pulumi-formal

    Registering a Connector with Formal.

    Create Connector Resource

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

    Constructor syntax

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

@overload
def Connector(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              name: Optional[str] = None,
              space_id: Optional[str] = None,
              termination_protection: Optional[bool] = None)
    func NewConnector(ctx *Context, name string, args *ConnectorArgs, opts ...ResourceOption) (*Connector, error)
    public Connector(string name, ConnectorArgs? args = null, CustomResourceOptions? opts = null)
    public Connector(String name, ConnectorArgs args)
public Connector(String name, ConnectorArgs args, CustomResourceOptions options)

    type: formal:Connector
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 ConnectorArgs
    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 ConnectorArgs
    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 ConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorArgs
    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 connectorResource = new Pulumi.Connector("connectorResource", new()
{
    Name = "string",
    SpaceId = "string",
    TerminationProtection = false,
});

    example, err := formal.NewConnector(ctx, "connectorResource", &formal.ConnectorArgs{
	Name:                  pulumi.String("string"),
	SpaceId:               pulumi.String("string"),
	TerminationProtection: pulumi.Bool(false),
})

    var connectorResource = new Connector("connectorResource", ConnectorArgs.builder()
    .name("string")
    .spaceId("string")
    .terminationProtection(false)
    .build());

    connector_resource = formal.Connector("connectorResource",
    name="string",
    space_id="string",
    termination_protection=False)

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

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

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

    Name string
    Friendly name for this Connector.
    SpaceId string
    The ID of the Space to create the Connector in.
    TerminationProtection bool
    If set to true, this Connector cannot be deleted.
    Name string
    Friendly name for this Connector.
    SpaceId string
    The ID of the Space to create the Connector in.
    TerminationProtection bool
    If set to true, this Connector cannot be deleted.
    name String
    Friendly name for this Connector.
    spaceId String
    The ID of the Space to create the Connector in.
    terminationProtection Boolean
    If set to true, this Connector cannot be deleted.
    name string
    Friendly name for this Connector.
    spaceId string
    The ID of the Space to create the Connector in.
    terminationProtection boolean
    If set to true, this Connector cannot be deleted.
    name str
    Friendly name for this Connector.
    space_id str
    The ID of the Space to create the Connector in.
    termination_protection bool
    If set to true, this Connector cannot be deleted.
    name String
    Friendly name for this Connector.
    spaceId String
    The ID of the Space to create the Connector in.
    terminationProtection Boolean
    If set to true, this Connector cannot be deleted.

    Outputs

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

    ApiKey string
    Api key for the deployed Connector.
    Id string
    The provider-assigned unique ID for this managed resource.
    ApiKey string
    Api key for the deployed Connector.
    Id string
    The provider-assigned unique ID for this managed resource.
    apiKey String
    Api key for the deployed Connector.
    id String
    The provider-assigned unique ID for this managed resource.
    apiKey string
    Api key for the deployed Connector.
    id string
    The provider-assigned unique ID for this managed resource.
    api_key str
    Api key for the deployed Connector.
    id str
    The provider-assigned unique ID for this managed resource.
    apiKey String
    Api key for the deployed Connector.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Connector Resource

    Get an existing Connector 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?: ConnectorState, opts?: CustomResourceOptions): Connector
    @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) -> Connector
    func GetConnector(ctx *Context, name string, id IDInput, state *ConnectorState, opts ...ResourceOption) (*Connector, error)
    public static Connector Get(string name, Input<string> id, ConnectorState? state, CustomResourceOptions? opts = null)
    public static Connector get(String name, Output<String> id, ConnectorState state, CustomResourceOptions options)
    resources:  _:    type: formal:Connector    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 for the deployed Connector.
    Name string
    Friendly name for this Connector.
    SpaceId string
    The ID of the Space to create the Connector in.
    TerminationProtection bool
    If set to true, this Connector cannot be deleted.
    ApiKey string
    Api key for the deployed Connector.
    Name string
    Friendly name for this Connector.
    SpaceId string
    The ID of the Space to create the Connector in.
    TerminationProtection bool
    If set to true, this Connector cannot be deleted.
    apiKey String
    Api key for the deployed Connector.
    name String
    Friendly name for this Connector.
    spaceId String
    The ID of the Space to create the Connector in.
    terminationProtection Boolean
    If set to true, this Connector cannot be deleted.
    apiKey string
    Api key for the deployed Connector.
    name string
    Friendly name for this Connector.
    spaceId string
    The ID of the Space to create the Connector in.
    terminationProtection boolean
    If set to true, this Connector cannot be deleted.
    api_key str
    Api key for the deployed Connector.
    name str
    Friendly name for this Connector.
    space_id str
    The ID of the Space to create the Connector in.
    termination_protection bool
    If set to true, this Connector cannot be deleted.
    apiKey String
    Api key for the deployed Connector.
    name String
    Friendly name for this Connector.
    spaceId String
    The ID of the Space to create the Connector in.
    terminationProtection Boolean
    If set to true, this Connector cannot be deleted.

    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.0.2 published on Thursday, Aug 14, 2025 by Formal
    formalco/pulumi-formal