1. Packages
  2. Ibm Provider
  3. API Docs
  4. getLogsEnrichments
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getLogsEnrichments

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Provides a read-only data source to retrieve information about logs_enrichments. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const logsEnrichments = ibm.getLogsEnrichments({
        instanceId: ibm_resource_instance.logs_instance.guid,
        region: ibm_resource_instance.logs_instance.location,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    logs_enrichments = ibm.get_logs_enrichments(instance_id=ibm_resource_instance["logs_instance"]["guid"],
        region=ibm_resource_instance["logs_instance"]["location"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetLogsEnrichments(ctx, &ibm.GetLogsEnrichmentsArgs{
    			InstanceId: ibm_resource_instance.Logs_instance.Guid,
    			Region:     pulumi.StringRef(ibm_resource_instance.Logs_instance.Location),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var logsEnrichments = Ibm.GetLogsEnrichments.Invoke(new()
        {
            InstanceId = ibm_resource_instance.Logs_instance.Guid,
            Region = ibm_resource_instance.Logs_instance.Location,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetLogsEnrichmentsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var logsEnrichments = IbmFunctions.getLogsEnrichments(GetLogsEnrichmentsArgs.builder()
                .instanceId(ibm_resource_instance.logs_instance().guid())
                .region(ibm_resource_instance.logs_instance().location())
                .build());
    
        }
    }
    
    variables:
      logsEnrichments:
        fn::invoke:
          function: ibm:getLogsEnrichments
          arguments:
            instanceId: ${ibm_resource_instance.logs_instance.guid}
            region: ${ibm_resource_instance.logs_instance.location}
    

    Using getLogsEnrichments

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLogsEnrichments(args: GetLogsEnrichmentsArgs, opts?: InvokeOptions): Promise<GetLogsEnrichmentsResult>
    function getLogsEnrichmentsOutput(args: GetLogsEnrichmentsOutputArgs, opts?: InvokeOptions): Output<GetLogsEnrichmentsResult>
    def get_logs_enrichments(endpoint_type: Optional[str] = None,
                             id: Optional[str] = None,
                             instance_id: Optional[str] = None,
                             region: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetLogsEnrichmentsResult
    def get_logs_enrichments_output(endpoint_type: Optional[pulumi.Input[str]] = None,
                             id: Optional[pulumi.Input[str]] = None,
                             instance_id: Optional[pulumi.Input[str]] = None,
                             region: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetLogsEnrichmentsResult]
    func GetLogsEnrichments(ctx *Context, args *GetLogsEnrichmentsArgs, opts ...InvokeOption) (*GetLogsEnrichmentsResult, error)
    func GetLogsEnrichmentsOutput(ctx *Context, args *GetLogsEnrichmentsOutputArgs, opts ...InvokeOption) GetLogsEnrichmentsResultOutput

    > Note: This function is named GetLogsEnrichments in the Go SDK.

    public static class GetLogsEnrichments 
    {
        public static Task<GetLogsEnrichmentsResult> InvokeAsync(GetLogsEnrichmentsArgs args, InvokeOptions? opts = null)
        public static Output<GetLogsEnrichmentsResult> Invoke(GetLogsEnrichmentsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLogsEnrichmentsResult> getLogsEnrichments(GetLogsEnrichmentsArgs args, InvokeOptions options)
    public static Output<GetLogsEnrichmentsResult> getLogsEnrichments(GetLogsEnrichmentsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getLogsEnrichments:getLogsEnrichments
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    Cloud Logs Instance GUID.
    EndpointType string
    Id string
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    Region string
    Cloud Logs Instance Region.
    InstanceId string
    Cloud Logs Instance GUID.
    EndpointType string
    Id string
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    Region string
    Cloud Logs Instance Region.
    instanceId String
    Cloud Logs Instance GUID.
    endpointType String
    id String
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    region String
    Cloud Logs Instance Region.
    instanceId string
    Cloud Logs Instance GUID.
    endpointType string
    id string
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    region string
    Cloud Logs Instance Region.
    instance_id str
    Cloud Logs Instance GUID.
    endpoint_type str
    id str
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    region str
    Cloud Logs Instance Region.
    instanceId String
    Cloud Logs Instance GUID.
    endpointType String
    id String
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    region String
    Cloud Logs Instance Region.

    getLogsEnrichments Result

    The following output properties are available:

    Enrichments List<GetLogsEnrichmentsEnrichment>
    (List) The enrichments.

    • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for enrichments:
    Id string
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    InstanceId string
    Region string
    EndpointType string
    Enrichments []GetLogsEnrichmentsEnrichment
    (List) The enrichments.

    • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for enrichments:
    Id string
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    InstanceId string
    Region string
    EndpointType string
    enrichments List<GetLogsEnrichmentsEnrichment>
    (List) The enrichments.

    • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for enrichments:
    id String
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    instanceId String
    region String
    endpointType String
    enrichments GetLogsEnrichmentsEnrichment[]
    (List) The enrichments.

    • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for enrichments:
    id string
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    instanceId string
    region string
    endpointType string
    enrichments Sequence[GetLogsEnrichmentsEnrichment]
    (List) The enrichments.

    • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for enrichments:
    id str
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    instance_id str
    region str
    endpoint_type str
    enrichments List<Property Map>
    (List) The enrichments.

    • Constraints: The maximum length is 4096 items. The minimum length is 0 items. Nested schema for enrichments:
    id String
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    instanceId String
    region String
    endpointType String

    Supporting Types

    GetLogsEnrichmentsEnrichment

    EnrichmentTypes List<GetLogsEnrichmentsEnrichmentEnrichmentType>
    (List) The enrichment type. Nested schema for enrichment_type:
    FieldName string
    (String) The enrichment field name.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    Id double
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    EnrichmentTypes []GetLogsEnrichmentsEnrichmentEnrichmentType
    (List) The enrichment type. Nested schema for enrichment_type:
    FieldName string
    (String) The enrichment field name.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    Id float64
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    enrichmentTypes List<GetLogsEnrichmentsEnrichmentEnrichmentType>
    (List) The enrichment type. Nested schema for enrichment_type:
    fieldName String
    (String) The enrichment field name.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    id Double
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    enrichmentTypes GetLogsEnrichmentsEnrichmentEnrichmentType[]
    (List) The enrichment type. Nested schema for enrichment_type:
    fieldName string
    (String) The enrichment field name.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    id number
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    enrichment_types Sequence[GetLogsEnrichmentsEnrichmentEnrichmentType]
    (List) The enrichment type. Nested schema for enrichment_type:
    field_name str
    (String) The enrichment field name.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    id float
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    enrichmentTypes List<Property Map>
    (List) The enrichment type. Nested schema for enrichment_type:
    fieldName String
    (String) The enrichment field name.

    • Constraints: The maximum length is 4096 characters. The minimum length is 1 character. The value must match regular expression ^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$.
    id Number
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.

    GetLogsEnrichmentsEnrichmentEnrichmentType

    CustomEnrichments List<GetLogsEnrichmentsEnrichmentEnrichmentTypeCustomEnrichment>
    (List) The custom enrichment. Nested schema for custom_enrichment:
    GeoIps List<GetLogsEnrichmentsEnrichmentEnrichmentTypeGeoIp>
    (List) The geo ip enrichment. Nested schema for geo_ip:
    SuspiciousIps List<GetLogsEnrichmentsEnrichmentEnrichmentTypeSuspiciousIp>
    (List) The suspicious ip enrichment. Nested schema for suspicious_ip:
    CustomEnrichments []GetLogsEnrichmentsEnrichmentEnrichmentTypeCustomEnrichment
    (List) The custom enrichment. Nested schema for custom_enrichment:
    GeoIps []GetLogsEnrichmentsEnrichmentEnrichmentTypeGeoIp
    (List) The geo ip enrichment. Nested schema for geo_ip:
    SuspiciousIps []GetLogsEnrichmentsEnrichmentEnrichmentTypeSuspiciousIp
    (List) The suspicious ip enrichment. Nested schema for suspicious_ip:
    customEnrichments List<GetLogsEnrichmentsEnrichmentEnrichmentTypeCustomEnrichment>
    (List) The custom enrichment. Nested schema for custom_enrichment:
    geoIps List<GetLogsEnrichmentsEnrichmentEnrichmentTypeGeoIp>
    (List) The geo ip enrichment. Nested schema for geo_ip:
    suspiciousIps List<GetLogsEnrichmentsEnrichmentEnrichmentTypeSuspiciousIp>
    (List) The suspicious ip enrichment. Nested schema for suspicious_ip:
    customEnrichments GetLogsEnrichmentsEnrichmentEnrichmentTypeCustomEnrichment[]
    (List) The custom enrichment. Nested schema for custom_enrichment:
    geoIps GetLogsEnrichmentsEnrichmentEnrichmentTypeGeoIp[]
    (List) The geo ip enrichment. Nested schema for geo_ip:
    suspiciousIps GetLogsEnrichmentsEnrichmentEnrichmentTypeSuspiciousIp[]
    (List) The suspicious ip enrichment. Nested schema for suspicious_ip:
    custom_enrichments Sequence[GetLogsEnrichmentsEnrichmentEnrichmentTypeCustomEnrichment]
    (List) The custom enrichment. Nested schema for custom_enrichment:
    geo_ips Sequence[GetLogsEnrichmentsEnrichmentEnrichmentTypeGeoIp]
    (List) The geo ip enrichment. Nested schema for geo_ip:
    suspicious_ips Sequence[GetLogsEnrichmentsEnrichmentEnrichmentTypeSuspiciousIp]
    (List) The suspicious ip enrichment. Nested schema for suspicious_ip:
    customEnrichments List<Property Map>
    (List) The custom enrichment. Nested schema for custom_enrichment:
    geoIps List<Property Map>
    (List) The geo ip enrichment. Nested schema for geo_ip:
    suspiciousIps List<Property Map>
    (List) The suspicious ip enrichment. Nested schema for suspicious_ip:

    GetLogsEnrichmentsEnrichmentEnrichmentTypeCustomEnrichment

    Id double
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    Id float64
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    id Double
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    id number
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    id float
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.
    id Number
    (Integer) The enrichment ID.

    • Constraints: The maximum value is 4294967295. The minimum value is 0.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud