1. Packages
  2. Formal Provider
  3. API Docs
  4. ConnectorListener
Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

formal.ConnectorListener

Explore with Pulumi AI

formal logo
Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

    Registering a Connector Listener with Formal.

    Create ConnectorListener Resource

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

    Constructor syntax

    new ConnectorListener(name: string, args: ConnectorListenerArgs, opts?: CustomResourceOptions);
    @overload
    def ConnectorListener(resource_name: str,
                          args: ConnectorListenerArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConnectorListener(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          port: Optional[int] = None,
                          name: Optional[str] = None,
                          termination_protection: Optional[bool] = None)
    func NewConnectorListener(ctx *Context, name string, args ConnectorListenerArgs, opts ...ResourceOption) (*ConnectorListener, error)
    public ConnectorListener(string name, ConnectorListenerArgs args, CustomResourceOptions? opts = null)
    public ConnectorListener(String name, ConnectorListenerArgs args)
    public ConnectorListener(String name, ConnectorListenerArgs args, CustomResourceOptions options)
    
    type: formal:ConnectorListener
    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 ConnectorListenerArgs
    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 ConnectorListenerArgs
    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 ConnectorListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorListenerArgs
    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 connectorListenerResource = new Pulumi.ConnectorListener("connectorListenerResource", new()
    {
        Port = 0,
        Name = "string",
        TerminationProtection = false,
    });
    
    example, err := formal.NewConnectorListener(ctx, "connectorListenerResource", &formal.ConnectorListenerArgs{
    	Port:                  pulumi.Int(0),
    	Name:                  pulumi.String("string"),
    	TerminationProtection: pulumi.Bool(false),
    })
    
    var connectorListenerResource = new ConnectorListener("connectorListenerResource", ConnectorListenerArgs.builder()
        .port(0)
        .name("string")
        .terminationProtection(false)
        .build());
    
    connector_listener_resource = formal.ConnectorListener("connectorListenerResource",
        port=0,
        name="string",
        termination_protection=False)
    
    const connectorListenerResource = new formal.ConnectorListener("connectorListenerResource", {
        port: 0,
        name: "string",
        terminationProtection: false,
    });
    
    type: formal:ConnectorListener
    properties:
        name: string
        port: 0
        terminationProtection: false
    

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

    Port int
    The listening port for this connector listener.
    Name string
    The name of the connector listener.
    TerminationProtection bool
    If set to true, this connector listener cannot be deleted.
    Port int
    The listening port for this connector listener.
    Name string
    The name of the connector listener.
    TerminationProtection bool
    If set to true, this connector listener cannot be deleted.
    port Integer
    The listening port for this connector listener.
    name String
    The name of the connector listener.
    terminationProtection Boolean
    If set to true, this connector listener cannot be deleted.
    port number
    The listening port for this connector listener.
    name string
    The name of the connector listener.
    terminationProtection boolean
    If set to true, this connector listener cannot be deleted.
    port int
    The listening port for this connector listener.
    name str
    The name of the connector listener.
    termination_protection bool
    If set to true, this connector listener cannot be deleted.
    port Number
    The listening port for this connector listener.
    name String
    The name of the connector listener.
    terminationProtection Boolean
    If set to true, this connector listener cannot be deleted.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConnectorListener 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 ConnectorListener Resource

    Get an existing ConnectorListener 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?: ConnectorListenerState, opts?: CustomResourceOptions): ConnectorListener
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            port: Optional[int] = None,
            termination_protection: Optional[bool] = None) -> ConnectorListener
    func GetConnectorListener(ctx *Context, name string, id IDInput, state *ConnectorListenerState, opts ...ResourceOption) (*ConnectorListener, error)
    public static ConnectorListener Get(string name, Input<string> id, ConnectorListenerState? state, CustomResourceOptions? opts = null)
    public static ConnectorListener get(String name, Output<String> id, ConnectorListenerState state, CustomResourceOptions options)
    resources:  _:    type: formal:ConnectorListener    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:
    Name string
    The name of the connector listener.
    Port int
    The listening port for this connector listener.
    TerminationProtection bool
    If set to true, this connector listener cannot be deleted.
    Name string
    The name of the connector listener.
    Port int
    The listening port for this connector listener.
    TerminationProtection bool
    If set to true, this connector listener cannot be deleted.
    name String
    The name of the connector listener.
    port Integer
    The listening port for this connector listener.
    terminationProtection Boolean
    If set to true, this connector listener cannot be deleted.
    name string
    The name of the connector listener.
    port number
    The listening port for this connector listener.
    terminationProtection boolean
    If set to true, this connector listener cannot be deleted.
    name str
    The name of the connector listener.
    port int
    The listening port for this connector listener.
    termination_protection bool
    If set to true, this connector listener cannot be deleted.
    name String
    The name of the connector listener.
    port Number
    The listening port for this connector listener.
    terminationProtection Boolean
    If set to true, this connector listener 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.3 published on Monday, Aug 18, 2025 by Formal
      AI Agentic Workflows: Register now