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

ibm.getIsFlowLog

Explore with Pulumi AI

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

    Retrieve an information of VPC flow log. For more information, about VPC flow log, see about IBM Cloud flow logs for VPC.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = ibm.getIsFlowLog({
        identifier: ibm_is_flow_log.example.id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_flow_log(identifier=ibm_is_flow_log["example"]["id"])
    
    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.LookupIsFlowLog(ctx, &ibm.LookupIsFlowLogArgs{
    			Identifier: pulumi.StringRef(ibm_is_flow_log.Example.Id),
    		}, 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 example = Ibm.GetIsFlowLog.Invoke(new()
        {
            Identifier = ibm_is_flow_log.Example.Id,
        });
    
    });
    
    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.GetIsFlowLogArgs;
    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 example = IbmFunctions.getIsFlowLog(GetIsFlowLogArgs.builder()
                .identifier(ibm_is_flow_log.example().id())
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsFlowLog
          arguments:
            identifier: ${ibm_is_flow_log.example.id}
    

    Using getIsFlowLog

    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 getIsFlowLog(args: GetIsFlowLogArgs, opts?: InvokeOptions): Promise<GetIsFlowLogResult>
    function getIsFlowLogOutput(args: GetIsFlowLogOutputArgs, opts?: InvokeOptions): Output<GetIsFlowLogResult>
    def get_is_flow_log(id: Optional[str] = None,
                        identifier: Optional[str] = None,
                        name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetIsFlowLogResult
    def get_is_flow_log_output(id: Optional[pulumi.Input[str]] = None,
                        identifier: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetIsFlowLogResult]
    func LookupIsFlowLog(ctx *Context, args *LookupIsFlowLogArgs, opts ...InvokeOption) (*LookupIsFlowLogResult, error)
    func LookupIsFlowLogOutput(ctx *Context, args *LookupIsFlowLogOutputArgs, opts ...InvokeOption) LookupIsFlowLogResultOutput

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

    public static class GetIsFlowLog 
    {
        public static Task<GetIsFlowLogResult> InvokeAsync(GetIsFlowLogArgs args, InvokeOptions? opts = null)
        public static Output<GetIsFlowLogResult> Invoke(GetIsFlowLogInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsFlowLogResult> getIsFlowLog(GetIsFlowLogArgs args, InvokeOptions options)
    public static Output<GetIsFlowLogResult> getIsFlowLog(GetIsFlowLogArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsFlowLog:getIsFlowLog
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    (String) The unique identifier for this VPC.
    Identifier string
    The ID of the flow log collector, This is required when name is not specified.
    Name string
    The name of the flow log collector, This is required when identifier is not specified.
    Id string
    (String) The unique identifier for this VPC.
    Identifier string
    The ID of the flow log collector, This is required when name is not specified.
    Name string
    The name of the flow log collector, This is required when identifier is not specified.
    id String
    (String) The unique identifier for this VPC.
    identifier String
    The ID of the flow log collector, This is required when name is not specified.
    name String
    The name of the flow log collector, This is required when identifier is not specified.
    id string
    (String) The unique identifier for this VPC.
    identifier string
    The ID of the flow log collector, This is required when name is not specified.
    name string
    The name of the flow log collector, This is required when identifier is not specified.
    id str
    (String) The unique identifier for this VPC.
    identifier str
    The ID of the flow log collector, This is required when name is not specified.
    name str
    The name of the flow log collector, This is required when identifier is not specified.
    id String
    (String) The unique identifier for this VPC.
    identifier String
    The ID of the flow log collector, This is required when name is not specified.
    name String
    The name of the flow log collector, This is required when identifier is not specified.

    getIsFlowLog Result

    The following output properties are available:

    AccessTags List<string>
    (String) Access management tags associated for flow log.
    Active bool
    (Boolean) Indicates whether this collector is active.
    AutoDelete bool
    (Boolean) If set to true, this flow log collector will be automatically deleted when the target is deleted.
    CreatedAt string
    (String) The date and time that the flow log collector was created.
    Crn string
    (String) The CRN for this VPC.
    Href string
    (String) The URL for this VPC.
    Id string
    (String) The unique identifier for this VPC.
    LifecycleState string
    (String) The lifecycle state of the flow log collector.
    ResourceGroups List<GetIsFlowLogResourceGroup>
    (List) The resource group object, for this flow log collector.
    StorageBuckets List<GetIsFlowLogStorageBucket>
    (Required, List) The Cloud Object Storage bucket where the collected flows are logged.
    Targets List<GetIsFlowLogTarget>
    (List) The target this collector is collecting flow logs for. If the target is an instance,subnet, or VPC, flow logs will not be collected for any network interfaces within the target that are themselves the target of a more specific flow log collector.
    Vpcs List<GetIsFlowLogVpc>
    (List) The VPC this flow log collector is associated with.
    Identifier string
    The unique identifier of the FlowLogCollector.
    Name string
    (String) The unique user-defined name for this VPC.
    AccessTags []string
    (String) Access management tags associated for flow log.
    Active bool
    (Boolean) Indicates whether this collector is active.
    AutoDelete bool
    (Boolean) If set to true, this flow log collector will be automatically deleted when the target is deleted.
    CreatedAt string
    (String) The date and time that the flow log collector was created.
    Crn string
    (String) The CRN for this VPC.
    Href string
    (String) The URL for this VPC.
    Id string
    (String) The unique identifier for this VPC.
    LifecycleState string
    (String) The lifecycle state of the flow log collector.
    ResourceGroups []GetIsFlowLogResourceGroup
    (List) The resource group object, for this flow log collector.
    StorageBuckets []GetIsFlowLogStorageBucket
    (Required, List) The Cloud Object Storage bucket where the collected flows are logged.
    Targets []GetIsFlowLogTarget
    (List) The target this collector is collecting flow logs for. If the target is an instance,subnet, or VPC, flow logs will not be collected for any network interfaces within the target that are themselves the target of a more specific flow log collector.
    Vpcs []GetIsFlowLogVpc
    (List) The VPC this flow log collector is associated with.
    Identifier string
    The unique identifier of the FlowLogCollector.
    Name string
    (String) The unique user-defined name for this VPC.
    accessTags List<String>
    (String) Access management tags associated for flow log.
    active Boolean
    (Boolean) Indicates whether this collector is active.
    autoDelete Boolean
    (Boolean) If set to true, this flow log collector will be automatically deleted when the target is deleted.
    createdAt String
    (String) The date and time that the flow log collector was created.
    crn String
    (String) The CRN for this VPC.
    href String
    (String) The URL for this VPC.
    id String
    (String) The unique identifier for this VPC.
    lifecycleState String
    (String) The lifecycle state of the flow log collector.
    resourceGroups List<GetIsFlowLogResourceGroup>
    (List) The resource group object, for this flow log collector.
    storageBuckets List<GetIsFlowLogStorageBucket>
    (Required, List) The Cloud Object Storage bucket where the collected flows are logged.
    targets List<GetIsFlowLogTarget>
    (List) The target this collector is collecting flow logs for. If the target is an instance,subnet, or VPC, flow logs will not be collected for any network interfaces within the target that are themselves the target of a more specific flow log collector.
    vpcs List<GetIsFlowLogVpc>
    (List) The VPC this flow log collector is associated with.
    identifier String
    The unique identifier of the FlowLogCollector.
    name String
    (String) The unique user-defined name for this VPC.
    accessTags string[]
    (String) Access management tags associated for flow log.
    active boolean
    (Boolean) Indicates whether this collector is active.
    autoDelete boolean
    (Boolean) If set to true, this flow log collector will be automatically deleted when the target is deleted.
    createdAt string
    (String) The date and time that the flow log collector was created.
    crn string
    (String) The CRN for this VPC.
    href string
    (String) The URL for this VPC.
    id string
    (String) The unique identifier for this VPC.
    lifecycleState string
    (String) The lifecycle state of the flow log collector.
    resourceGroups GetIsFlowLogResourceGroup[]
    (List) The resource group object, for this flow log collector.
    storageBuckets GetIsFlowLogStorageBucket[]
    (Required, List) The Cloud Object Storage bucket where the collected flows are logged.
    targets GetIsFlowLogTarget[]
    (List) The target this collector is collecting flow logs for. If the target is an instance,subnet, or VPC, flow logs will not be collected for any network interfaces within the target that are themselves the target of a more specific flow log collector.
    vpcs GetIsFlowLogVpc[]
    (List) The VPC this flow log collector is associated with.
    identifier string
    The unique identifier of the FlowLogCollector.
    name string
    (String) The unique user-defined name for this VPC.
    access_tags Sequence[str]
    (String) Access management tags associated for flow log.
    active bool
    (Boolean) Indicates whether this collector is active.
    auto_delete bool
    (Boolean) If set to true, this flow log collector will be automatically deleted when the target is deleted.
    created_at str
    (String) The date and time that the flow log collector was created.
    crn str
    (String) The CRN for this VPC.
    href str
    (String) The URL for this VPC.
    id str
    (String) The unique identifier for this VPC.
    lifecycle_state str
    (String) The lifecycle state of the flow log collector.
    resource_groups Sequence[GetIsFlowLogResourceGroup]
    (List) The resource group object, for this flow log collector.
    storage_buckets Sequence[GetIsFlowLogStorageBucket]
    (Required, List) The Cloud Object Storage bucket where the collected flows are logged.
    targets Sequence[GetIsFlowLogTarget]
    (List) The target this collector is collecting flow logs for. If the target is an instance,subnet, or VPC, flow logs will not be collected for any network interfaces within the target that are themselves the target of a more specific flow log collector.
    vpcs Sequence[GetIsFlowLogVpc]
    (List) The VPC this flow log collector is associated with.
    identifier str
    The unique identifier of the FlowLogCollector.
    name str
    (String) The unique user-defined name for this VPC.
    accessTags List<String>
    (String) Access management tags associated for flow log.
    active Boolean
    (Boolean) Indicates whether this collector is active.
    autoDelete Boolean
    (Boolean) If set to true, this flow log collector will be automatically deleted when the target is deleted.
    createdAt String
    (String) The date and time that the flow log collector was created.
    crn String
    (String) The CRN for this VPC.
    href String
    (String) The URL for this VPC.
    id String
    (String) The unique identifier for this VPC.
    lifecycleState String
    (String) The lifecycle state of the flow log collector.
    resourceGroups List<Property Map>
    (List) The resource group object, for this flow log collector.
    storageBuckets List<Property Map>
    (Required, List) The Cloud Object Storage bucket where the collected flows are logged.
    targets List<Property Map>
    (List) The target this collector is collecting flow logs for. If the target is an instance,subnet, or VPC, flow logs will not be collected for any network interfaces within the target that are themselves the target of a more specific flow log collector.
    vpcs List<Property Map>
    (List) The VPC this flow log collector is associated with.
    identifier String
    The unique identifier of the FlowLogCollector.
    name String
    (String) The unique user-defined name for this VPC.

    Supporting Types

    GetIsFlowLogResourceGroup

    Href string
    (String) The URL for this VPC.
    Id string
    (String) The unique identifier for this VPC.
    Name string
    The name of the flow log collector, This is required when identifier is not specified.
    Href string
    (String) The URL for this VPC.
    Id string
    (String) The unique identifier for this VPC.
    Name string
    The name of the flow log collector, This is required when identifier is not specified.
    href String
    (String) The URL for this VPC.
    id String
    (String) The unique identifier for this VPC.
    name String
    The name of the flow log collector, This is required when identifier is not specified.
    href string
    (String) The URL for this VPC.
    id string
    (String) The unique identifier for this VPC.
    name string
    The name of the flow log collector, This is required when identifier is not specified.
    href str
    (String) The URL for this VPC.
    id str
    (String) The unique identifier for this VPC.
    name str
    The name of the flow log collector, This is required when identifier is not specified.
    href String
    (String) The URL for this VPC.
    id String
    (String) The unique identifier for this VPC.
    name String
    The name of the flow log collector, This is required when identifier is not specified.

    GetIsFlowLogStorageBucket

    Name string
    The name of the flow log collector, This is required when identifier is not specified.
    Name string
    The name of the flow log collector, This is required when identifier is not specified.
    name String
    The name of the flow log collector, This is required when identifier is not specified.
    name string
    The name of the flow log collector, This is required when identifier is not specified.
    name str
    The name of the flow log collector, This is required when identifier is not specified.
    name String
    The name of the flow log collector, This is required when identifier is not specified.

    GetIsFlowLogTarget

    Crn string
    (String) The CRN for this VPC.
    Deleteds List<GetIsFlowLogTargetDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this VPC.
    Id string
    (String) The unique identifier for this VPC.
    Name string
    The name of the flow log collector, This is required when identifier is not specified.
    ResourceType string
    (String) The resource type. Allowable values are: network_interface.
    Crn string
    (String) The CRN for this VPC.
    Deleteds []GetIsFlowLogTargetDeleted
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this VPC.
    Id string
    (String) The unique identifier for this VPC.
    Name string
    The name of the flow log collector, This is required when identifier is not specified.
    ResourceType string
    (String) The resource type. Allowable values are: network_interface.
    crn String
    (String) The CRN for this VPC.
    deleteds List<GetIsFlowLogTargetDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this VPC.
    id String
    (String) The unique identifier for this VPC.
    name String
    The name of the flow log collector, This is required when identifier is not specified.
    resourceType String
    (String) The resource type. Allowable values are: network_interface.
    crn string
    (String) The CRN for this VPC.
    deleteds GetIsFlowLogTargetDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href string
    (String) The URL for this VPC.
    id string
    (String) The unique identifier for this VPC.
    name string
    The name of the flow log collector, This is required when identifier is not specified.
    resourceType string
    (String) The resource type. Allowable values are: network_interface.
    crn str
    (String) The CRN for this VPC.
    deleteds Sequence[GetIsFlowLogTargetDeleted]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href str
    (String) The URL for this VPC.
    id str
    (String) The unique identifier for this VPC.
    name str
    The name of the flow log collector, This is required when identifier is not specified.
    resource_type str
    (String) The resource type. Allowable values are: network_interface.
    crn String
    (String) The CRN for this VPC.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this VPC.
    id String
    (String) The unique identifier for this VPC.
    name String
    The name of the flow log collector, This is required when identifier is not specified.
    resourceType String
    (String) The resource type. Allowable values are: network_interface.

    GetIsFlowLogTargetDeleted

    MoreInfo string
    (String) Link to documentation about deleted resources.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.
    moreInfo string
    (String) Link to documentation about deleted resources.
    more_info str
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.

    GetIsFlowLogVpc

    Crn string
    (String) The CRN for this VPC.
    Deleteds List<GetIsFlowLogVpcDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this VPC.
    Id string
    (String) The unique identifier for this VPC.
    Name string
    The name of the flow log collector, This is required when identifier is not specified.
    Crn string
    (String) The CRN for this VPC.
    Deleteds []GetIsFlowLogVpcDeleted
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this VPC.
    Id string
    (String) The unique identifier for this VPC.
    Name string
    The name of the flow log collector, This is required when identifier is not specified.
    crn String
    (String) The CRN for this VPC.
    deleteds List<GetIsFlowLogVpcDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this VPC.
    id String
    (String) The unique identifier for this VPC.
    name String
    The name of the flow log collector, This is required when identifier is not specified.
    crn string
    (String) The CRN for this VPC.
    deleteds GetIsFlowLogVpcDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href string
    (String) The URL for this VPC.
    id string
    (String) The unique identifier for this VPC.
    name string
    The name of the flow log collector, This is required when identifier is not specified.
    crn str
    (String) The CRN for this VPC.
    deleteds Sequence[GetIsFlowLogVpcDeleted]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href str
    (String) The URL for this VPC.
    id str
    (String) The unique identifier for this VPC.
    name str
    The name of the flow log collector, This is required when identifier is not specified.
    crn String
    (String) The CRN for this VPC.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this VPC.
    id String
    (String) The unique identifier for this VPC.
    name String
    The name of the flow log collector, This is required when identifier is not specified.

    GetIsFlowLogVpcDeleted

    MoreInfo string
    (String) Link to documentation about deleted resources.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.
    moreInfo string
    (String) Link to documentation about deleted resources.
    more_info str
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.

    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