Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. AtrackerRoute
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.AtrackerRoute

Explore with Pulumi AI

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

    Create, update, and delete atracker_routes with this resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const atrackerRouteInstance = new ibm.AtrackerRoute("atrackerRouteInstance", {rules: [{
    locations: ["us-south"],
    targetIds: ["c3af557f-fb0e-4476-85c3-0889e7fe7bc4"],
}]});

    import pulumi
import pulumi_ibm as ibm

atracker_route_instance = ibm.AtrackerRoute("atrackerRouteInstance", rules=[{
    "locations": ["us-south"],
    "target_ids": ["c3af557f-fb0e-4476-85c3-0889e7fe7bc4"],
}])

    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.NewAtrackerRoute(ctx, "atrackerRouteInstance", &ibm.AtrackerRouteArgs{
			Rules: ibm.AtrackerRouteRuleArray{
				&ibm.AtrackerRouteRuleArgs{
					Locations: pulumi.StringArray{
						pulumi.String("us-south"),
					},
					TargetIds: pulumi.StringArray{
						pulumi.String("c3af557f-fb0e-4476-85c3-0889e7fe7bc4"),
					},
				},
			},
		})
		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 atrackerRouteInstance = new Ibm.AtrackerRoute("atrackerRouteInstance", new()
    {
        Rules = new[]
        {
            new Ibm.Inputs.AtrackerRouteRuleArgs
            {
                Locations = new[]
                {
                    "us-south",
                },
                TargetIds = new[]
                {
                    "c3af557f-fb0e-4476-85c3-0889e7fe7bc4",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.AtrackerRoute;
import com.pulumi.ibm.AtrackerRouteArgs;
import com.pulumi.ibm.inputs.AtrackerRouteRuleArgs;
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 atrackerRouteInstance = new AtrackerRoute("atrackerRouteInstance", AtrackerRouteArgs.builder()
            .rules(AtrackerRouteRuleArgs.builder()
                .locations("us-south")
                .targetIds("c3af557f-fb0e-4476-85c3-0889e7fe7bc4")
                .build())
            .build());

    }
}

    resources:
  atrackerRouteInstance:
    type: ibm:AtrackerRoute
    properties:
      rules:
        - locations:
            - us-south
          targetIds:
            - c3af557f-fb0e-4476-85c3-0889e7fe7bc4

    Create AtrackerRoute Resource

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

    Constructor syntax

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

@overload
def AtrackerRoute(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  rules: Optional[Sequence[AtrackerRouteRuleArgs]] = None,
                  atracker_route_id: Optional[str] = None,
                  name: Optional[str] = None)
    func NewAtrackerRoute(ctx *Context, name string, args AtrackerRouteArgs, opts ...ResourceOption) (*AtrackerRoute, error)
    public AtrackerRoute(string name, AtrackerRouteArgs args, CustomResourceOptions? opts = null)
    public AtrackerRoute(String name, AtrackerRouteArgs args)
public AtrackerRoute(String name, AtrackerRouteArgs args, CustomResourceOptions options)

    type: ibm:AtrackerRoute
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 AtrackerRouteArgs
    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 AtrackerRouteArgs
    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 AtrackerRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AtrackerRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AtrackerRouteArgs
    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 atrackerRouteResource = new Ibm.AtrackerRoute("atrackerRouteResource", new()
{
    Rules = new[]
    {
        new Ibm.Inputs.AtrackerRouteRuleArgs
        {
            Locations = new[]
            {
                "string",
            },
            TargetIds = new[]
            {
                "string",
            },
        },
    },
    AtrackerRouteId = "string",
    Name = "string",
});

    example, err := ibm.NewAtrackerRoute(ctx, "atrackerRouteResource", &ibm.AtrackerRouteArgs{
	Rules: ibm.AtrackerRouteRuleArray{
		&ibm.AtrackerRouteRuleArgs{
			Locations: pulumi.StringArray{
				pulumi.String("string"),
			},
			TargetIds: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	AtrackerRouteId: pulumi.String("string"),
	Name:            pulumi.String("string"),
})

    var atrackerRouteResource = new AtrackerRoute("atrackerRouteResource", AtrackerRouteArgs.builder()
    .rules(AtrackerRouteRuleArgs.builder()
        .locations("string")
        .targetIds("string")
        .build())
    .atrackerRouteId("string")
    .name("string")
    .build());

    atracker_route_resource = ibm.AtrackerRoute("atrackerRouteResource",
    rules=[{
        "locations": ["string"],
        "target_ids": ["string"],
    }],
    atracker_route_id="string",
    name="string")

    const atrackerRouteResource = new ibm.AtrackerRoute("atrackerRouteResource", {
    rules: [{
        locations: ["string"],
        targetIds: ["string"],
    }],
    atrackerRouteId: "string",
    name: "string",
});

    type: ibm:AtrackerRoute
properties:
    atrackerRouteId: string
    name: string
    rules:
        - locations:
            - string
          targetIds:
            - string

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

    Rules List<AtrackerRouteRule>
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    AtrackerRouteId string
    The unique identifier of the atracker_route.
    Name string
    The name of the route.
    Rules []AtrackerRouteRuleArgs
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    AtrackerRouteId string
    The unique identifier of the atracker_route.
    Name string
    The name of the route.
    rules List<AtrackerRouteRule>
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    atrackerRouteId String
    The unique identifier of the atracker_route.
    name String
    The name of the route.
    rules AtrackerRouteRule[]
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    atrackerRouteId string
    The unique identifier of the atracker_route.
    name string
    The name of the route.
    rules Sequence[AtrackerRouteRuleArgs]
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    atracker_route_id str
    The unique identifier of the atracker_route.
    name str
    The name of the route.
    rules List<Property Map>
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    atrackerRouteId String
    The unique identifier of the atracker_route.
    name String
    The name of the route.

    Outputs

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

    ApiVersion double
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    CreatedAt string
    (String) The timestamp of the route creation time.
    Crn string
    (String) The crn of the route resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    (String) An optional message containing information about the route.
    UpdatedAt string
    (String) The timestamp of the route last updated time.
    Version double
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.
    ApiVersion float64
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    CreatedAt string
    (String) The timestamp of the route creation time.
    Crn string
    (String) The crn of the route resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    (String) An optional message containing information about the route.
    UpdatedAt string
    (String) The timestamp of the route last updated time.
    Version float64
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.
    apiVersion Double
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    createdAt String
    (String) The timestamp of the route creation time.
    crn String
    (String) The crn of the route resource.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    (String) An optional message containing information about the route.
    updatedAt String
    (String) The timestamp of the route last updated time.
    version Double
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.
    apiVersion number
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    createdAt string
    (String) The timestamp of the route creation time.
    crn string
    (String) The crn of the route resource.
    id string
    The provider-assigned unique ID for this managed resource.
    message string
    (String) An optional message containing information about the route.
    updatedAt string
    (String) The timestamp of the route last updated time.
    version number
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.
    api_version float
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    created_at str
    (String) The timestamp of the route creation time.
    crn str
    (String) The crn of the route resource.
    id str
    The provider-assigned unique ID for this managed resource.
    message str
    (String) An optional message containing information about the route.
    updated_at str
    (String) The timestamp of the route last updated time.
    version float
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.
    apiVersion Number
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    createdAt String
    (String) The timestamp of the route creation time.
    crn String
    (String) The crn of the route resource.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    (String) An optional message containing information about the route.
    updatedAt String
    (String) The timestamp of the route last updated time.
    version Number
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.

    Look up Existing AtrackerRoute Resource

    Get an existing AtrackerRoute 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?: AtrackerRouteState, opts?: CustomResourceOptions): AtrackerRoute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_version: Optional[float] = None,
        atracker_route_id: Optional[str] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        message: Optional[str] = None,
        name: Optional[str] = None,
        rules: Optional[Sequence[AtrackerRouteRuleArgs]] = None,
        updated_at: Optional[str] = None,
        version: Optional[float] = None) -> AtrackerRoute
    func GetAtrackerRoute(ctx *Context, name string, id IDInput, state *AtrackerRouteState, opts ...ResourceOption) (*AtrackerRoute, error)
    public static AtrackerRoute Get(string name, Input<string> id, AtrackerRouteState? state, CustomResourceOptions? opts = null)
    public static AtrackerRoute get(String name, Output<String> id, AtrackerRouteState state, CustomResourceOptions options)
    resources:  _:    type: ibm:AtrackerRoute    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:
    ApiVersion double
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    AtrackerRouteId string
    The unique identifier of the atracker_route.
    CreatedAt string
    (String) The timestamp of the route creation time.
    Crn string
    (String) The crn of the route resource.
    Message string
    (String) An optional message containing information about the route.
    Name string
    The name of the route.
    Rules List<AtrackerRouteRule>
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    UpdatedAt string
    (String) The timestamp of the route last updated time.
    Version double
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.
    ApiVersion float64
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    AtrackerRouteId string
    The unique identifier of the atracker_route.
    CreatedAt string
    (String) The timestamp of the route creation time.
    Crn string
    (String) The crn of the route resource.
    Message string
    (String) An optional message containing information about the route.
    Name string
    The name of the route.
    Rules []AtrackerRouteRuleArgs
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    UpdatedAt string
    (String) The timestamp of the route last updated time.
    Version float64
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.
    apiVersion Double
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    atrackerRouteId String
    The unique identifier of the atracker_route.
    createdAt String
    (String) The timestamp of the route creation time.
    crn String
    (String) The crn of the route resource.
    message String
    (String) An optional message containing information about the route.
    name String
    The name of the route.
    rules List<AtrackerRouteRule>
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    updatedAt String
    (String) The timestamp of the route last updated time.
    version Double
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.
    apiVersion number
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    atrackerRouteId string
    The unique identifier of the atracker_route.
    createdAt string
    (String) The timestamp of the route creation time.
    crn string
    (String) The crn of the route resource.
    message string
    (String) An optional message containing information about the route.
    name string
    The name of the route.
    rules AtrackerRouteRule[]
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    updatedAt string
    (String) The timestamp of the route last updated time.
    version number
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.
    api_version float
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    atracker_route_id str
    The unique identifier of the atracker_route.
    created_at str
    (String) The timestamp of the route creation time.
    crn str
    (String) The crn of the route resource.
    message str
    (String) An optional message containing information about the route.
    name str
    The name of the route.
    rules Sequence[AtrackerRouteRuleArgs]
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    updated_at str
    (String) The timestamp of the route last updated time.
    version float
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.
    apiVersion Number
    (Integer) The API version of the route.

    • Constraints: The maximum value is 2. The minimum value is 2.
    atrackerRouteId String
    The unique identifier of the atracker_route.
    createdAt String
    (String) The timestamp of the route creation time.
    crn String
    (String) The crn of the route resource.
    message String
    (String) An optional message containing information about the route.
    name String
    The name of the route.
    rules List<Property Map>
    The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in the route definition will be skipped.

    • Constraints: The maximum length is 10 items. The minimum length is 1 item. Nested schema for rules:
    updatedAt String
    (String) The timestamp of the route last updated time.
    version Number
    (Integer) The version of the route.

    • Constraints: The minimum value is 0.

    Supporting Types

    AtrackerRouteRule, AtrackerRouteRuleArgs

    Locations List<string>
    Logs from these locations will be sent to the targets specified. Locations is a superset of regions including global and *.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.
    TargetIds List<string>
    The target ID List. All the events will be send to all targets listed in the rule. You can include targets from other regions.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.
    Locations []string
    Logs from these locations will be sent to the targets specified. Locations is a superset of regions including global and *.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.
    TargetIds []string
    The target ID List. All the events will be send to all targets listed in the rule. You can include targets from other regions.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.
    locations List<String>
    Logs from these locations will be sent to the targets specified. Locations is a superset of regions including global and *.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.
    targetIds List<String>
    The target ID List. All the events will be send to all targets listed in the rule. You can include targets from other regions.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.
    locations string[]
    Logs from these locations will be sent to the targets specified. Locations is a superset of regions including global and *.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.
    targetIds string[]
    The target ID List. All the events will be send to all targets listed in the rule. You can include targets from other regions.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.
    locations Sequence[str]
    Logs from these locations will be sent to the targets specified. Locations is a superset of regions including global and *.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.
    target_ids Sequence[str]
    The target ID List. All the events will be send to all targets listed in the rule. You can include targets from other regions.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.
    locations List<String>
    Logs from these locations will be sent to the targets specified. Locations is a superset of regions including global and *.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.
    targetIds List<String>
    The target ID List. All the events will be send to all targets listed in the rule. You can include targets from other regions.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 -._:]+$/.

    Import

    You can import the ibm_atracker_route resource by using id. The uuid of the route resource.

    Syntax

    
```sh
$ pulumi import ibm:index/atrackerRoute:AtrackerRoute atracker_route <id>
```

    Example

    $ pulumi import ibm:index/atrackerRoute:AtrackerRoute atracker_route c3af557f-fb0e-4476-85c3-0889e7fe7bc4

    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
    ibm-cloud/terraform-provider-ibm