1. Packages
  2. Ibm Provider
  3. API Docs
  4. EventStreamsSchemaGlobalRule
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.EventStreamsSchemaGlobalRule

Explore with Pulumi AI

Example Usage

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

const esInstance = ibm.getResourceInstance({
    name: "terraform-integration",
    resourceGroupId: data.ibm_resource_group.group.id,
});
const esSchemaGlobalRule = new ibm.EventStreamsSchemaGlobalRule("esSchemaGlobalRule", {
    resourceInstanceId: esInstance.then(esInstance => esInstance.id),
    config: "FORWARD",
});
Copy
import pulumi
import pulumi_ibm as ibm

es_instance = ibm.get_resource_instance(name="terraform-integration",
    resource_group_id=data["ibm_resource_group"]["group"]["id"])
es_schema_global_rule = ibm.EventStreamsSchemaGlobalRule("esSchemaGlobalRule",
    resource_instance_id=es_instance.id,
    config="FORWARD")
Copy
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 {
		esInstance, err := ibm.LookupResourceInstance(ctx, &ibm.LookupResourceInstanceArgs{
			Name:            pulumi.StringRef("terraform-integration"),
			ResourceGroupId: pulumi.StringRef(data.Ibm_resource_group.Group.Id),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ibm.NewEventStreamsSchemaGlobalRule(ctx, "esSchemaGlobalRule", &ibm.EventStreamsSchemaGlobalRuleArgs{
			ResourceInstanceId: pulumi.String(esInstance.Id),
			Config:             pulumi.String("FORWARD"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var esInstance = Ibm.GetResourceInstance.Invoke(new()
    {
        Name = "terraform-integration",
        ResourceGroupId = data.Ibm_resource_group.Group.Id,
    });

    var esSchemaGlobalRule = new Ibm.EventStreamsSchemaGlobalRule("esSchemaGlobalRule", new()
    {
        ResourceInstanceId = esInstance.Apply(getResourceInstanceResult => getResourceInstanceResult.Id),
        Config = "FORWARD",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetResourceInstanceArgs;
import com.pulumi.ibm.EventStreamsSchemaGlobalRule;
import com.pulumi.ibm.EventStreamsSchemaGlobalRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var esInstance = IbmFunctions.getResourceInstance(GetResourceInstanceArgs.builder()
            .name("terraform-integration")
            .resourceGroupId(data.ibm_resource_group().group().id())
            .build());

        var esSchemaGlobalRule = new EventStreamsSchemaGlobalRule("esSchemaGlobalRule", EventStreamsSchemaGlobalRuleArgs.builder()
            .resourceInstanceId(esInstance.applyValue(getResourceInstanceResult -> getResourceInstanceResult.id()))
            .config("FORWARD")
            .build());

    }
}
Copy
resources:
  esSchemaGlobalRule:
    type: ibm:EventStreamsSchemaGlobalRule
    properties:
      resourceInstanceId: ${esInstance.id}
      config: FORWARD
variables:
  esInstance:
    fn::invoke:
      function: ibm:getResourceInstance
      arguments:
        name: terraform-integration
        resourceGroupId: ${data.ibm_resource_group.group.id}
Copy

Create EventStreamsSchemaGlobalRule Resource

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

Constructor syntax

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

@overload
def EventStreamsSchemaGlobalRule(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 config: Optional[str] = None,
                                 resource_instance_id: Optional[str] = None,
                                 event_streams_schema_global_rule_id: Optional[str] = None)
func NewEventStreamsSchemaGlobalRule(ctx *Context, name string, args EventStreamsSchemaGlobalRuleArgs, opts ...ResourceOption) (*EventStreamsSchemaGlobalRule, error)
public EventStreamsSchemaGlobalRule(string name, EventStreamsSchemaGlobalRuleArgs args, CustomResourceOptions? opts = null)
public EventStreamsSchemaGlobalRule(String name, EventStreamsSchemaGlobalRuleArgs args)
public EventStreamsSchemaGlobalRule(String name, EventStreamsSchemaGlobalRuleArgs args, CustomResourceOptions options)
type: ibm:EventStreamsSchemaGlobalRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EventStreamsSchemaGlobalRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EventStreamsSchemaGlobalRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EventStreamsSchemaGlobalRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EventStreamsSchemaGlobalRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EventStreamsSchemaGlobalRuleArgs
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 eventStreamsSchemaGlobalRuleResource = new Ibm.EventStreamsSchemaGlobalRule("eventStreamsSchemaGlobalRuleResource", new()
{
    Config = "string",
    ResourceInstanceId = "string",
    EventStreamsSchemaGlobalRuleId = "string",
});
Copy
example, err := ibm.NewEventStreamsSchemaGlobalRule(ctx, "eventStreamsSchemaGlobalRuleResource", &ibm.EventStreamsSchemaGlobalRuleArgs{
	Config:                         pulumi.String("string"),
	ResourceInstanceId:             pulumi.String("string"),
	EventStreamsSchemaGlobalRuleId: pulumi.String("string"),
})
Copy
var eventStreamsSchemaGlobalRuleResource = new EventStreamsSchemaGlobalRule("eventStreamsSchemaGlobalRuleResource", EventStreamsSchemaGlobalRuleArgs.builder()
    .config("string")
    .resourceInstanceId("string")
    .eventStreamsSchemaGlobalRuleId("string")
    .build());
Copy
event_streams_schema_global_rule_resource = ibm.EventStreamsSchemaGlobalRule("eventStreamsSchemaGlobalRuleResource",
    config="string",
    resource_instance_id="string",
    event_streams_schema_global_rule_id="string")
Copy
const eventStreamsSchemaGlobalRuleResource = new ibm.EventStreamsSchemaGlobalRule("eventStreamsSchemaGlobalRuleResource", {
    config: "string",
    resourceInstanceId: "string",
    eventStreamsSchemaGlobalRuleId: "string",
});
Copy
type: ibm:EventStreamsSchemaGlobalRule
properties:
    config: string
    eventStreamsSchemaGlobalRuleId: string
    resourceInstanceId: string
Copy

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

Config This property is required. string
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
ResourceInstanceId This property is required. string
The ID or CRN of the Event Streams service instance.
EventStreamsSchemaGlobalRuleId string
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.
Config This property is required. string
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
ResourceInstanceId This property is required. string
The ID or CRN of the Event Streams service instance.
EventStreamsSchemaGlobalRuleId string
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.
config This property is required. String
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
resourceInstanceId This property is required. String
The ID or CRN of the Event Streams service instance.
eventStreamsSchemaGlobalRuleId String
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.
config This property is required. string
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
resourceInstanceId This property is required. string
The ID or CRN of the Event Streams service instance.
eventStreamsSchemaGlobalRuleId string
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.
config This property is required. str
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
resource_instance_id This property is required. str
The ID or CRN of the Event Streams service instance.
event_streams_schema_global_rule_id str
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.
config This property is required. String
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
resourceInstanceId This property is required. String
The ID or CRN of the Event Streams service instance.
eventStreamsSchemaGlobalRuleId String
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.

Outputs

All input properties are implicitly available as output properties. Additionally, the EventStreamsSchemaGlobalRule 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 EventStreamsSchemaGlobalRule Resource

Get an existing EventStreamsSchemaGlobalRule 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?: EventStreamsSchemaGlobalRuleState, opts?: CustomResourceOptions): EventStreamsSchemaGlobalRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[str] = None,
        event_streams_schema_global_rule_id: Optional[str] = None,
        resource_instance_id: Optional[str] = None) -> EventStreamsSchemaGlobalRule
func GetEventStreamsSchemaGlobalRule(ctx *Context, name string, id IDInput, state *EventStreamsSchemaGlobalRuleState, opts ...ResourceOption) (*EventStreamsSchemaGlobalRule, error)
public static EventStreamsSchemaGlobalRule Get(string name, Input<string> id, EventStreamsSchemaGlobalRuleState? state, CustomResourceOptions? opts = null)
public static EventStreamsSchemaGlobalRule get(String name, Output<String> id, EventStreamsSchemaGlobalRuleState state, CustomResourceOptions options)
resources:  _:    type: ibm:EventStreamsSchemaGlobalRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Config string
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
EventStreamsSchemaGlobalRuleId string
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.
ResourceInstanceId string
The ID or CRN of the Event Streams service instance.
Config string
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
EventStreamsSchemaGlobalRuleId string
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.
ResourceInstanceId string
The ID or CRN of the Event Streams service instance.
config String
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
eventStreamsSchemaGlobalRuleId String
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.
resourceInstanceId String
The ID or CRN of the Event Streams service instance.
config string
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
eventStreamsSchemaGlobalRuleId string
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.
resourceInstanceId string
The ID or CRN of the Event Streams service instance.
config str
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
event_streams_schema_global_rule_id str
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.
resource_instance_id str
The ID or CRN of the Event Streams service instance.
config String
The value of the global compatibility rule in the instance; one of "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD", or "BACKWARD_TRANSITIVE".
eventStreamsSchemaGlobalRuleId String
(String) The ID of the schema global compatibility rule in CRN format. This will be the CRN of the service instance, with resource type "schema-global-compatibility-rule". For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:.
resourceInstanceId String
The ID or CRN of the Event Streams service instance.

Import

The ibm_event_streams_schema_global_rule resource can be imported by using the rule’s CRN, which is the id described above: the CRN of the service instance, with resource type “schema-global-compatibility-rule”.

Syntax

$ pulumi import ibm:index/eventStreamsSchemaGlobalRule:EventStreamsSchemaGlobalRule es_global_rule <crn>
Copy

Example

$ pulumi import ibm:index/eventStreamsSchemaGlobalRule:EventStreamsSchemaGlobalRule es_global_rule crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema-global-compatibility-rule:
Copy

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.