1. Packages
  2. Confluent Cloud
  3. API Docs
  4. SchemaRegistryClusterConfig
Confluent v1.50.0 published on Friday, Jul 12, 2024 by Pulumi

confluentcloud.SchemaRegistryClusterConfig

Explore with Pulumi AI

confluentcloud logo
Confluent v1.50.0 published on Friday, Jul 12, 2024 by Pulumi

    Import

    You can import a Schema Registry Cluster Config 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/schemaRegistryClusterConfig:SchemaRegistryClusterConfig example lsrc-abc123
    

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

    Create SchemaRegistryClusterConfig Resource

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

    Constructor syntax

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

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

    CompatibilityLevel string
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    Credentials Pulumi.ConfluentCloud.Inputs.SchemaRegistryClusterConfigCredentials
    The Cluster API Credentials.
    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.SchemaRegistryClusterConfigSchemaRegistryCluster
    CompatibilityLevel string
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    Credentials SchemaRegistryClusterConfigCredentialsArgs
    The Cluster API Credentials.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster SchemaRegistryClusterConfigSchemaRegistryClusterArgs
    compatibilityLevel String
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SchemaRegistryClusterConfigCredentials
    The Cluster API Credentials.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SchemaRegistryClusterConfigSchemaRegistryCluster
    compatibilityLevel string
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SchemaRegistryClusterConfigCredentials
    The Cluster API Credentials.
    restEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SchemaRegistryClusterConfigSchemaRegistryCluster
    compatibility_level str
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SchemaRegistryClusterConfigCredentialsArgs
    The Cluster API Credentials.
    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 SchemaRegistryClusterConfigSchemaRegistryClusterArgs
    compatibilityLevel String
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials Property Map
    The Cluster API Credentials.
    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 SchemaRegistryClusterConfig 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 SchemaRegistryClusterConfig Resource

    Get an existing SchemaRegistryClusterConfig 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?: SchemaRegistryClusterConfigState, opts?: CustomResourceOptions): SchemaRegistryClusterConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compatibility_level: Optional[str] = None,
            credentials: Optional[SchemaRegistryClusterConfigCredentialsArgs] = None,
            rest_endpoint: Optional[str] = None,
            schema_registry_cluster: Optional[SchemaRegistryClusterConfigSchemaRegistryClusterArgs] = None) -> SchemaRegistryClusterConfig
    func GetSchemaRegistryClusterConfig(ctx *Context, name string, id IDInput, state *SchemaRegistryClusterConfigState, opts ...ResourceOption) (*SchemaRegistryClusterConfig, error)
    public static SchemaRegistryClusterConfig Get(string name, Input<string> id, SchemaRegistryClusterConfigState? state, CustomResourceOptions? opts = null)
    public static SchemaRegistryClusterConfig get(String name, Output<String> id, SchemaRegistryClusterConfigState 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:
    CompatibilityLevel string
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    Credentials Pulumi.ConfluentCloud.Inputs.SchemaRegistryClusterConfigCredentials
    The Cluster API Credentials.
    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.SchemaRegistryClusterConfigSchemaRegistryCluster
    CompatibilityLevel string
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    Credentials SchemaRegistryClusterConfigCredentialsArgs
    The Cluster API Credentials.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster SchemaRegistryClusterConfigSchemaRegistryClusterArgs
    compatibilityLevel String
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SchemaRegistryClusterConfigCredentials
    The Cluster API Credentials.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SchemaRegistryClusterConfigSchemaRegistryCluster
    compatibilityLevel string
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SchemaRegistryClusterConfigCredentials
    The Cluster API Credentials.
    restEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SchemaRegistryClusterConfigSchemaRegistryCluster
    compatibility_level str
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SchemaRegistryClusterConfigCredentialsArgs
    The Cluster API Credentials.
    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 SchemaRegistryClusterConfigSchemaRegistryClusterArgs
    compatibilityLevel String
    The global Schema Registry compatibility level. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials Property Map
    The Cluster API Credentials.
    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

    SchemaRegistryClusterConfigCredentials, SchemaRegistryClusterConfigCredentialsArgs

    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.

    SchemaRegistryClusterConfigSchemaRegistryCluster, SchemaRegistryClusterConfigSchemaRegistryClusterArgs

    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.50.0 published on Friday, Jul 12, 2024 by Pulumi