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

ibm.IsFlowLog

Explore with Pulumi AI

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

    Create, update, delete and suspend the flow log resource. For more information, about VPC flow log, see creating a flow log collector.

    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 exampleIsInstance = new ibm.IsInstance("exampleIsInstance", {
        image: ibm_is_image.example.id,
        profile: "bx2-2x8",
        primaryNetworkInterface: {
            subnet: ibm_is_subnet.example.id,
        },
        vpc: ibm_is_vpc.example.id,
        zone: "us-south-1",
        keys: [ibm_is_ssh_key.example.id],
    });
    const exampleResourceGroup = new ibm.ResourceGroup("exampleResourceGroup", {});
    const exampleResourceInstance = new ibm.ResourceInstance("exampleResourceInstance", {
        resourceGroupId: exampleResourceGroup.resourceGroupId,
        service: "cloud-object-storage",
        plan: "standard",
        location: "global",
    });
    const exampleCosBucket = new ibm.CosBucket("exampleCosBucket", {
        bucketName: "us-south-bucket-vpc1",
        resourceInstanceId: exampleResourceInstance.resourceInstanceId,
        regionLocation: _var.region,
        storageClass: "standard",
    });
    const exampleIsFlowLog = new ibm.IsFlowLog("exampleIsFlowLog", {
        target: exampleIsInstance.isInstanceId,
        active: true,
        storageBucket: exampleCosBucket.bucketName,
    }, {
        dependsOn: [exampleCosBucket],
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example_is_instance = ibm.IsInstance("exampleIsInstance",
        image=ibm_is_image["example"]["id"],
        profile="bx2-2x8",
        primary_network_interface={
            "subnet": ibm_is_subnet["example"]["id"],
        },
        vpc=ibm_is_vpc["example"]["id"],
        zone="us-south-1",
        keys=[ibm_is_ssh_key["example"]["id"]])
    example_resource_group = ibm.ResourceGroup("exampleResourceGroup")
    example_resource_instance = ibm.ResourceInstance("exampleResourceInstance",
        resource_group_id=example_resource_group.resource_group_id,
        service="cloud-object-storage",
        plan="standard",
        location="global")
    example_cos_bucket = ibm.CosBucket("exampleCosBucket",
        bucket_name="us-south-bucket-vpc1",
        resource_instance_id=example_resource_instance.resource_instance_id,
        region_location=var["region"],
        storage_class="standard")
    example_is_flow_log = ibm.IsFlowLog("exampleIsFlowLog",
        target=example_is_instance.is_instance_id,
        active=True,
        storage_bucket=example_cos_bucket.bucket_name,
        opts = pulumi.ResourceOptions(depends_on=[example_cos_bucket]))
    
    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 {
    		exampleIsInstance, err := ibm.NewIsInstance(ctx, "exampleIsInstance", &ibm.IsInstanceArgs{
    			Image:   pulumi.Any(ibm_is_image.Example.Id),
    			Profile: pulumi.String("bx2-2x8"),
    			PrimaryNetworkInterface: &ibm.IsInstancePrimaryNetworkInterfaceArgs{
    				Subnet: pulumi.Any(ibm_is_subnet.Example.Id),
    			},
    			Vpc:  pulumi.Any(ibm_is_vpc.Example.Id),
    			Zone: pulumi.String("us-south-1"),
    			Keys: pulumi.StringArray{
    				ibm_is_ssh_key.Example.Id,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleResourceGroup, err := ibm.NewResourceGroup(ctx, "exampleResourceGroup", nil)
    		if err != nil {
    			return err
    		}
    		exampleResourceInstance, err := ibm.NewResourceInstance(ctx, "exampleResourceInstance", &ibm.ResourceInstanceArgs{
    			ResourceGroupId: exampleResourceGroup.ResourceGroupId,
    			Service:         pulumi.String("cloud-object-storage"),
    			Plan:            pulumi.String("standard"),
    			Location:        pulumi.String("global"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleCosBucket, err := ibm.NewCosBucket(ctx, "exampleCosBucket", &ibm.CosBucketArgs{
    			BucketName:         pulumi.String("us-south-bucket-vpc1"),
    			ResourceInstanceId: exampleResourceInstance.ResourceInstanceId,
    			RegionLocation:     pulumi.Any(_var.Region),
    			StorageClass:       pulumi.String("standard"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ibm.NewIsFlowLog(ctx, "exampleIsFlowLog", &ibm.IsFlowLogArgs{
    			Target:        exampleIsInstance.IsInstanceId,
    			Active:        pulumi.Bool(true),
    			StorageBucket: exampleCosBucket.BucketName,
    		}, pulumi.DependsOn([]pulumi.Resource{
    			exampleCosBucket,
    		}))
    		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 exampleIsInstance = new Ibm.IsInstance("exampleIsInstance", new()
        {
            Image = ibm_is_image.Example.Id,
            Profile = "bx2-2x8",
            PrimaryNetworkInterface = new Ibm.Inputs.IsInstancePrimaryNetworkInterfaceArgs
            {
                Subnet = ibm_is_subnet.Example.Id,
            },
            Vpc = ibm_is_vpc.Example.Id,
            Zone = "us-south-1",
            Keys = new[]
            {
                ibm_is_ssh_key.Example.Id,
            },
        });
    
        var exampleResourceGroup = new Ibm.ResourceGroup("exampleResourceGroup");
    
        var exampleResourceInstance = new Ibm.ResourceInstance("exampleResourceInstance", new()
        {
            ResourceGroupId = exampleResourceGroup.ResourceGroupId,
            Service = "cloud-object-storage",
            Plan = "standard",
            Location = "global",
        });
    
        var exampleCosBucket = new Ibm.CosBucket("exampleCosBucket", new()
        {
            BucketName = "us-south-bucket-vpc1",
            ResourceInstanceId = exampleResourceInstance.ResourceInstanceId,
            RegionLocation = @var.Region,
            StorageClass = "standard",
        });
    
        var exampleIsFlowLog = new Ibm.IsFlowLog("exampleIsFlowLog", new()
        {
            Target = exampleIsInstance.IsInstanceId,
            Active = true,
            StorageBucket = exampleCosBucket.BucketName,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                exampleCosBucket,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IsInstance;
    import com.pulumi.ibm.IsInstanceArgs;
    import com.pulumi.ibm.inputs.IsInstancePrimaryNetworkInterfaceArgs;
    import com.pulumi.ibm.ResourceGroup;
    import com.pulumi.ibm.ResourceInstance;
    import com.pulumi.ibm.ResourceInstanceArgs;
    import com.pulumi.ibm.CosBucket;
    import com.pulumi.ibm.CosBucketArgs;
    import com.pulumi.ibm.IsFlowLog;
    import com.pulumi.ibm.IsFlowLogArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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) {
            var exampleIsInstance = new IsInstance("exampleIsInstance", IsInstanceArgs.builder()
                .image(ibm_is_image.example().id())
                .profile("bx2-2x8")
                .primaryNetworkInterface(IsInstancePrimaryNetworkInterfaceArgs.builder()
                    .subnet(ibm_is_subnet.example().id())
                    .build())
                .vpc(ibm_is_vpc.example().id())
                .zone("us-south-1")
                .keys(ibm_is_ssh_key.example().id())
                .build());
    
            var exampleResourceGroup = new ResourceGroup("exampleResourceGroup");
    
            var exampleResourceInstance = new ResourceInstance("exampleResourceInstance", ResourceInstanceArgs.builder()
                .resourceGroupId(exampleResourceGroup.resourceGroupId())
                .service("cloud-object-storage")
                .plan("standard")
                .location("global")
                .build());
    
            var exampleCosBucket = new CosBucket("exampleCosBucket", CosBucketArgs.builder()
                .bucketName("us-south-bucket-vpc1")
                .resourceInstanceId(exampleResourceInstance.resourceInstanceId())
                .regionLocation(var_.region())
                .storageClass("standard")
                .build());
    
            var exampleIsFlowLog = new IsFlowLog("exampleIsFlowLog", IsFlowLogArgs.builder()
                .target(exampleIsInstance.isInstanceId())
                .active(true)
                .storageBucket(exampleCosBucket.bucketName())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(exampleCosBucket)
                    .build());
    
        }
    }
    
    resources:
      exampleIsInstance:
        type: ibm:IsInstance
        properties:
          image: ${ibm_is_image.example.id}
          profile: bx2-2x8
          primaryNetworkInterface:
            subnet: ${ibm_is_subnet.example.id}
          vpc: ${ibm_is_vpc.example.id}
          zone: us-south-1
          keys:
            - ${ibm_is_ssh_key.example.id}
      exampleResourceGroup:
        type: ibm:ResourceGroup
      exampleResourceInstance:
        type: ibm:ResourceInstance
        properties:
          resourceGroupId: ${exampleResourceGroup.resourceGroupId}
          service: cloud-object-storage
          plan: standard
          location: global
      exampleCosBucket:
        type: ibm:CosBucket
        properties:
          bucketName: us-south-bucket-vpc1
          resourceInstanceId: ${exampleResourceInstance.resourceInstanceId}
          regionLocation: ${var.region}
          storageClass: standard
      exampleIsFlowLog:
        type: ibm:IsFlowLog
        properties:
          target: ${exampleIsInstance.isInstanceId}
          active: true
          storageBucket: ${exampleCosBucket.bucketName}
        options:
          dependsOn:
            - ${exampleCosBucket}
    

    Create IsFlowLog Resource

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

    Constructor syntax

    new IsFlowLog(name: string, args: IsFlowLogArgs, opts?: CustomResourceOptions);
    @overload
    def IsFlowLog(resource_name: str,
                  args: IsFlowLogArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def IsFlowLog(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  storage_bucket: Optional[str] = None,
                  target: Optional[str] = None,
                  access_tags: Optional[Sequence[str]] = None,
                  active: Optional[bool] = None,
                  is_flow_log_id: Optional[str] = None,
                  name: Optional[str] = None,
                  resource_group: Optional[str] = None,
                  tags: Optional[Sequence[str]] = None,
                  timeouts: Optional[IsFlowLogTimeoutsArgs] = None)
    func NewIsFlowLog(ctx *Context, name string, args IsFlowLogArgs, opts ...ResourceOption) (*IsFlowLog, error)
    public IsFlowLog(string name, IsFlowLogArgs args, CustomResourceOptions? opts = null)
    public IsFlowLog(String name, IsFlowLogArgs args)
    public IsFlowLog(String name, IsFlowLogArgs args, CustomResourceOptions options)
    
    type: ibm:IsFlowLog
    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 IsFlowLogArgs
    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 IsFlowLogArgs
    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 IsFlowLogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsFlowLogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsFlowLogArgs
    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 isFlowLogResource = new Ibm.IsFlowLog("isFlowLogResource", new()
    {
        StorageBucket = "string",
        Target = "string",
        AccessTags = new[]
        {
            "string",
        },
        Active = false,
        IsFlowLogId = "string",
        Name = "string",
        ResourceGroup = "string",
        Tags = new[]
        {
            "string",
        },
        Timeouts = new Ibm.Inputs.IsFlowLogTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
    });
    
    example, err := ibm.NewIsFlowLog(ctx, "isFlowLogResource", &ibm.IsFlowLogArgs{
    	StorageBucket: pulumi.String("string"),
    	Target:        pulumi.String("string"),
    	AccessTags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Active:        pulumi.Bool(false),
    	IsFlowLogId:   pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	ResourceGroup: pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Timeouts: &ibm.IsFlowLogTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    })
    
    var isFlowLogResource = new IsFlowLog("isFlowLogResource", IsFlowLogArgs.builder()
        .storageBucket("string")
        .target("string")
        .accessTags("string")
        .active(false)
        .isFlowLogId("string")
        .name("string")
        .resourceGroup("string")
        .tags("string")
        .timeouts(IsFlowLogTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .build());
    
    is_flow_log_resource = ibm.IsFlowLog("isFlowLogResource",
        storage_bucket="string",
        target="string",
        access_tags=["string"],
        active=False,
        is_flow_log_id="string",
        name="string",
        resource_group="string",
        tags=["string"],
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        })
    
    const isFlowLogResource = new ibm.IsFlowLog("isFlowLogResource", {
        storageBucket: "string",
        target: "string",
        accessTags: ["string"],
        active: false,
        isFlowLogId: "string",
        name: "string",
        resourceGroup: "string",
        tags: ["string"],
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
    });
    
    type: ibm:IsFlowLog
    properties:
        accessTags:
            - string
        active: false
        isFlowLogId: string
        name: string
        resourceGroup: string
        storageBucket: string
        tags:
            - string
        target: string
        timeouts:
            create: string
            delete: string
            update: string
    

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

    StorageBucket string
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    Target string

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    AccessTags List<string>

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    Active bool
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    IsFlowLogId string
    (String) The unique identifier of the flow log collector.
    Name string
    The unique user-defined name for the flow log collector.
    ResourceGroup string
    The resource group ID where the flow log is created.
    Tags List<string>
    The tags associated with the flow log.
    Timeouts IsFlowLogTimeouts
    StorageBucket string
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    Target string

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    AccessTags []string

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    Active bool
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    IsFlowLogId string
    (String) The unique identifier of the flow log collector.
    Name string
    The unique user-defined name for the flow log collector.
    ResourceGroup string
    The resource group ID where the flow log is created.
    Tags []string
    The tags associated with the flow log.
    Timeouts IsFlowLogTimeoutsArgs
    storageBucket String
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    target String

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    accessTags List<String>

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    active Boolean
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    isFlowLogId String
    (String) The unique identifier of the flow log collector.
    name String
    The unique user-defined name for the flow log collector.
    resourceGroup String
    The resource group ID where the flow log is created.
    tags List<String>
    The tags associated with the flow log.
    timeouts IsFlowLogTimeouts
    storageBucket string
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    target string

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    accessTags string[]

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    active boolean
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    isFlowLogId string
    (String) The unique identifier of the flow log collector.
    name string
    The unique user-defined name for the flow log collector.
    resourceGroup string
    The resource group ID where the flow log is created.
    tags string[]
    The tags associated with the flow log.
    timeouts IsFlowLogTimeouts
    storage_bucket str
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    target str

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    access_tags Sequence[str]

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    active bool
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    is_flow_log_id str
    (String) The unique identifier of the flow log collector.
    name str
    The unique user-defined name for the flow log collector.
    resource_group str
    The resource group ID where the flow log is created.
    tags Sequence[str]
    The tags associated with the flow log.
    timeouts IsFlowLogTimeoutsArgs
    storageBucket String
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    target String

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    accessTags List<String>

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    active Boolean
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    isFlowLogId String
    (String) The unique identifier of the flow log collector.
    name String
    The unique user-defined name for the flow log collector.
    resourceGroup String
    The resource group ID where the flow log is created.
    tags List<String>
    The tags associated with the flow log.
    timeouts Property Map

    Outputs

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

    AutoDelete bool
    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 created.
    Crn string
    (String) The CRN of the flow log collector.
    Href string
    (String) The URL of the flow log collector.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleState string
    (String) The lifecycle state of the flow log collector.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Vpc string
    (String) The VPC of the flow log collector that is associated.
    AutoDelete bool
    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 created.
    Crn string
    (String) The CRN of the flow log collector.
    Href string
    (String) The URL of the flow log collector.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleState string
    (String) The lifecycle state of the flow log collector.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Vpc string
    (String) The VPC of the flow log collector that is associated.
    autoDelete 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 created.
    crn String
    (String) The CRN of the flow log collector.
    href String
    (String) The URL of the flow log collector.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleState String
    (String) The lifecycle state of the flow log collector.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    vpc String
    (String) The VPC of the flow log collector that is associated.
    autoDelete 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 created.
    crn string
    (String) The CRN of the flow log collector.
    href string
    (String) The URL of the flow log collector.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleState string
    (String) The lifecycle state of the flow log collector.
    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn string
    The crn of the resource
    resourceGroupName string
    The resource group name in which resource is provisioned
    resourceName string
    The name of the resource
    resourceStatus string
    The status of the resource
    vpc string
    (String) The VPC of the flow log collector that is associated.
    auto_delete bool
    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 created.
    crn str
    (String) The CRN of the flow log collector.
    href str
    (String) The URL of the flow log collector.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_state str
    (String) The lifecycle state of the flow log collector.
    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resource_crn str
    The crn of the resource
    resource_group_name str
    The resource group name in which resource is provisioned
    resource_name str
    The name of the resource
    resource_status str
    The status of the resource
    vpc str
    (String) The VPC of the flow log collector that is associated.
    autoDelete 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 created.
    crn String
    (String) The CRN of the flow log collector.
    href String
    (String) The URL of the flow log collector.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleState String
    (String) The lifecycle state of the flow log collector.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    vpc String
    (String) The VPC of the flow log collector that is associated.

    Look up Existing IsFlowLog Resource

    Get an existing IsFlowLog 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?: IsFlowLogState, opts?: CustomResourceOptions): IsFlowLog
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_tags: Optional[Sequence[str]] = None,
            active: Optional[bool] = None,
            auto_delete: Optional[bool] = None,
            created_at: Optional[str] = None,
            crn: Optional[str] = None,
            href: Optional[str] = None,
            is_flow_log_id: Optional[str] = None,
            lifecycle_state: Optional[str] = None,
            name: Optional[str] = None,
            resource_controller_url: Optional[str] = None,
            resource_crn: Optional[str] = None,
            resource_group: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            resource_name: Optional[str] = None,
            resource_status: Optional[str] = None,
            storage_bucket: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            target: Optional[str] = None,
            timeouts: Optional[IsFlowLogTimeoutsArgs] = None,
            vpc: Optional[str] = None) -> IsFlowLog
    func GetIsFlowLog(ctx *Context, name string, id IDInput, state *IsFlowLogState, opts ...ResourceOption) (*IsFlowLog, error)
    public static IsFlowLog Get(string name, Input<string> id, IsFlowLogState? state, CustomResourceOptions? opts = null)
    public static IsFlowLog get(String name, Output<String> id, IsFlowLogState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsFlowLog    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:
    AccessTags List<string>

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    Active bool
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    AutoDelete bool
    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 created.
    Crn string
    (String) The CRN of the flow log collector.
    Href string
    (String) The URL of the flow log collector.
    IsFlowLogId string
    (String) The unique identifier of the flow log collector.
    LifecycleState string
    (String) The lifecycle state of the flow log collector.
    Name string
    The unique user-defined name for the flow log collector.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroup string
    The resource group ID where the flow log is created.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    StorageBucket string
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    Tags List<string>
    The tags associated with the flow log.
    Target string

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    Timeouts IsFlowLogTimeouts
    Vpc string
    (String) The VPC of the flow log collector that is associated.
    AccessTags []string

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    Active bool
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    AutoDelete bool
    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 created.
    Crn string
    (String) The CRN of the flow log collector.
    Href string
    (String) The URL of the flow log collector.
    IsFlowLogId string
    (String) The unique identifier of the flow log collector.
    LifecycleState string
    (String) The lifecycle state of the flow log collector.
    Name string
    The unique user-defined name for the flow log collector.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroup string
    The resource group ID where the flow log is created.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    StorageBucket string
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    Tags []string
    The tags associated with the flow log.
    Target string

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    Timeouts IsFlowLogTimeoutsArgs
    Vpc string
    (String) The VPC of the flow log collector that is associated.
    accessTags List<String>

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    active Boolean
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    autoDelete 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 created.
    crn String
    (String) The CRN of the flow log collector.
    href String
    (String) The URL of the flow log collector.
    isFlowLogId String
    (String) The unique identifier of the flow log collector.
    lifecycleState String
    (String) The lifecycle state of the flow log collector.
    name String
    The unique user-defined name for the flow log collector.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroup String
    The resource group ID where the flow log is created.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    storageBucket String
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    tags List<String>
    The tags associated with the flow log.
    target String

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    timeouts IsFlowLogTimeouts
    vpc String
    (String) The VPC of the flow log collector that is associated.
    accessTags string[]

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    active boolean
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    autoDelete 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 created.
    crn string
    (String) The CRN of the flow log collector.
    href string
    (String) The URL of the flow log collector.
    isFlowLogId string
    (String) The unique identifier of the flow log collector.
    lifecycleState string
    (String) The lifecycle state of the flow log collector.
    name string
    The unique user-defined name for the flow log collector.
    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn string
    The crn of the resource
    resourceGroup string
    The resource group ID where the flow log is created.
    resourceGroupName string
    The resource group name in which resource is provisioned
    resourceName string
    The name of the resource
    resourceStatus string
    The status of the resource
    storageBucket string
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    tags string[]
    The tags associated with the flow log.
    target string

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    timeouts IsFlowLogTimeouts
    vpc string
    (String) The VPC of the flow log collector that is associated.
    access_tags Sequence[str]

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    active bool
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    auto_delete bool
    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 created.
    crn str
    (String) The CRN of the flow log collector.
    href str
    (String) The URL of the flow log collector.
    is_flow_log_id str
    (String) The unique identifier of the flow log collector.
    lifecycle_state str
    (String) The lifecycle state of the flow log collector.
    name str
    The unique user-defined name for the flow log collector.
    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resource_crn str
    The crn of the resource
    resource_group str
    The resource group ID where the flow log is created.
    resource_group_name str
    The resource group name in which resource is provisioned
    resource_name str
    The name of the resource
    resource_status str
    The status of the resource
    storage_bucket str
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    tags Sequence[str]
    The tags associated with the flow log.
    target str

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    timeouts IsFlowLogTimeoutsArgs
    vpc str
    (String) The VPC of the flow log collector that is associated.
    accessTags List<String>

    A list of access management tags to attach to the flow log.

    Note: You can attach only those access tags that already exists. For more information, about creating access tags, see working with tags. You must have the access listed in the Granting users access to tag resources for access_tags access_tags must be in the format key:value.

    active Boolean
    Indicates whether the collector is active. If false, this collector is created in inactive mode. Default value is true.
    autoDelete 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 created.
    crn String
    (String) The CRN of the flow log collector.
    href String
    (String) The URL of the flow log collector.
    isFlowLogId String
    (String) The unique identifier of the flow log collector.
    lifecycleState String
    (String) The lifecycle state of the flow log collector.
    name String
    The unique user-defined name for the flow log collector.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroup String
    The resource group ID where the flow log is created.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    storageBucket String
    The name of the IBM Cloud Object Storage bucket where the collected flows will be logged. The bucket must exist and an IAM service authorization must grant IBM Cloud flow logs resources of VPC infrastructure services writer access to the bucket.
    tags List<String>
    The tags associated with the flow log.
    target String

    The ID of the target to collect flow logs.

    Note: If the target is an instance network attachment, flow logs will be collected for that instance network attachment. If the target is an instance network interface, flow logs will be collected for that instance network interface. If the target is a virtual network interface, flow logs will be collected for the the virtual network interface's target resource if the resource is: - an instance network attachment. If the target is a virtual server instance, flow logs will be collected for all network attachments or network interfaces on that instance. If the target is a subnet, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to that subnet. If the target is a VPC, flow logs will be collected for all instance network interfaces and virtual network interfaces attached to all subnets within that VPC. If the target is an instance, subnet, or VPC, flow logs will not be collectedfor any instance network attachments or instance network interfaces within the targetthat are themselves the target of a more specific flow log collector.

    timeouts Property Map
    vpc String
    (String) The VPC of the flow log collector that is associated.

    Supporting Types

    IsFlowLogTimeouts, IsFlowLogTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    The ibm_is_flow_log resource can be imported by using VPC flow log ID.

    Example

    $ pulumi import ibm:index/isFlowLog:IsFlowLog example d7bec597-4726-451f-8a53-e62e6f19c32c
    

    To learn more about importing existing cloud resources, see Importing 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