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,
log_level: Optional[str] = None,
otel_endpoint_hostname: Optional[str] = None,
otel_endpoint_port: Optional[int] = None,
resources_health_checks_frequency_seconds: Optional[int] = 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",
LogLevel = "string",
OtelEndpointHostname = "string",
OtelEndpointPort = 0,
ResourcesHealthChecksFrequencySeconds = 0,
});
example, err := formal.NewConnectorConfiguration(ctx, "connectorConfigurationResource", &formal.ConnectorConfigurationArgs{
ConnectorId: pulumi.String("string"),
LogLevel: pulumi.String("string"),
OtelEndpointHostname: pulumi.String("string"),
OtelEndpointPort: pulumi.Int(0),
ResourcesHealthChecksFrequencySeconds: pulumi.Int(0),
})
var connectorConfigurationResource = new ConnectorConfiguration("connectorConfigurationResource", ConnectorConfigurationArgs.builder()
.connectorId("string")
.logLevel("string")
.otelEndpointHostname("string")
.otelEndpointPort(0)
.resourcesHealthChecksFrequencySeconds(0)
.build());
connector_configuration_resource = formal.ConnectorConfiguration("connectorConfigurationResource",
connector_id="string",
log_level="string",
otel_endpoint_hostname="string",
otel_endpoint_port=0,
resources_health_checks_frequency_seconds=0)
const connectorConfigurationResource = new formal.ConnectorConfiguration("connectorConfigurationResource", {
connectorId: "string",
logLevel: "string",
otelEndpointHostname: "string",
otelEndpointPort: 0,
resourcesHealthChecksFrequencySeconds: 0,
});
type: formal:ConnectorConfiguration
properties:
connectorId: string
logLevel: string
otelEndpointHostname: string
otelEndpointPort: 0
resourcesHealthChecksFrequencySeconds: 0
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:
- Connector
Id string - The ID of the Connector this configuration is linked to.
- Log
Level string - The log level to be configured for this Connector.
- Otel
Endpoint stringHostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- Otel
Endpoint intPort - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- Resources
Health intChecks Frequency Seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
- Connector
Id string - The ID of the Connector this configuration is linked to.
- Log
Level string - The log level to be configured for this Connector.
- Otel
Endpoint stringHostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- Otel
Endpoint intPort - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- Resources
Health intChecks Frequency Seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
- connector
Id String - The ID of the Connector this configuration is linked to.
- log
Level String - The log level to be configured for this Connector.
- otel
Endpoint StringHostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- otel
Endpoint IntegerPort - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- resources
Health IntegerChecks Frequency Seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
- connector
Id string - The ID of the Connector this configuration is linked to.
- log
Level string - The log level to be configured for this Connector.
- otel
Endpoint stringHostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- otel
Endpoint numberPort - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- resources
Health numberChecks Frequency Seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
- connector_
id str - The ID of the Connector this configuration is linked to.
- log_
level str - The log level to be configured for this Connector.
- otel_
endpoint_ strhostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- otel_
endpoint_ intport - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- resources_
health_ intchecks_ frequency_ seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
- connector
Id String - The ID of the Connector this configuration is linked to.
- log
Level String - The log level to be configured for this Connector.
- otel
Endpoint StringHostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- otel
Endpoint NumberPort - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- resources
Health NumberChecks Frequency Seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
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,
log_level: Optional[str] = None,
otel_endpoint_hostname: Optional[str] = None,
otel_endpoint_port: Optional[int] = None,
resources_health_checks_frequency_seconds: Optional[int] = None) -> ConnectorConfigurationfunc 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.
- Connector
Id string - The ID of the Connector this configuration is linked to.
- Log
Level string - The log level to be configured for this Connector.
- Otel
Endpoint stringHostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- Otel
Endpoint intPort - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- Resources
Health intChecks Frequency Seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
- Connector
Id string - The ID of the Connector this configuration is linked to.
- Log
Level string - The log level to be configured for this Connector.
- Otel
Endpoint stringHostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- Otel
Endpoint intPort - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- Resources
Health intChecks Frequency Seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
- connector
Id String - The ID of the Connector this configuration is linked to.
- log
Level String - The log level to be configured for this Connector.
- otel
Endpoint StringHostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- otel
Endpoint IntegerPort - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- resources
Health IntegerChecks Frequency Seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
- connector
Id string - The ID of the Connector this configuration is linked to.
- log
Level string - The log level to be configured for this Connector.
- otel
Endpoint stringHostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- otel
Endpoint numberPort - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- resources
Health numberChecks Frequency Seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
- connector_
id str - The ID of the Connector this configuration is linked to.
- log_
level str - The log level to be configured for this Connector.
- otel_
endpoint_ strhostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- otel_
endpoint_ intport - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- resources_
health_ intchecks_ frequency_ seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
- connector
Id String - The ID of the Connector this configuration is linked to.
- log
Level String - The log level to be configured for this Connector.
- otel
Endpoint StringHostname - The OpenTelemetry endpoint hostname for this Connector. Defaults to 'localhost'.
- otel
Endpoint NumberPort - The OpenTelemetry endpoint port for this Connector. Defaults to 4317.
- resources
Health NumberChecks Frequency Seconds - The frequency in seconds for resource health checks. Must be between 10 and 3600 seconds. Defaults to 60.
Package Details
- Repository
- formal formalco/pulumi-formal
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
formalTerraform Provider.
