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

ibm.TgRouteReport

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 and delete a transit gateway’s route report resource. For more information about Transit Gateway Route Reports, see generating and viewing a route report.

    Create TgRouteReport Resource

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

    Constructor syntax

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

@overload
def TgRouteReport(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  gateway: Optional[str] = None,
                  tg_route_report_id: Optional[str] = None,
                  timeouts: Optional[TgRouteReportTimeoutsArgs] = None)
    func NewTgRouteReport(ctx *Context, name string, args TgRouteReportArgs, opts ...ResourceOption) (*TgRouteReport, error)
    public TgRouteReport(string name, TgRouteReportArgs args, CustomResourceOptions? opts = null)
    public TgRouteReport(String name, TgRouteReportArgs args)
public TgRouteReport(String name, TgRouteReportArgs args, CustomResourceOptions options)

    type: ibm:TgRouteReport
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 TgRouteReportArgs
    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 TgRouteReportArgs
    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 TgRouteReportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TgRouteReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TgRouteReportArgs
    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 tgRouteReportResource = new Ibm.TgRouteReport("tgRouteReportResource", new()
{
    Gateway = "string",
    TgRouteReportId = "string",
    Timeouts = new Ibm.Inputs.TgRouteReportTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := ibm.NewTgRouteReport(ctx, "tgRouteReportResource", &ibm.TgRouteReportArgs{
	Gateway:         pulumi.String("string"),
	TgRouteReportId: pulumi.String("string"),
	Timeouts: &ibm.TgRouteReportTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

    var tgRouteReportResource = new TgRouteReport("tgRouteReportResource", TgRouteReportArgs.builder()
    .gateway("string")
    .tgRouteReportId("string")
    .timeouts(TgRouteReportTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    tg_route_report_resource = ibm.TgRouteReport("tgRouteReportResource",
    gateway="string",
    tg_route_report_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const tgRouteReportResource = new ibm.TgRouteReport("tgRouteReportResource", {
    gateway: "string",
    tgRouteReportId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: ibm:TgRouteReport
properties:
    gateway: string
    tgRouteReportId: string
    timeouts:
        create: string
        delete: string

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

    Gateway string
    The unique identifier of the gateway.
    TgRouteReportId string
    (String) The unique identifier for the transit gateway connection
    Timeouts TgRouteReportTimeouts
    Gateway string
    The unique identifier of the gateway.
    TgRouteReportId string
    (String) The unique identifier for the transit gateway connection
    Timeouts TgRouteReportTimeoutsArgs
    gateway String
    The unique identifier of the gateway.
    tgRouteReportId String
    (String) The unique identifier for the transit gateway connection
    timeouts TgRouteReportTimeouts
    gateway string
    The unique identifier of the gateway.
    tgRouteReportId string
    (String) The unique identifier for the transit gateway connection
    timeouts TgRouteReportTimeouts
    gateway str
    The unique identifier of the gateway.
    tg_route_report_id str
    (String) The unique identifier for the transit gateway connection
    timeouts TgRouteReportTimeoutsArgs
    gateway String
    The unique identifier of the gateway.
    tgRouteReportId String
    (String) The unique identifier for the transit gateway connection
    timeouts Property Map

    Outputs

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

    Connections List<TgRouteReportConnection>
    (String) A list of connections in the gateway
    CreatedAt string
    (Timestamp) The date and time resource is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    OverlappingRoutes List<TgRouteReportOverlappingRoute>
    (String) A list of overlapping routes in the gateway
    RouteReportId string
    (String) The unique identifier of this route report.
    Status string
    (String) The route report status.
    UpdatedAt string
    (Timestamp) The date and time resource is last updated.
    Connections []TgRouteReportConnection
    (String) A list of connections in the gateway
    CreatedAt string
    (Timestamp) The date and time resource is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    OverlappingRoutes []TgRouteReportOverlappingRoute
    (String) A list of overlapping routes in the gateway
    RouteReportId string
    (String) The unique identifier of this route report.
    Status string
    (String) The route report status.
    UpdatedAt string
    (Timestamp) The date and time resource is last updated.
    connections List<TgRouteReportConnection>
    (String) A list of connections in the gateway
    createdAt String
    (Timestamp) The date and time resource is created.
    id String
    The provider-assigned unique ID for this managed resource.
    overlappingRoutes List<TgRouteReportOverlappingRoute>
    (String) A list of overlapping routes in the gateway
    routeReportId String
    (String) The unique identifier of this route report.
    status String
    (String) The route report status.
    updatedAt String
    (Timestamp) The date and time resource is last updated.
    connections TgRouteReportConnection[]
    (String) A list of connections in the gateway
    createdAt string
    (Timestamp) The date and time resource is created.
    id string
    The provider-assigned unique ID for this managed resource.
    overlappingRoutes TgRouteReportOverlappingRoute[]
    (String) A list of overlapping routes in the gateway
    routeReportId string
    (String) The unique identifier of this route report.
    status string
    (String) The route report status.
    updatedAt string
    (Timestamp) The date and time resource is last updated.
    connections Sequence[TgRouteReportConnection]
    (String) A list of connections in the gateway
    created_at str
    (Timestamp) The date and time resource is created.
    id str
    The provider-assigned unique ID for this managed resource.
    overlapping_routes Sequence[TgRouteReportOverlappingRoute]
    (String) A list of overlapping routes in the gateway
    route_report_id str
    (String) The unique identifier of this route report.
    status str
    (String) The route report status.
    updated_at str
    (Timestamp) The date and time resource is last updated.
    connections List<Property Map>
    (String) A list of connections in the gateway
    createdAt String
    (Timestamp) The date and time resource is created.
    id String
    The provider-assigned unique ID for this managed resource.
    overlappingRoutes List<Property Map>
    (String) A list of overlapping routes in the gateway
    routeReportId String
    (String) The unique identifier of this route report.
    status String
    (String) The route report status.
    updatedAt String
    (Timestamp) The date and time resource is last updated.

    Look up Existing TgRouteReport Resource

    Get an existing TgRouteReport 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?: TgRouteReportState, opts?: CustomResourceOptions): TgRouteReport
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connections: Optional[Sequence[TgRouteReportConnectionArgs]] = None,
        created_at: Optional[str] = None,
        gateway: Optional[str] = None,
        overlapping_routes: Optional[Sequence[TgRouteReportOverlappingRouteArgs]] = None,
        route_report_id: Optional[str] = None,
        status: Optional[str] = None,
        tg_route_report_id: Optional[str] = None,
        timeouts: Optional[TgRouteReportTimeoutsArgs] = None,
        updated_at: Optional[str] = None) -> TgRouteReport
    func GetTgRouteReport(ctx *Context, name string, id IDInput, state *TgRouteReportState, opts ...ResourceOption) (*TgRouteReport, error)
    public static TgRouteReport Get(string name, Input<string> id, TgRouteReportState? state, CustomResourceOptions? opts = null)
    public static TgRouteReport get(String name, Output<String> id, TgRouteReportState state, CustomResourceOptions options)
    resources:  _:    type: ibm:TgRouteReport    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:
    Connections List<TgRouteReportConnection>
    (String) A list of connections in the gateway
    CreatedAt string
    (Timestamp) The date and time resource is created.
    Gateway string
    The unique identifier of the gateway.
    OverlappingRoutes List<TgRouteReportOverlappingRoute>
    (String) A list of overlapping routes in the gateway
    RouteReportId string
    (String) The unique identifier of this route report.
    Status string
    (String) The route report status.
    TgRouteReportId string
    (String) The unique identifier for the transit gateway connection
    Timeouts TgRouteReportTimeouts
    UpdatedAt string
    (Timestamp) The date and time resource is last updated.
    Connections []TgRouteReportConnectionArgs
    (String) A list of connections in the gateway
    CreatedAt string
    (Timestamp) The date and time resource is created.
    Gateway string
    The unique identifier of the gateway.
    OverlappingRoutes []TgRouteReportOverlappingRouteArgs
    (String) A list of overlapping routes in the gateway
    RouteReportId string
    (String) The unique identifier of this route report.
    Status string
    (String) The route report status.
    TgRouteReportId string
    (String) The unique identifier for the transit gateway connection
    Timeouts TgRouteReportTimeoutsArgs
    UpdatedAt string
    (Timestamp) The date and time resource is last updated.
    connections List<TgRouteReportConnection>
    (String) A list of connections in the gateway
    createdAt String
    (Timestamp) The date and time resource is created.
    gateway String
    The unique identifier of the gateway.
    overlappingRoutes List<TgRouteReportOverlappingRoute>
    (String) A list of overlapping routes in the gateway
    routeReportId String
    (String) The unique identifier of this route report.
    status String
    (String) The route report status.
    tgRouteReportId String
    (String) The unique identifier for the transit gateway connection
    timeouts TgRouteReportTimeouts
    updatedAt String
    (Timestamp) The date and time resource is last updated.
    connections TgRouteReportConnection[]
    (String) A list of connections in the gateway
    createdAt string
    (Timestamp) The date and time resource is created.
    gateway string
    The unique identifier of the gateway.
    overlappingRoutes TgRouteReportOverlappingRoute[]
    (String) A list of overlapping routes in the gateway
    routeReportId string
    (String) The unique identifier of this route report.
    status string
    (String) The route report status.
    tgRouteReportId string
    (String) The unique identifier for the transit gateway connection
    timeouts TgRouteReportTimeouts
    updatedAt string
    (Timestamp) The date and time resource is last updated.
    connections Sequence[TgRouteReportConnectionArgs]
    (String) A list of connections in the gateway
    created_at str
    (Timestamp) The date and time resource is created.
    gateway str
    The unique identifier of the gateway.
    overlapping_routes Sequence[TgRouteReportOverlappingRouteArgs]
    (String) A list of overlapping routes in the gateway
    route_report_id str
    (String) The unique identifier of this route report.
    status str
    (String) The route report status.
    tg_route_report_id str
    (String) The unique identifier for the transit gateway connection
    timeouts TgRouteReportTimeoutsArgs
    updated_at str
    (Timestamp) The date and time resource is last updated.
    connections List<Property Map>
    (String) A list of connections in the gateway
    createdAt String
    (Timestamp) The date and time resource is created.
    gateway String
    The unique identifier of the gateway.
    overlappingRoutes List<Property Map>
    (String) A list of overlapping routes in the gateway
    routeReportId String
    (String) The unique identifier of this route report.
    status String
    (String) The route report status.
    tgRouteReportId String
    (String) The unique identifier for the transit gateway connection
    timeouts Property Map
    updatedAt String
    (Timestamp) The date and time resource is last updated.

    Supporting Types

    TgRouteReportConnection, TgRouteReportConnectionArgs

    Bgps List<TgRouteReportConnectionBgp>
    (String) A list of the connection's bgps Nested scheme for bgps:
    Id string
    (String) The unique identifier for the transit gateway connection
    Name string
    (String) The user-defined name for the transit gateway connection.
    Routes List<TgRouteReportConnectionRoute>
    (String) A list of the connection's routes
    Type string
    (String) The connection type
    Bgps []TgRouteReportConnectionBgp
    (String) A list of the connection's bgps Nested scheme for bgps:
    Id string
    (String) The unique identifier for the transit gateway connection
    Name string
    (String) The user-defined name for the transit gateway connection.
    Routes []TgRouteReportConnectionRoute
    (String) A list of the connection's routes
    Type string
    (String) The connection type
    bgps List<TgRouteReportConnectionBgp>
    (String) A list of the connection's bgps Nested scheme for bgps:
    id String
    (String) The unique identifier for the transit gateway connection
    name String
    (String) The user-defined name for the transit gateway connection.
    routes List<TgRouteReportConnectionRoute>
    (String) A list of the connection's routes
    type String
    (String) The connection type
    bgps TgRouteReportConnectionBgp[]
    (String) A list of the connection's bgps Nested scheme for bgps:
    id string
    (String) The unique identifier for the transit gateway connection
    name string
    (String) The user-defined name for the transit gateway connection.
    routes TgRouteReportConnectionRoute[]
    (String) A list of the connection's routes
    type string
    (String) The connection type
    bgps Sequence[TgRouteReportConnectionBgp]
    (String) A list of the connection's bgps Nested scheme for bgps:
    id str
    (String) The unique identifier for the transit gateway connection
    name str
    (String) The user-defined name for the transit gateway connection.
    routes Sequence[TgRouteReportConnectionRoute]
    (String) A list of the connection's routes
    type str
    (String) The connection type
    bgps List<Property Map>
    (String) A list of the connection's bgps Nested scheme for bgps:
    id String
    (String) The unique identifier for the transit gateway connection
    name String
    (String) The user-defined name for the transit gateway connection.
    routes List<Property Map>
    (String) A list of the connection's routes
    type String
    (String) The connection type

    TgRouteReportConnectionBgp, TgRouteReportConnectionBgpArgs

    AsPath string
    (String) The bgp AS path
    IsUsed bool
    (Bool) Indicates whether the current route is used or not
    LocalPreference string
    (String) The local preference
    Prefix string
    (String) The overlapping prefix
    AsPath string
    (String) The bgp AS path
    IsUsed bool
    (Bool) Indicates whether the current route is used or not
    LocalPreference string
    (String) The local preference
    Prefix string
    (String) The overlapping prefix
    asPath String
    (String) The bgp AS path
    isUsed Boolean
    (Bool) Indicates whether the current route is used or not
    localPreference String
    (String) The local preference
    prefix String
    (String) The overlapping prefix
    asPath string
    (String) The bgp AS path
    isUsed boolean
    (Bool) Indicates whether the current route is used or not
    localPreference string
    (String) The local preference
    prefix string
    (String) The overlapping prefix
    as_path str
    (String) The bgp AS path
    is_used bool
    (Bool) Indicates whether the current route is used or not
    local_preference str
    (String) The local preference
    prefix str
    (String) The overlapping prefix
    asPath String
    (String) The bgp AS path
    isUsed Boolean
    (Bool) Indicates whether the current route is used or not
    localPreference String
    (String) The local preference
    prefix String
    (String) The overlapping prefix

    TgRouteReportConnectionRoute, TgRouteReportConnectionRouteArgs

    Prefix string
    (String) The overlapping prefix
    Prefix string
    (String) The overlapping prefix
    prefix String
    (String) The overlapping prefix
    prefix string
    (String) The overlapping prefix
    prefix str
    (String) The overlapping prefix
    prefix String
    (String) The overlapping prefix

    TgRouteReportOverlappingRoute, TgRouteReportOverlappingRouteArgs

    Routes List<TgRouteReportOverlappingRouteRoute>
    (String) A list of the connection's routes
    Routes []TgRouteReportOverlappingRouteRoute
    (String) A list of the connection's routes
    routes List<TgRouteReportOverlappingRouteRoute>
    (String) A list of the connection's routes
    routes TgRouteReportOverlappingRouteRoute[]
    (String) A list of the connection's routes
    routes Sequence[TgRouteReportOverlappingRouteRoute]
    (String) A list of the connection's routes
    routes List<Property Map>
    (String) A list of the connection's routes

    TgRouteReportOverlappingRouteRoute, TgRouteReportOverlappingRouteRouteArgs

    ConnectionId string
    (String) The unique identifier for the transit gateway connection
    Prefix string
    (String) The overlapping prefix
    ConnectionId string
    (String) The unique identifier for the transit gateway connection
    Prefix string
    (String) The overlapping prefix
    connectionId String
    (String) The unique identifier for the transit gateway connection
    prefix String
    (String) The overlapping prefix
    connectionId string
    (String) The unique identifier for the transit gateway connection
    prefix string
    (String) The overlapping prefix
    connection_id str
    (String) The unique identifier for the transit gateway connection
    prefix str
    (String) The overlapping prefix
    connectionId String
    (String) The unique identifier for the transit gateway connection
    prefix String
    (String) The overlapping prefix

    TgRouteReportTimeouts, TgRouteReportTimeoutsArgs

    Create string
    Delete string
    Create string
    Delete string
    create String
    delete String
    create string
    delete string
    create str
    delete str
    create String
    delete String

    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