1. Packages
  2. Confluent Cloud
  3. API Docs
  4. SchemaRegistryClusterMode
Confluent v1.51.0 published on Friday, Jul 19, 2024 by Pulumi

confluentcloud.SchemaRegistryClusterMode

Explore with Pulumi AI

confluentcloud logo
Confluent v1.51.0 published on Friday, Jul 19, 2024 by Pulumi

    Import

    You can import a Mode by using the Schema Registry cluster ID, Subject name in the format <Schema Registry cluster ID>, for example:

    $ export IMPORT_SCHEMA_REGISTRY_API_KEY="<schema_registry_api_key>"

    $ export IMPORT_SCHEMA_REGISTRY_API_SECRET="<schema_registry_api_secret>"

    $ export IMPORT_SCHEMA_REGISTRY_REST_ENDPOINT="<schema_registry_rest_endpoint>"

    $ pulumi import confluentcloud:index/schemaRegistryClusterMode:SchemaRegistryClusterMode example lsrc-abc123
    

    !> Warning: Do not forget to delete terminal command history afterwards for security purposes.

    Create SchemaRegistryClusterMode Resource

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

    Constructor syntax

    new SchemaRegistryClusterMode(name: string, args?: SchemaRegistryClusterModeArgs, opts?: CustomResourceOptions);
    @overload
    def SchemaRegistryClusterMode(resource_name: str,
                                  args: Optional[SchemaRegistryClusterModeArgs] = None,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def SchemaRegistryClusterMode(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  credentials: Optional[SchemaRegistryClusterModeCredentialsArgs] = None,
                                  mode: Optional[str] = None,
                                  rest_endpoint: Optional[str] = None,
                                  schema_registry_cluster: Optional[SchemaRegistryClusterModeSchemaRegistryClusterArgs] = None)
    func NewSchemaRegistryClusterMode(ctx *Context, name string, args *SchemaRegistryClusterModeArgs, opts ...ResourceOption) (*SchemaRegistryClusterMode, error)
    public SchemaRegistryClusterMode(string name, SchemaRegistryClusterModeArgs? args = null, CustomResourceOptions? opts = null)
    public SchemaRegistryClusterMode(String name, SchemaRegistryClusterModeArgs args)
    public SchemaRegistryClusterMode(String name, SchemaRegistryClusterModeArgs args, CustomResourceOptions options)
    
    type: confluentcloud:SchemaRegistryClusterMode
    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 SchemaRegistryClusterModeArgs
    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 SchemaRegistryClusterModeArgs
    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 SchemaRegistryClusterModeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchemaRegistryClusterModeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchemaRegistryClusterModeArgs
    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 schemaRegistryClusterModeResource = new ConfluentCloud.SchemaRegistryClusterMode("schemaRegistryClusterModeResource", new()
    {
        Credentials = new ConfluentCloud.Inputs.SchemaRegistryClusterModeCredentialsArgs
        {
            Key = "string",
            Secret = "string",
        },
        Mode = "string",
        RestEndpoint = "string",
        SchemaRegistryCluster = new ConfluentCloud.Inputs.SchemaRegistryClusterModeSchemaRegistryClusterArgs
        {
            Id = "string",
        },
    });
    
    example, err := confluentcloud.NewSchemaRegistryClusterMode(ctx, "schemaRegistryClusterModeResource", &confluentcloud.SchemaRegistryClusterModeArgs{
    	Credentials: &confluentcloud.SchemaRegistryClusterModeCredentialsArgs{
    		Key:    pulumi.String("string"),
    		Secret: pulumi.String("string"),
    	},
    	Mode:         pulumi.String("string"),
    	RestEndpoint: pulumi.String("string"),
    	SchemaRegistryCluster: &confluentcloud.SchemaRegistryClusterModeSchemaRegistryClusterArgs{
    		Id: pulumi.String("string"),
    	},
    })
    
    var schemaRegistryClusterModeResource = new SchemaRegistryClusterMode("schemaRegistryClusterModeResource", SchemaRegistryClusterModeArgs.builder()
        .credentials(SchemaRegistryClusterModeCredentialsArgs.builder()
            .key("string")
            .secret("string")
            .build())
        .mode("string")
        .restEndpoint("string")
        .schemaRegistryCluster(SchemaRegistryClusterModeSchemaRegistryClusterArgs.builder()
            .id("string")
            .build())
        .build());
    
    schema_registry_cluster_mode_resource = confluentcloud.SchemaRegistryClusterMode("schemaRegistryClusterModeResource",
        credentials=confluentcloud.SchemaRegistryClusterModeCredentialsArgs(
            key="string",
            secret="string",
        ),
        mode="string",
        rest_endpoint="string",
        schema_registry_cluster=confluentcloud.SchemaRegistryClusterModeSchemaRegistryClusterArgs(
            id="string",
        ))
    
    const schemaRegistryClusterModeResource = new confluentcloud.SchemaRegistryClusterMode("schemaRegistryClusterModeResource", {
        credentials: {
            key: "string",
            secret: "string",
        },
        mode: "string",
        restEndpoint: "string",
        schemaRegistryCluster: {
            id: "string",
        },
    });
    
    type: confluentcloud:SchemaRegistryClusterMode
    properties:
        credentials:
            key: string
            secret: string
        mode: string
        restEndpoint: string
        schemaRegistryCluster:
            id: string
    

    SchemaRegistryClusterMode Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SchemaRegistryClusterMode resource accepts the following input properties:

    Credentials Pulumi.ConfluentCloud.Inputs.SchemaRegistryClusterModeCredentials
    The Cluster API Credentials.
    Mode string
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster Pulumi.ConfluentCloud.Inputs.SchemaRegistryClusterModeSchemaRegistryCluster
    Credentials SchemaRegistryClusterModeCredentialsArgs
    The Cluster API Credentials.
    Mode string
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster SchemaRegistryClusterModeSchemaRegistryClusterArgs
    credentials SchemaRegistryClusterModeCredentials
    The Cluster API Credentials.
    mode String
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SchemaRegistryClusterModeSchemaRegistryCluster
    credentials SchemaRegistryClusterModeCredentials
    The Cluster API Credentials.
    mode string
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    restEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SchemaRegistryClusterModeSchemaRegistryCluster
    credentials SchemaRegistryClusterModeCredentialsArgs
    The Cluster API Credentials.
    mode str
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    rest_endpoint str
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schema_registry_cluster SchemaRegistryClusterModeSchemaRegistryClusterArgs
    credentials Property Map
    The Cluster API Credentials.
    mode String
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster Property Map

    Outputs

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

    Get an existing SchemaRegistryClusterMode 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?: SchemaRegistryClusterModeState, opts?: CustomResourceOptions): SchemaRegistryClusterMode
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            credentials: Optional[SchemaRegistryClusterModeCredentialsArgs] = None,
            mode: Optional[str] = None,
            rest_endpoint: Optional[str] = None,
            schema_registry_cluster: Optional[SchemaRegistryClusterModeSchemaRegistryClusterArgs] = None) -> SchemaRegistryClusterMode
    func GetSchemaRegistryClusterMode(ctx *Context, name string, id IDInput, state *SchemaRegistryClusterModeState, opts ...ResourceOption) (*SchemaRegistryClusterMode, error)
    public static SchemaRegistryClusterMode Get(string name, Input<string> id, SchemaRegistryClusterModeState? state, CustomResourceOptions? opts = null)
    public static SchemaRegistryClusterMode get(String name, Output<String> id, SchemaRegistryClusterModeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Credentials Pulumi.ConfluentCloud.Inputs.SchemaRegistryClusterModeCredentials
    The Cluster API Credentials.
    Mode string
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster Pulumi.ConfluentCloud.Inputs.SchemaRegistryClusterModeSchemaRegistryCluster
    Credentials SchemaRegistryClusterModeCredentialsArgs
    The Cluster API Credentials.
    Mode string
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster SchemaRegistryClusterModeSchemaRegistryClusterArgs
    credentials SchemaRegistryClusterModeCredentials
    The Cluster API Credentials.
    mode String
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SchemaRegistryClusterModeSchemaRegistryCluster
    credentials SchemaRegistryClusterModeCredentials
    The Cluster API Credentials.
    mode string
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    restEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SchemaRegistryClusterModeSchemaRegistryCluster
    credentials SchemaRegistryClusterModeCredentialsArgs
    The Cluster API Credentials.
    mode str
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    rest_endpoint str
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schema_registry_cluster SchemaRegistryClusterModeSchemaRegistryClusterArgs
    credentials Property Map
    The Cluster API Credentials.
    mode String
    The global Schema Registry mode. Accepted values are: READWRITE, READONLY, READONLY_OVERRIDE, and IMPORT.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster Property Map

    Supporting Types

    SchemaRegistryClusterModeCredentials, SchemaRegistryClusterModeCredentialsArgs

    Key string
    The Schema Registry API Key.
    Secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    Key string
    The Schema Registry API Key.
    Secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    key String
    The Schema Registry API Key.
    secret String
    The Cluster API Secret for your Confluent Cloud cluster.
    key string
    The Schema Registry API Key.
    secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    key str
    The Schema Registry API Key.
    secret str
    The Cluster API Secret for your Confluent Cloud cluster.
    key String
    The Schema Registry API Key.
    secret String
    The Cluster API Secret for your Confluent Cloud cluster.

    SchemaRegistryClusterModeSchemaRegistryCluster, SchemaRegistryClusterModeSchemaRegistryClusterArgs

    Id string
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    Id string
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id String
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id string
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id str
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id String
    The ID of the Schema Registry cluster, for example, lsrc-abc123.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Confluent v1.51.0 published on Friday, Jul 19, 2024 by Pulumi