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

formal.LogConfiguration

Explore with Pulumi AI

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

    Managing Log Configuration with Formal.

    Create LogConfiguration Resource

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

    Constructor syntax

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

@overload
def LogConfiguration(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     encryption_key_id: Optional[str] = None,
                     request: Optional[LogConfigurationRequestArgs] = None,
                     response: Optional[LogConfigurationResponseArgs] = None,
                     scope: Optional[LogConfigurationScopeArgs] = None,
                     name: Optional[str] = None,
                     stream: Optional[LogConfigurationStreamArgs] = None)
    func NewLogConfiguration(ctx *Context, name string, args LogConfigurationArgs, opts ...ResourceOption) (*LogConfiguration, error)
    public LogConfiguration(string name, LogConfigurationArgs args, CustomResourceOptions? opts = null)
    public LogConfiguration(String name, LogConfigurationArgs args)
public LogConfiguration(String name, LogConfigurationArgs args, CustomResourceOptions options)

    type: formal:LogConfiguration
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 LogConfigurationArgs
    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 LogConfigurationArgs
    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 LogConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogConfigurationArgs
    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 logConfigurationResource = new Pulumi.LogConfiguration("logConfigurationResource", new()
{
    EncryptionKeyId = "string",
    Request = new Pulumi.Inputs.LogConfigurationRequestArgs
    {
        Encrypt = false,
        MaxPayloadSize = 0,
        Sql = new Pulumi.Inputs.LogConfigurationRequestSqlArgs
        {
            Encrypt = false,
            StripValues = false,
        },
    },
    Response = new Pulumi.Inputs.LogConfigurationResponseArgs
    {
        Encrypt = false,
        MaxPayloadSize = 0,
    },
    Scope = new Pulumi.Inputs.LogConfigurationScopeArgs
    {
        Type = "string",
        ConnectorId = "string",
        ResourceId = "string",
        SpaceId = "string",
    },
    Name = "string",
    Stream = new Pulumi.Inputs.LogConfigurationStreamArgs
    {
        Encrypt = false,
    },
});

    example, err := formal.NewLogConfiguration(ctx, "logConfigurationResource", &formal.LogConfigurationArgs{
	EncryptionKeyId: pulumi.String("string"),
	Request: &formal.LogConfigurationRequestArgs{
		Encrypt:        pulumi.Bool(false),
		MaxPayloadSize: pulumi.Int(0),
		Sql: &formal.LogConfigurationRequestSqlArgs{
			Encrypt:     pulumi.Bool(false),
			StripValues: pulumi.Bool(false),
		},
	},
	Response: &formal.LogConfigurationResponseArgs{
		Encrypt:        pulumi.Bool(false),
		MaxPayloadSize: pulumi.Int(0),
	},
	Scope: &formal.LogConfigurationScopeArgs{
		Type:        pulumi.String("string"),
		ConnectorId: pulumi.String("string"),
		ResourceId:  pulumi.String("string"),
		SpaceId:     pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Stream: &formal.LogConfigurationStreamArgs{
		Encrypt: pulumi.Bool(false),
	},
})

    var logConfigurationResource = new LogConfiguration("logConfigurationResource", LogConfigurationArgs.builder()
    .encryptionKeyId("string")
    .request(LogConfigurationRequestArgs.builder()
        .encrypt(false)
        .maxPayloadSize(0)
        .sql(LogConfigurationRequestSqlArgs.builder()
            .encrypt(false)
            .stripValues(false)
            .build())
        .build())
    .response(LogConfigurationResponseArgs.builder()
        .encrypt(false)
        .maxPayloadSize(0)
        .build())
    .scope(LogConfigurationScopeArgs.builder()
        .type("string")
        .connectorId("string")
        .resourceId("string")
        .spaceId("string")
        .build())
    .name("string")
    .stream(LogConfigurationStreamArgs.builder()
        .encrypt(false)
        .build())
    .build());

    log_configuration_resource = formal.LogConfiguration("logConfigurationResource",
    encryption_key_id="string",
    request={
        "encrypt": False,
        "max_payload_size": 0,
        "sql": {
            "encrypt": False,
            "strip_values": False,
        },
    },
    response={
        "encrypt": False,
        "max_payload_size": 0,
    },
    scope={
        "type": "string",
        "connector_id": "string",
        "resource_id": "string",
        "space_id": "string",
    },
    name="string",
    stream={
        "encrypt": False,
    })

    const logConfigurationResource = new formal.LogConfiguration("logConfigurationResource", {
    encryptionKeyId: "string",
    request: {
        encrypt: false,
        maxPayloadSize: 0,
        sql: {
            encrypt: false,
            stripValues: false,
        },
    },
    response: {
        encrypt: false,
        maxPayloadSize: 0,
    },
    scope: {
        type: "string",
        connectorId: "string",
        resourceId: "string",
        spaceId: "string",
    },
    name: "string",
    stream: {
        encrypt: false,
    },
});

    type: formal:LogConfiguration
properties:
    encryptionKeyId: string
    name: string
    request:
        encrypt: false
        maxPayloadSize: 0
        sql:
            encrypt: false
            stripValues: false
    response:
        encrypt: false
        maxPayloadSize: 0
    scope:
        connectorId: string
        resourceId: string
        spaceId: string
        type: string
    stream:
        encrypt: false

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

    EncryptionKeyId string
    The ID of the encryption key to use for this log configuration.
    Request Formal.Pulumi.Inputs.LogConfigurationRequest
    Request logging configuration.
    Response Formal.Pulumi.Inputs.LogConfigurationResponse
    Response logging configuration.
    Scope Formal.Pulumi.Inputs.LogConfigurationScope
    The scope configuration for this log configuration.
    Name string
    The name of this log configuration.
    Stream Formal.Pulumi.Inputs.LogConfigurationStream
    Stream logging configuration.
    EncryptionKeyId string
    The ID of the encryption key to use for this log configuration.
    Request LogConfigurationRequestArgs
    Request logging configuration.
    Response LogConfigurationResponseArgs
    Response logging configuration.
    Scope LogConfigurationScopeArgs
    The scope configuration for this log configuration.
    Name string
    The name of this log configuration.
    Stream LogConfigurationStreamArgs
    Stream logging configuration.
    encryptionKeyId String
    The ID of the encryption key to use for this log configuration.
    request LogConfigurationRequest
    Request logging configuration.
    response LogConfigurationResponse
    Response logging configuration.
    scope LogConfigurationScope
    The scope configuration for this log configuration.
    name String
    The name of this log configuration.
    stream LogConfigurationStream
    Stream logging configuration.
    encryptionKeyId string
    The ID of the encryption key to use for this log configuration.
    request LogConfigurationRequest
    Request logging configuration.
    response LogConfigurationResponse
    Response logging configuration.
    scope LogConfigurationScope
    The scope configuration for this log configuration.
    name string
    The name of this log configuration.
    stream LogConfigurationStream
    Stream logging configuration.
    encryption_key_id str
    The ID of the encryption key to use for this log configuration.
    request LogConfigurationRequestArgs
    Request logging configuration.
    response LogConfigurationResponseArgs
    Response logging configuration.
    scope LogConfigurationScopeArgs
    The scope configuration for this log configuration.
    name str
    The name of this log configuration.
    stream LogConfigurationStreamArgs
    Stream logging configuration.
    encryptionKeyId String
    The ID of the encryption key to use for this log configuration.
    request Property Map
    Request logging configuration.
    response Property Map
    Response logging configuration.
    scope Property Map
    The scope configuration for this log configuration.
    name String
    The name of this log configuration.
    stream Property Map
    Stream logging configuration.

    Outputs

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

    CreatedAt string
    When the log configuration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Last update time.
    CreatedAt string
    When the log configuration was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Last update time.
    createdAt String
    When the log configuration was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Last update time.
    createdAt string
    When the log configuration was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    Last update time.
    created_at str
    When the log configuration was created.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    Last update time.
    createdAt String
    When the log configuration was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Last update time.

    Look up Existing LogConfiguration Resource

    Get an existing LogConfiguration 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?: LogConfigurationState, opts?: CustomResourceOptions): LogConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        encryption_key_id: Optional[str] = None,
        name: Optional[str] = None,
        request: Optional[LogConfigurationRequestArgs] = None,
        response: Optional[LogConfigurationResponseArgs] = None,
        scope: Optional[LogConfigurationScopeArgs] = None,
        stream: Optional[LogConfigurationStreamArgs] = None,
        updated_at: Optional[str] = None) -> LogConfiguration
    func GetLogConfiguration(ctx *Context, name string, id IDInput, state *LogConfigurationState, opts ...ResourceOption) (*LogConfiguration, error)
    public static LogConfiguration Get(string name, Input<string> id, LogConfigurationState? state, CustomResourceOptions? opts = null)
    public static LogConfiguration get(String name, Output<String> id, LogConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: formal:LogConfiguration    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:
    CreatedAt string
    When the log configuration was created.
    EncryptionKeyId string
    The ID of the encryption key to use for this log configuration.
    Name string
    The name of this log configuration.
    Request Formal.Pulumi.Inputs.LogConfigurationRequest
    Request logging configuration.
    Response Formal.Pulumi.Inputs.LogConfigurationResponse
    Response logging configuration.
    Scope Formal.Pulumi.Inputs.LogConfigurationScope
    The scope configuration for this log configuration.
    Stream Formal.Pulumi.Inputs.LogConfigurationStream
    Stream logging configuration.
    UpdatedAt string
    Last update time.
    CreatedAt string
    When the log configuration was created.
    EncryptionKeyId string
    The ID of the encryption key to use for this log configuration.
    Name string
    The name of this log configuration.
    Request LogConfigurationRequestArgs
    Request logging configuration.
    Response LogConfigurationResponseArgs
    Response logging configuration.
    Scope LogConfigurationScopeArgs
    The scope configuration for this log configuration.
    Stream LogConfigurationStreamArgs
    Stream logging configuration.
    UpdatedAt string
    Last update time.
    createdAt String
    When the log configuration was created.
    encryptionKeyId String
    The ID of the encryption key to use for this log configuration.
    name String
    The name of this log configuration.
    request LogConfigurationRequest
    Request logging configuration.
    response LogConfigurationResponse
    Response logging configuration.
    scope LogConfigurationScope
    The scope configuration for this log configuration.
    stream LogConfigurationStream
    Stream logging configuration.
    updatedAt String
    Last update time.
    createdAt string
    When the log configuration was created.
    encryptionKeyId string
    The ID of the encryption key to use for this log configuration.
    name string
    The name of this log configuration.
    request LogConfigurationRequest
    Request logging configuration.
    response LogConfigurationResponse
    Response logging configuration.
    scope LogConfigurationScope
    The scope configuration for this log configuration.
    stream LogConfigurationStream
    Stream logging configuration.
    updatedAt string
    Last update time.
    created_at str
    When the log configuration was created.
    encryption_key_id str
    The ID of the encryption key to use for this log configuration.
    name str
    The name of this log configuration.
    request LogConfigurationRequestArgs
    Request logging configuration.
    response LogConfigurationResponseArgs
    Response logging configuration.
    scope LogConfigurationScopeArgs
    The scope configuration for this log configuration.
    stream LogConfigurationStreamArgs
    Stream logging configuration.
    updated_at str
    Last update time.
    createdAt String
    When the log configuration was created.
    encryptionKeyId String
    The ID of the encryption key to use for this log configuration.
    name String
    The name of this log configuration.
    request Property Map
    Request logging configuration.
    response Property Map
    Response logging configuration.
    scope Property Map
    The scope configuration for this log configuration.
    stream Property Map
    Stream logging configuration.
    updatedAt String
    Last update time.

    Supporting Types

    LogConfigurationRequest, LogConfigurationRequestArgs

    Encrypt bool
    Whether to encrypt request payloads.
    MaxPayloadSize int
    Maximum size of request payloads to log.
    Sql Formal.Pulumi.Inputs.LogConfigurationRequestSql
    SQL logging configuration for requests.
    Encrypt bool
    Whether to encrypt request payloads.
    MaxPayloadSize int
    Maximum size of request payloads to log.
    Sql LogConfigurationRequestSql
    SQL logging configuration for requests.
    encrypt Boolean
    Whether to encrypt request payloads.
    maxPayloadSize Integer
    Maximum size of request payloads to log.
    sql LogConfigurationRequestSql
    SQL logging configuration for requests.
    encrypt boolean
    Whether to encrypt request payloads.
    maxPayloadSize number
    Maximum size of request payloads to log.
    sql LogConfigurationRequestSql
    SQL logging configuration for requests.
    encrypt bool
    Whether to encrypt request payloads.
    max_payload_size int
    Maximum size of request payloads to log.
    sql LogConfigurationRequestSql
    SQL logging configuration for requests.
    encrypt Boolean
    Whether to encrypt request payloads.
    maxPayloadSize Number
    Maximum size of request payloads to log.
    sql Property Map
    SQL logging configuration for requests.

    LogConfigurationRequestSql, LogConfigurationRequestSqlArgs

    Encrypt bool
    Whether to encrypt SQL queries in logs.
    StripValues bool
    Whether to obfuscate SQL queries in logs.
    Encrypt bool
    Whether to encrypt SQL queries in logs.
    StripValues bool
    Whether to obfuscate SQL queries in logs.
    encrypt Boolean
    Whether to encrypt SQL queries in logs.
    stripValues Boolean
    Whether to obfuscate SQL queries in logs.
    encrypt boolean
    Whether to encrypt SQL queries in logs.
    stripValues boolean
    Whether to obfuscate SQL queries in logs.
    encrypt bool
    Whether to encrypt SQL queries in logs.
    strip_values bool
    Whether to obfuscate SQL queries in logs.
    encrypt Boolean
    Whether to encrypt SQL queries in logs.
    stripValues Boolean
    Whether to obfuscate SQL queries in logs.

    LogConfigurationResponse, LogConfigurationResponseArgs

    Encrypt bool
    Whether to encrypt response payloads.
    MaxPayloadSize int
    Maximum size of response payloads to log.
    Encrypt bool
    Whether to encrypt response payloads.
    MaxPayloadSize int
    Maximum size of response payloads to log.
    encrypt Boolean
    Whether to encrypt response payloads.
    maxPayloadSize Integer
    Maximum size of response payloads to log.
    encrypt boolean
    Whether to encrypt response payloads.
    maxPayloadSize number
    Maximum size of response payloads to log.
    encrypt bool
    Whether to encrypt response payloads.
    max_payload_size int
    Maximum size of response payloads to log.
    encrypt Boolean
    Whether to encrypt response payloads.
    maxPayloadSize Number
    Maximum size of response payloads to log.

    LogConfigurationScope, LogConfigurationScopeArgs

    Type string
    The type of scope (resource, connector, space, org).
    ConnectorId string
    The ID of the connector (required when type is connector).
    ResourceId string
    The ID of the resource (required when type is resource).
    SpaceId string
    The ID of the space (required when type is space).
    Type string
    The type of scope (resource, connector, space, org).
    ConnectorId string
    The ID of the connector (required when type is connector).
    ResourceId string
    The ID of the resource (required when type is resource).
    SpaceId string
    The ID of the space (required when type is space).
    type String
    The type of scope (resource, connector, space, org).
    connectorId String
    The ID of the connector (required when type is connector).
    resourceId String
    The ID of the resource (required when type is resource).
    spaceId String
    The ID of the space (required when type is space).
    type string
    The type of scope (resource, connector, space, org).
    connectorId string
    The ID of the connector (required when type is connector).
    resourceId string
    The ID of the resource (required when type is resource).
    spaceId string
    The ID of the space (required when type is space).
    type str
    The type of scope (resource, connector, space, org).
    connector_id str
    The ID of the connector (required when type is connector).
    resource_id str
    The ID of the resource (required when type is resource).
    space_id str
    The ID of the space (required when type is space).
    type String
    The type of scope (resource, connector, space, org).
    connectorId String
    The ID of the connector (required when type is connector).
    resourceId String
    The ID of the resource (required when type is resource).
    spaceId String
    The ID of the space (required when type is space).

    LogConfigurationStream, LogConfigurationStreamArgs

    Encrypt bool
    Whether to encrypt stream data.
    Encrypt bool
    Whether to encrypt stream data.
    encrypt Boolean
    Whether to encrypt stream data.
    encrypt boolean
    Whether to encrypt stream data.
    encrypt bool
    Whether to encrypt stream data.
    encrypt Boolean
    Whether to encrypt stream data.

    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