1. Packages
  2. Ibm Provider
  3. API Docs
  4. MetricsRouterSettings
ibm 1.87.0-beta0 published on Friday, Dec 19, 2025 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.MetricsRouterSettings

ibm logo
ibm 1.87.0-beta0 published on Friday, Dec 19, 2025 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Create, update, and delete metrics_router_settingss with this resource.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  metricsRouterSettingsInstance:
    type: ibm:MetricsRouterSettings
    name: metrics_router_settings_instance
    properties:
      backupMetadataRegion: us-east
      defaultTargets:
        - id: c3af557f-fb0e-4476-85c3-0889e7fe7bc4
          crn: 'crn:v1:bluemix:public:sysdig-monitor:us-south:a/0be5ad401ae913d8ff665d92680664ed:22222222-2222-2222-2222-222222222222::'
          name: a-mr-target-us-south
          targetType: sysdig_monitor
      permittedTargetRegions: ${["us-south"]}
      primaryMetadataRegion: us-south
      privateApiEndpointOnly: false

    Create MetricsRouterSettings Resource

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

    Constructor syntax

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

@overload
def MetricsRouterSettings(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          backup_metadata_region: Optional[str] = None,
                          default_targets: Optional[Sequence[MetricsRouterSettingsDefaultTargetArgs]] = None,
                          metrics_router_settings_id: Optional[str] = None,
                          permitted_target_regions: Optional[Sequence[str]] = None,
                          primary_metadata_region: Optional[str] = None,
                          private_api_endpoint_only: Optional[bool] = None)
    func NewMetricsRouterSettings(ctx *Context, name string, args *MetricsRouterSettingsArgs, opts ...ResourceOption) (*MetricsRouterSettings, error)
    public MetricsRouterSettings(string name, MetricsRouterSettingsArgs? args = null, CustomResourceOptions? opts = null)
    public MetricsRouterSettings(String name, MetricsRouterSettingsArgs args)
public MetricsRouterSettings(String name, MetricsRouterSettingsArgs args, CustomResourceOptions options)

    type: ibm:MetricsRouterSettings
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 MetricsRouterSettingsArgs
    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 MetricsRouterSettingsArgs
    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 MetricsRouterSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetricsRouterSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetricsRouterSettingsArgs
    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 metricsRouterSettingsResource = new Ibm.MetricsRouterSettings("metricsRouterSettingsResource", new()
{
    BackupMetadataRegion = "string",
    DefaultTargets = new[]
    {
        new Ibm.Inputs.MetricsRouterSettingsDefaultTargetArgs
        {
            Id = "string",
        },
    },
    MetricsRouterSettingsId = "string",
    PermittedTargetRegions = new[]
    {
        "string",
    },
    PrimaryMetadataRegion = "string",
    PrivateApiEndpointOnly = false,
});

    example, err := ibm.NewMetricsRouterSettings(ctx, "metricsRouterSettingsResource", &ibm.MetricsRouterSettingsArgs{
	BackupMetadataRegion: pulumi.String("string"),
	DefaultTargets: ibm.MetricsRouterSettingsDefaultTargetArray{
		&ibm.MetricsRouterSettingsDefaultTargetArgs{
			Id: pulumi.String("string"),
		},
	},
	MetricsRouterSettingsId: pulumi.String("string"),
	PermittedTargetRegions: pulumi.StringArray{
		pulumi.String("string"),
	},
	PrimaryMetadataRegion:  pulumi.String("string"),
	PrivateApiEndpointOnly: pulumi.Bool(false),
})

    var metricsRouterSettingsResource = new MetricsRouterSettings("metricsRouterSettingsResource", MetricsRouterSettingsArgs.builder()
    .backupMetadataRegion("string")
    .defaultTargets(MetricsRouterSettingsDefaultTargetArgs.builder()
        .id("string")
        .build())
    .metricsRouterSettingsId("string")
    .permittedTargetRegions("string")
    .primaryMetadataRegion("string")
    .privateApiEndpointOnly(false)
    .build());

    metrics_router_settings_resource = ibm.MetricsRouterSettings("metricsRouterSettingsResource",
    backup_metadata_region="string",
    default_targets=[{
        "id": "string",
    }],
    metrics_router_settings_id="string",
    permitted_target_regions=["string"],
    primary_metadata_region="string",
    private_api_endpoint_only=False)

    const metricsRouterSettingsResource = new ibm.MetricsRouterSettings("metricsRouterSettingsResource", {
    backupMetadataRegion: "string",
    defaultTargets: [{
        id: "string",
    }],
    metricsRouterSettingsId: "string",
    permittedTargetRegions: ["string"],
    primaryMetadataRegion: "string",
    privateApiEndpointOnly: false,
});

    type: ibm:MetricsRouterSettings
