1. Packages
  2. Formal Provider
  3. API Docs
  4. ConnectorConfiguration
Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal

formal.ConnectorConfiguration

Explore with Pulumi AI

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

    Registering a Connector Configuration with Formal.

    Create ConnectorConfiguration Resource

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

    Constructor syntax

    new ConnectorConfiguration(name: string, args: ConnectorConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def ConnectorConfiguration(resource_name: str,
                               args: ConnectorConfigurationArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConnectorConfiguration(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               connector_id: Optional[str] = None,
                               health_check_port: Optional[int] = None,
                               log_level: Optional[str] = None)
    func NewConnectorConfiguration(ctx *Context, name string, args ConnectorConfigurationArgs, opts ...ResourceOption) (*ConnectorConfiguration, error)
    public ConnectorConfiguration(string name, ConnectorConfigurationArgs args, CustomResourceOptions? opts = null)
    public ConnectorConfiguration(String name, ConnectorConfigurationArgs args)
    public ConnectorConfiguration(String name, ConnectorConfigurationArgs args, CustomResourceOptions options)
    
    type: formal:ConnectorConfiguration
    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 ConnectorConfigurationArgs
    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 ConnectorConfigurationArgs
    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 ConnectorConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorConfigurationArgs
    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 connectorConfigurationResource = new Pulumi.ConnectorConfiguration("connectorConfigurationResource", new()
    {
        ConnectorId = "string",
        HealthCheckPort = 0,
        LogLevel = "string",
    });
    
    example, err := formal.NewConnectorConfiguration(ctx, "connectorConfigurationResource", &formal.ConnectorConfigurationArgs{
    	ConnectorId:     pulumi.String("string"),
    	HealthCheckPort: pulumi.Int(0),
    	LogLevel:        pulumi.String("string"),
    })
    
    var connectorConfigurationResource = new ConnectorConfiguration("connectorConfigurationResource", ConnectorConfigurationArgs.builder()
        .connectorId("string")
        .healthCheckPort(0)
        .logLevel("string")
        .build());
    
    connector_configuration_resource = formal.ConnectorConfiguration("connectorConfigurationResource",
        connector_id="string",
        health_check_port=0,
        log_level="string")
    
    const connectorConfigurationResource = new formal.ConnectorConfiguration("connectorConfigurationResource", {
        connectorId: "string",
        healthCheckPort: 0,
        logLevel: "string",
    });
    
    type: formal:ConnectorConfiguration
    properties:
        connectorId: string
        healthCheckPort: 0
        logLevel: string
    

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

    ConnectorId string
    The ID of the Connector this configuration is linked to.
    HealthCheckPort int
    The port to be used for this Connector's health check.
    LogLevel string
    The log level to be configured for this Connector.
    ConnectorId string
    The ID of the Connector this configuration is linked to.
    HealthCheckPort int
    The port to be used for this Connector's health check.
    LogLevel string
    The log level to be configured for this Connector.
    connectorId String
    The ID of the Connector this configuration is linked to.
    healthCheckPort Integer
    The port to be used for this Connector's health check.
    logLevel String
    The log level to be configured for this Connector.
    connectorId string
    The ID of the Connector this configuration is linked to.
    healthCheckPort number
    The port to be used for this Connector's health check.
    logLevel string
    The log level to be configured for this Connector.
    connector_id str
    The ID of the Connector this configuration is linked to.
    health_check_port int
    The port to be used for this Connector's health check.
    log_level str
    The log level to be configured for this Connector.
    connectorId String
    The ID of the Connector this configuration is linked to.
    healthCheckPort Number
    The port to be used for this Connector's health check.
    logLevel String
    The log level to be configured for this Connector.

    Outputs

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

    Get an existing ConnectorConfiguration 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?: ConnectorConfigurationState, opts?: CustomResourceOptions): ConnectorConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            connector_id: Optional[str] = None,
            health_check_port: Optional[int] = None,
            log_level: Optional[str] = None) -> ConnectorConfiguration
    func GetConnectorConfiguration(ctx *Context, name string, id IDInput, state *ConnectorConfigurationState, opts ...ResourceOption) (*ConnectorConfiguration, error)
    public static ConnectorConfiguration Get(string name, Input<string> id, ConnectorConfigurationState? state, CustomResourceOptions? opts = null)
    public static ConnectorConfiguration get(String name, Output<String> id, ConnectorConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: formal:ConnectorConfiguration    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:
    ConnectorId string
    The ID of the Connector this configuration is linked to.
    HealthCheckPort int
    The port to be used for this Connector's health check.
    LogLevel string
    The log level to be configured for this Connector.
    ConnectorId string
    The ID of the Connector this configuration is linked to.
    HealthCheckPort int
    The port to be used for this Connector's health check.
    LogLevel string
    The log level to be configured for this Connector.
    connectorId String
    The ID of the Connector this configuration is linked to.
    healthCheckPort Integer
    The port to be used for this Connector's health check.
    logLevel String
    The log level to be configured for this Connector.
    connectorId string
    The ID of the Connector this configuration is linked to.
    healthCheckPort number
    The port to be used for this Connector's health check.
    logLevel string
    The log level to be configured for this Connector.
    connector_id str
    The ID of the Connector this configuration is linked to.
    health_check_port int
    The port to be used for this Connector's health check.
    log_level str
    The log level to be configured for this Connector.
    connectorId String
    The ID of the Connector this configuration is linked to.
    healthCheckPort Number
    The port to be used for this Connector's health check.
    logLevel String
    The log level to be configured for this Connector.

    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