Confluent v1.17.0, Jun 1 23

confluentcloud.BusinessMetadataBinding

Explore with Pulumi AI

Import

You can import a Business Metadata Binding by using the Schema Registry cluster ID, Business Metadata name, entity name and entity type in the format <Schema Registry Cluster Id>/<Business Metadata Name>/<Entity Name>/<Entity Type>, 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/businessMetadataBinding:BusinessMetadataBinding main lsrc-8wrx70/PII/lsrc-8wrx70:.:100001/sr_schema

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

Create BusinessMetadataBinding Resource

new BusinessMetadataBinding(name: string, args: BusinessMetadataBindingArgs, opts?: CustomResourceOptions);

@overload
def BusinessMetadataBinding(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            attributes: Optional[Mapping[str, str]] = None,
                            business_metadata_name: Optional[str] = None,
                            credentials: Optional[BusinessMetadataBindingCredentialsArgs] = None,
                            entity_name: Optional[str] = None,
                            entity_type: Optional[str] = None,
                            rest_endpoint: Optional[str] = None,
                            schema_registry_cluster: Optional[BusinessMetadataBindingSchemaRegistryClusterArgs] = None)
@overload
def BusinessMetadataBinding(resource_name: str,
                            args: BusinessMetadataBindingArgs,
                            opts: Optional[ResourceOptions] = None)

func NewBusinessMetadataBinding(ctx *Context, name string, args BusinessMetadataBindingArgs, opts ...ResourceOption) (*BusinessMetadataBinding, error)

public BusinessMetadataBinding(string name, BusinessMetadataBindingArgs args, CustomResourceOptions? opts = null)

public BusinessMetadataBinding(String name, BusinessMetadataBindingArgs args)
public BusinessMetadataBinding(String name, BusinessMetadataBindingArgs args, CustomResourceOptions options)

type: confluentcloud:BusinessMetadataBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BusinessMetadataBindingArgs: 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 BusinessMetadataBindingArgs: 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 BusinessMetadataBindingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BusinessMetadataBindingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BusinessMetadataBindingArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

BusinessMetadataName string: 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.
EntityName string: The qualified name of the entity., for example, lsrc-8wrx70:.:100001.
EntityType string: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
Attributes Dictionary<string, string>: The attributes.
Credentials Pulumi.ConfluentCloud.Inputs.BusinessMetadataBindingCredentialsArgs: 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.BusinessMetadataBindingSchemaRegistryClusterArgs

BusinessMetadataName string: 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.
EntityName string: The qualified name of the entity., for example, lsrc-8wrx70:.:100001.
EntityType string: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
Attributes map[string]string: The attributes.
Credentials BusinessMetadataBindingCredentialsArgs: 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 BusinessMetadataBindingSchemaRegistryClusterArgs

businessMetadataName String: 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.
entityName String: The qualified name of the entity., for example, lsrc-8wrx70:.:100001.
entityType String: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
attributes Map<String,String>: The attributes.
credentials BusinessMetadataBindingCredentialsArgs: 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 BusinessMetadataBindingSchemaRegistryClusterArgs

businessMetadataName string: 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.
entityName string: The qualified name of the entity., for example, lsrc-8wrx70:.:100001.
entityType string: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
attributes {[key: string]: string}: The attributes.
credentials BusinessMetadataBindingCredentialsArgs: 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 BusinessMetadataBindingSchemaRegistryClusterArgs

business_metadata_name str: 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, lsrc-8wrx70:.:100001.
entity_type str: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
attributes Mapping[str, str]: The attributes.
credentials BusinessMetadataBindingCredentialsArgs: 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 BusinessMetadataBindingSchemaRegistryClusterArgs

businessMetadataName String: 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.
entityName String: The qualified name of the entity., for example, lsrc-8wrx70:.:100001.
entityType String: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
attributes Map<String>: The attributes.
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 BusinessMetadataBinding 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 BusinessMetadataBinding Resource

Get an existing BusinessMetadataBinding 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?: BusinessMetadataBindingState, opts?: CustomResourceOptions): BusinessMetadataBinding

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attributes: Optional[Mapping[str, str]] = None,
        business_metadata_name: Optional[str] = None,
        credentials: Optional[BusinessMetadataBindingCredentialsArgs] = None,
        entity_name: Optional[str] = None,
        entity_type: Optional[str] = None,
        rest_endpoint: Optional[str] = None,
        schema_registry_cluster: Optional[BusinessMetadataBindingSchemaRegistryClusterArgs] = None) -> BusinessMetadataBinding

func GetBusinessMetadataBinding(ctx *Context, name string, id IDInput, state *BusinessMetadataBindingState, opts ...ResourceOption) (*BusinessMetadataBinding, error)

public static BusinessMetadataBinding Get(string name, Input<string> id, BusinessMetadataBindingState? state, CustomResourceOptions? opts = null)

public static BusinessMetadataBinding get(String name, Output<String> id, BusinessMetadataBindingState 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:

Attributes Dictionary<string, string>: The attributes.
BusinessMetadataName string: 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.
Credentials Pulumi.ConfluentCloud.Inputs.BusinessMetadataBindingCredentialsArgs: The Cluster API Credentials.
EntityName string: The qualified name of the entity., for example, lsrc-8wrx70:.:100001.
EntityType string: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
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.BusinessMetadataBindingSchemaRegistryClusterArgs

Attributes map[string]string: The attributes.
BusinessMetadataName string: 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.
Credentials BusinessMetadataBindingCredentialsArgs: The Cluster API Credentials.
EntityName string: The qualified name of the entity., for example, lsrc-8wrx70:.:100001.
EntityType string: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
RestEndpoint string: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster BusinessMetadataBindingSchemaRegistryClusterArgs

attributes Map<String,String>: The attributes.
businessMetadataName String: 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.
credentials BusinessMetadataBindingCredentialsArgs: The Cluster API Credentials.
entityName String: The qualified name of the entity., for example, lsrc-8wrx70:.:100001.
entityType String: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
restEndpoint String: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster BusinessMetadataBindingSchemaRegistryClusterArgs

attributes {[key: string]: string}: The attributes.
businessMetadataName string: 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.
credentials BusinessMetadataBindingCredentialsArgs: The Cluster API Credentials.
entityName string: The qualified name of the entity., for example, lsrc-8wrx70:.:100001.
entityType string: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
restEndpoint string: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster BusinessMetadataBindingSchemaRegistryClusterArgs

attributes Mapping[str, str]: The attributes.
business_metadata_name str: 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.
credentials BusinessMetadataBindingCredentialsArgs: The Cluster API Credentials.
entity_name str: The qualified name of the entity., for example, lsrc-8wrx70:.:100001.
entity_type str: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
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 BusinessMetadataBindingSchemaRegistryClusterArgs

attributes Map<String>: The attributes.
businessMetadataName String: 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.
credentials Property Map: The Cluster API Credentials.
entityName String: The qualified name of the entity., for example, lsrc-8wrx70:.:100001.
entityType String: The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
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

BusinessMetadataBindingCredentials

Key string: The Schema Registry API Key.
Secret string: The Schema Registry API Secret.

Key string: The Schema Registry API Key.
Secret string: The Schema Registry API Secret.

key String: The Schema Registry API Key.
secret String: The Schema Registry API Secret.

key string: The Schema Registry API Key.
secret string: The Schema Registry API Secret.

key str: The Schema Registry API Key.
secret str: The Schema Registry API Secret.

key String: The Schema Registry API Key.
secret String: The Schema Registry API Secret.

BusinessMetadataBindingSchemaRegistryCluster

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.