confluentcloud.getBusinessMetadataBinding
Explore with Pulumi AI
Using getBusinessMetadataBinding
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBusinessMetadataBinding(args: GetBusinessMetadataBindingArgs, opts?: InvokeOptions): Promise<GetBusinessMetadataBindingResult>
function getBusinessMetadataBindingOutput(args: GetBusinessMetadataBindingOutputArgs, opts?: InvokeOptions): Output<GetBusinessMetadataBindingResult>def get_business_metadata_binding(business_metadata_name: Optional[str] = None,
                                  credentials: Optional[GetBusinessMetadataBindingCredentials] = None,
                                  entity_name: Optional[str] = None,
                                  entity_type: Optional[str] = None,
                                  rest_endpoint: Optional[str] = None,
                                  schema_registry_cluster: Optional[GetBusinessMetadataBindingSchemaRegistryCluster] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetBusinessMetadataBindingResult
def get_business_metadata_binding_output(business_metadata_name: Optional[pulumi.Input[str]] = None,
                                  credentials: Optional[pulumi.Input[GetBusinessMetadataBindingCredentialsArgs]] = None,
                                  entity_name: Optional[pulumi.Input[str]] = None,
                                  entity_type: Optional[pulumi.Input[str]] = None,
                                  rest_endpoint: Optional[pulumi.Input[str]] = None,
                                  schema_registry_cluster: Optional[pulumi.Input[GetBusinessMetadataBindingSchemaRegistryClusterArgs]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetBusinessMetadataBindingResult]func LookupBusinessMetadataBinding(ctx *Context, args *LookupBusinessMetadataBindingArgs, opts ...InvokeOption) (*LookupBusinessMetadataBindingResult, error)
func LookupBusinessMetadataBindingOutput(ctx *Context, args *LookupBusinessMetadataBindingOutputArgs, opts ...InvokeOption) LookupBusinessMetadataBindingResultOutput> Note: This function is named LookupBusinessMetadataBinding in the Go SDK.
public static class GetBusinessMetadataBinding 
{
    public static Task<GetBusinessMetadataBindingResult> InvokeAsync(GetBusinessMetadataBindingArgs args, InvokeOptions? opts = null)
    public static Output<GetBusinessMetadataBindingResult> Invoke(GetBusinessMetadataBindingInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetBusinessMetadataBindingResult> getBusinessMetadataBinding(GetBusinessMetadataBindingArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: confluentcloud:index/getBusinessMetadataBinding:getBusinessMetadataBinding
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Business
Metadata stringName  - The name of the Business Metadata to be applied, for example, 
PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters. - Entity
Name string - The qualified name of the entity., for example, 
${confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier},${confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. - Entity
Type string - The entity type, for example, 
sr_schema. - Credentials
Pulumi.
Confluent Cloud. Inputs. Get Business Metadata Binding Credentials  - Rest
Endpoint string - The REST endpoint of the Schema Registry cluster, for example, 
https://psrc-00000.us-central1.gcp.confluent.cloud:443). - Schema
Registry Pulumi.Cluster Confluent Cloud. Inputs. Get Business Metadata Binding Schema Registry Cluster  
- Business
Metadata stringName  - The name of the Business Metadata to be applied, for example, 
PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters. - Entity
Name string - The qualified name of the entity., for example, 
${confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier},${confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. - Entity
Type string - The entity type, for example, 
sr_schema. - Credentials
Get
Business Metadata Binding Credentials  - Rest
Endpoint string - The REST endpoint of the Schema Registry cluster, for example, 
https://psrc-00000.us-central1.gcp.confluent.cloud:443). - Schema
Registry GetCluster Business Metadata Binding Schema Registry Cluster  
- business
Metadata StringName  - The name of the Business Metadata to be applied, for example, 
PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters. - entity
Name String - The qualified name of the entity., for example, 
${confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier},${confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. - entity
Type String - The entity type, for example, 
sr_schema. - credentials
Get
Business Metadata Binding Credentials  - rest
Endpoint String - The REST endpoint of the Schema Registry cluster, for example, 
https://psrc-00000.us-central1.gcp.confluent.cloud:443). - schema
Registry GetCluster Business Metadata Binding Schema Registry Cluster  
- business
Metadata stringName  - The name of the Business Metadata to be applied, for example, 
PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters. - entity
Name string - The qualified name of the entity., for example, 
${confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier},${confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. - entity
Type string - The entity type, for example, 
sr_schema. - credentials
Get
Business Metadata Binding Credentials  - rest
Endpoint string - The REST endpoint of the Schema Registry cluster, for example, 
https://psrc-00000.us-central1.gcp.confluent.cloud:443). - schema
Registry GetCluster Business Metadata Binding Schema Registry Cluster  
- business_
metadata_ strname  - The name of the Business Metadata to be applied, for example, 
PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters. - entity_
name str - The qualified name of the entity., for example, 
${confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier},${confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. - entity_
type str - The entity type, for example, 
sr_schema. - credentials
Get
Business Metadata Binding 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_ Getcluster Business Metadata Binding Schema Registry Cluster  
- business
Metadata StringName  - The name of the Business Metadata to be applied, for example, 
PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters. - entity
Name String - The qualified name of the entity., for example, 
${confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier},${confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. - entity
Type String - The entity type, for example, 
sr_schema. - credentials Property Map
 - rest
Endpoint String - The REST endpoint of the Schema Registry cluster, for example, 
https://psrc-00000.us-central1.gcp.confluent.cloud:443). - schema
Registry Property MapCluster  
getBusinessMetadataBinding Result
The following output properties are available:
- Attributes Dictionary<string, string>
 - (Optional Map) The block of key-value pair attributes.
 - Business
Metadata stringName  - Entity
Name string - Entity
Type string - Id string
 - (Required String) The ID of the Business Metadata Binding, in the format 
<Schema Registry Cluster Id>/<Business Metadata Name>/<Entity Name>/<Entity Type>, for example,lsrc-8wrx70/PII/lsrc-8wrx70:.:100001/sr_schema. - Credentials
Pulumi.
Confluent Cloud. Outputs. Get Business Metadata Binding Credentials  - Rest
Endpoint string - Schema
Registry Pulumi.Cluster Confluent Cloud. Outputs. Get Business Metadata Binding Schema Registry Cluster  
- Attributes map[string]string
 - (Optional Map) The block of key-value pair attributes.
 - Business
Metadata stringName  - Entity
Name string - Entity
Type string - Id string
 - (Required String) The ID of the Business Metadata Binding, in the format 
<Schema Registry Cluster Id>/<Business Metadata Name>/<Entity Name>/<Entity Type>, for example,lsrc-8wrx70/PII/lsrc-8wrx70:.:100001/sr_schema. - Credentials
Get
Business Metadata Binding Credentials  - Rest
Endpoint string - Schema
Registry GetCluster Business Metadata Binding Schema Registry Cluster  
- attributes Map<String,String>
 - (Optional Map) The block of key-value pair attributes.
 - business
Metadata StringName  - entity
Name String - entity
Type String - id String
 - (Required String) The ID of the Business Metadata Binding, in the format 
<Schema Registry Cluster Id>/<Business Metadata Name>/<Entity Name>/<Entity Type>, for example,lsrc-8wrx70/PII/lsrc-8wrx70:.:100001/sr_schema. - credentials
Get
Business Metadata Binding Credentials  - rest
Endpoint String - schema
Registry GetCluster Business Metadata Binding Schema Registry Cluster  
- attributes {[key: string]: string}
 - (Optional Map) The block of key-value pair attributes.
 - business
Metadata stringName  - entity
Name string - entity
Type string - id string
 - (Required String) The ID of the Business Metadata Binding, in the format 
<Schema Registry Cluster Id>/<Business Metadata Name>/<Entity Name>/<Entity Type>, for example,lsrc-8wrx70/PII/lsrc-8wrx70:.:100001/sr_schema. - credentials
Get
Business Metadata Binding Credentials  - rest
Endpoint string - schema
Registry GetCluster Business Metadata Binding Schema Registry Cluster  
- attributes Mapping[str, str]
 - (Optional Map) The block of key-value pair attributes.
 - business_
metadata_ strname  - entity_
name str - entity_
type str - id str
 - (Required String) The ID of the Business Metadata Binding, in the format 
<Schema Registry Cluster Id>/<Business Metadata Name>/<Entity Name>/<Entity Type>, for example,lsrc-8wrx70/PII/lsrc-8wrx70:.:100001/sr_schema. - credentials
Get
Business Metadata Binding Credentials  - rest_
endpoint str - schema_
registry_ Getcluster Business Metadata Binding Schema Registry Cluster  
- attributes Map<String>
 - (Optional Map) The block of key-value pair attributes.
 - business
Metadata StringName  - entity
Name String - entity
Type String - id String
 - (Required String) The ID of the Business Metadata Binding, in the format 
<Schema Registry Cluster Id>/<Business Metadata Name>/<Entity Name>/<Entity Type>, for example,lsrc-8wrx70/PII/lsrc-8wrx70:.:100001/sr_schema. - credentials Property Map
 - rest
Endpoint String - schema
Registry Property MapCluster  
Supporting Types
GetBusinessMetadataBindingCredentials    
- Key string
 - The Schema Registry API Key.
 - Secret string
 The Schema Registry API Secret.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
- Key string
 - The Schema Registry API Key.
 - Secret string
 The Schema Registry API Secret.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
- key String
 - The Schema Registry API Key.
 - secret String
 The Schema Registry API Secret.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
- key string
 - The Schema Registry API Key.
 - secret string
 The Schema Registry API Secret.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
- key str
 - The Schema Registry API Key.
 - secret str
 The Schema Registry API Secret.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
- key String
 - The Schema Registry API Key.
 - secret String
 The Schema Registry API Secret.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
GetBusinessMetadataBindingSchemaRegistryCluster      
- 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 
confluentTerraform Provider.