properties:
    backupMetadataRegion: string
    defaultTargets:
        - id: string
    metricsRouterSettingsId: string
    permittedTargetRegions:
        - string
    primaryMetadataRegion: string
    privateApiEndpointOnly: false

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

    BackupMetadataRegion string
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    DefaultTargets List<MetricsRouterSettingsDefaultTarget>
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    MetricsRouterSettingsId string
    The unique identifier of the metrics_router_settings.
    PermittedTargetRegions List<string>
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    PrimaryMetadataRegion string
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    PrivateApiEndpointOnly bool
    If you set this true then you cannot access api through public network.
    BackupMetadataRegion string
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    DefaultTargets []MetricsRouterSettingsDefaultTargetArgs
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    MetricsRouterSettingsId string
    The unique identifier of the metrics_router_settings.
    PermittedTargetRegions []string
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    PrimaryMetadataRegion string
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    PrivateApiEndpointOnly bool
    If you set this true then you cannot access api through public network.
    backupMetadataRegion String
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    defaultTargets List<MetricsRouterSettingsDefaultTarget>
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    metricsRouterSettingsId String
    The unique identifier of the metrics_router_settings.
    permittedTargetRegions List<String>
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    primaryMetadataRegion String
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    privateApiEndpointOnly Boolean
    If you set this true then you cannot access api through public network.
    backupMetadataRegion string
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    defaultTargets MetricsRouterSettingsDefaultTarget[]
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    metricsRouterSettingsId string
    The unique identifier of the metrics_router_settings.
    permittedTargetRegions string[]
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    primaryMetadataRegion string
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    privateApiEndpointOnly boolean
    If you set this true then you cannot access api through public network.
    backup_metadata_region str
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    default_targets Sequence[MetricsRouterSettingsDefaultTargetArgs]
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    metrics_router_settings_id str
    The unique identifier of the metrics_router_settings.
    permitted_target_regions Sequence[str]
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    primary_metadata_region str
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    private_api_endpoint_only bool
    If you set this true then you cannot access api through public network.
    backupMetadataRegion String
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    defaultTargets List<Property Map>
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    metricsRouterSettingsId String
    The unique identifier of the metrics_router_settings.
    permittedTargetRegions List<String>
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    primaryMetadataRegion String
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    privateApiEndpointOnly Boolean
    If you set this true then you cannot access api through public network.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing MetricsRouterSettings Resource

    Get an existing MetricsRouterSettings 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?: MetricsRouterSettingsState, opts?: CustomResourceOptions): MetricsRouterSettings
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_metadata_region: Optional[str] = None,
        default_targets: Optional[Sequence[MetricsRouterSettingsDefaultTargetArgs]] = None,
        metrics_router_settings_id: Optional[str] = None,
        permitted_target_regions: Optional[Sequence[str]] = None,
        primary_metadata_region: Optional[str] = None,
        private_api_endpoint_only: Optional[bool] = None) -> MetricsRouterSettings
    func GetMetricsRouterSettings(ctx *Context, name string, id IDInput, state *MetricsRouterSettingsState, opts ...ResourceOption) (*MetricsRouterSettings, error)
    public static MetricsRouterSettings Get(string name, Input<string> id, MetricsRouterSettingsState? state, CustomResourceOptions? opts = null)
    public static MetricsRouterSettings get(String name, Output<String> id, MetricsRouterSettingsState state, CustomResourceOptions options)
    resources:  _:    type: ibm:MetricsRouterSettings    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:
    BackupMetadataRegion string
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    DefaultTargets List<MetricsRouterSettingsDefaultTarget>
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    MetricsRouterSettingsId string
    The unique identifier of the metrics_router_settings.
    PermittedTargetRegions List<string>
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    PrimaryMetadataRegion string
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    PrivateApiEndpointOnly bool
    If you set this true then you cannot access api through public network.
    BackupMetadataRegion string
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    DefaultTargets []MetricsRouterSettingsDefaultTargetArgs
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    MetricsRouterSettingsId string
    The unique identifier of the metrics_router_settings.
    PermittedTargetRegions []string
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    PrimaryMetadataRegion string
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    PrivateApiEndpointOnly bool
    If you set this true then you cannot access api through public network.
    backupMetadataRegion String
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    defaultTargets List<MetricsRouterSettingsDefaultTarget>
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    metricsRouterSettingsId String
    The unique identifier of the metrics_router_settings.
    permittedTargetRegions List<String>
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    primaryMetadataRegion String
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    privateApiEndpointOnly Boolean
    If you set this true then you cannot access api through public network.
    backupMetadataRegion string
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    defaultTargets MetricsRouterSettingsDefaultTarget[]
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    metricsRouterSettingsId string
    The unique identifier of the metrics_router_settings.
    permittedTargetRegions string[]
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    primaryMetadataRegion string
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    privateApiEndpointOnly boolean
    If you set this true then you cannot access api through public network.
    backup_metadata_region str
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    default_targets Sequence[MetricsRouterSettingsDefaultTargetArgs]
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    metrics_router_settings_id str
    The unique identifier of the metrics_router_settings.
    permitted_target_regions Sequence[str]
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    primary_metadata_region str
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    private_api_endpoint_only bool
    If you set this true then you cannot access api through public network.
    backupMetadataRegion String
    To backup all your meta data in a different region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    defaultTargets List<Property Map>
    A list of default target references. Enterprise-managed targets are not supported.

    • Constraints: The maximum length is 2 items. The minimum length is 0 items. Nested schema for default_targets:
    metricsRouterSettingsId String
    The unique identifier of the metrics_router_settings.
    permittedTargetRegions List<String>
    If present then only these regions may be used to define a target.

    • Constraints: The list items must match regular expression /^[a-zA-Z0-9 \\-_]+$/. The maximum length is 16 items. The minimum length is 0 items.
    primaryMetadataRegion String
    To store all your meta data in a single region.

    • Constraints: The maximum length is 256 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-_]+$/.
    privateApiEndpointOnly Boolean
    If you set this true then you cannot access api through public network.

    Supporting Types

    MetricsRouterSettingsDefaultTarget, MetricsRouterSettingsDefaultTargetArgs

    Id string
    The target uuid for a pre-defined metrics router target.

    • Constraints: The maximum length is 1000 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-._:]+$/.
    Id string
    The target uuid for a pre-defined metrics router target.

    • Constraints: The maximum length is 1000 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-._:]+$/.
    id String
    The target uuid for a pre-defined metrics router target.

    • Constraints: The maximum length is 1000 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-._:]+$/.
    id string
    The target uuid for a pre-defined metrics router target.

    • Constraints: The maximum length is 1000 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-._:]+$/.
    id str
    The target uuid for a pre-defined metrics router target.

    • Constraints: The maximum length is 1000 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-._:]+$/.
    id String
    The target uuid for a pre-defined metrics router target.

    • Constraints: The maximum length is 1000 characters. The minimum length is 3 characters. The value must match regular expression /^[a-zA-Z0-9 \\-._:]+$/.

    Import

    You can import the ibm_metrics_router_settings resource by using primary_metadata_region. To store all your meta data in a single region.

    Syntax

    
```sh
$ pulumi import ibm:index/metricsRouterSettings:MetricsRouterSettings metrics_router_settings <primary_metadata_region>
```

    Example

    $ pulumi import ibm:index/metricsRouterSettings:MetricsRouterSettings metrics_router_settings us-south

    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.87.0-beta0 published on Friday, Dec 19, 2025 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm
      Meet Neo: Your AI Platform Teammate