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

confluentcloud.TagBinding

Explore with Pulumi AI

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

    Import

    You can import a Tag Binding by using the Schema Registry cluster ID, Tag name, entity name and entity type in the format <Schema Registry Cluster Id>/<Tag 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/tagBinding:TagBinding main lsrc-8wrx70/PII/lsrc-8wrx70:.:100001/sr_schema
    

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

    Create TagBinding Resource

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

    Constructor syntax

    new TagBinding(name: string, args: TagBindingArgs, opts?: CustomResourceOptions);
    @overload
    def TagBinding(resource_name: str,
                   args: TagBindingArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def TagBinding(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   entity_name: Optional[str] = None,
                   entity_type: Optional[str] = None,
                   tag_name: Optional[str] = None,
                   credentials: Optional[TagBindingCredentialsArgs] = None,
                   rest_endpoint: Optional[str] = None,
                   schema_registry_cluster: Optional[TagBindingSchemaRegistryClusterArgs] = None)
    func NewTagBinding(ctx *Context, name string, args TagBindingArgs, opts ...ResourceOption) (*TagBinding, error)
    public TagBinding(string name, TagBindingArgs args, CustomResourceOptions? opts = null)
    public TagBinding(String name, TagBindingArgs args)
    public TagBinding(String name, TagBindingArgs args, CustomResourceOptions options)
    
    type: confluentcloud:TagBinding
    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 TagBindingArgs
    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 TagBindingArgs
    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 TagBindingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TagBindingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TagBindingArgs
    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 tagBindingResource = new ConfluentCloud.TagBinding("tagBindingResource", new()
    {
        EntityName = "string",
        EntityType = "string",
        TagName = "string",
        Credentials = new ConfluentCloud.Inputs.TagBindingCredentialsArgs
        {
            Key = "string",
            Secret = "string",
        },
        RestEndpoint = "string",
        SchemaRegistryCluster = new ConfluentCloud.Inputs.TagBindingSchemaRegistryClusterArgs
        {
            Id = "string",
        },
    });
    
    example, err := confluentcloud.NewTagBinding(ctx, "tagBindingResource", &confluentcloud.TagBindingArgs{
    	EntityName: pulumi.String("string"),
    	EntityType: pulumi.String("string"),
    	TagName:    pulumi.String("string"),
    	Credentials: &confluentcloud.TagBindingCredentialsArgs{
    		Key:    pulumi.String("string"),
    		Secret: pulumi.String("string"),
    	},
    	RestEndpoint: pulumi.String("string"),
    	SchemaRegistryCluster: &confluentcloud.TagBindingSchemaRegistryClusterArgs{
    		Id: pulumi.String("string"),
    	},
    })
    
    var tagBindingResource = new TagBinding("tagBindingResource", TagBindingArgs.builder()
        .entityName("string")
        .entityType("string")
        .tagName("string")
        .credentials(TagBindingCredentialsArgs.builder()
            .key("string")
            .secret("string")
            .build())
        .restEndpoint("string")
        .schemaRegistryCluster(TagBindingSchemaRegistryClusterArgs.builder()
            .id("string")
            .build())
        .build());
    
    tag_binding_resource = confluentcloud.TagBinding("tagBindingResource",
        entity_name="string",
        entity_type="string",
        tag_name="string",
        credentials=confluentcloud.TagBindingCredentialsArgs(
            key="string",
            secret="string",
        ),
        rest_endpoint="string",
        schema_registry_cluster=confluentcloud.TagBindingSchemaRegistryClusterArgs(
            id="string",
        ))
    
    const tagBindingResource = new confluentcloud.TagBinding("tagBindingResource", {
        entityName: "string",
        entityType: "string",
        tagName: "string",
        credentials: {
            key: "string",
            secret: "string",
        },
        restEndpoint: "string",
        schemaRegistryCluster: {
            id: "string",
        },
    });
    
    type: confluentcloud:TagBinding
    properties:
        credentials:
            key: string
            secret: string
        entityName: string
        entityType: string
        restEndpoint: string
        schemaRegistryCluster:
            id: string
        tagName: string
    

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

    EntityName string
    The qualified name of the entity., for example, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    EntityType string
    The entity type.
    TagName string
    The name of the tag 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.TagBindingCredentials
    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.TagBindingSchemaRegistryCluster
    EntityName string
    The qualified name of the entity., for example, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    EntityType string
    The entity type.
    TagName string
    The name of the tag 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 TagBindingCredentialsArgs
    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 TagBindingSchemaRegistryClusterArgs
    entityName String
    The qualified name of the entity., for example, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    entityType String
    The entity type.
    tagName String
    The name of the tag 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 TagBindingCredentials
    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 TagBindingSchemaRegistryCluster
    entityName string
    The qualified name of the entity., for example, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    entityType string
    The entity type.
    tagName string
    The name of the tag 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 TagBindingCredentials
    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 TagBindingSchemaRegistryCluster
    entity_name str
    The qualified name of the entity., for example, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    entity_type str
    The entity type.
    tag_name str
    The name of the tag 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 TagBindingCredentialsArgs
    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 TagBindingSchemaRegistryClusterArgs
    entityName String
    The qualified name of the entity., for example, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    entityType String
    The entity type.
    tagName String
    The name of the tag 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.
    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 TagBinding 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 TagBinding Resource

    Get an existing TagBinding 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?: TagBindingState, opts?: CustomResourceOptions): TagBinding
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            credentials: Optional[TagBindingCredentialsArgs] = None,
            entity_name: Optional[str] = None,
            entity_type: Optional[str] = None,
            rest_endpoint: Optional[str] = None,
            schema_registry_cluster: Optional[TagBindingSchemaRegistryClusterArgs] = None,
            tag_name: Optional[str] = None) -> TagBinding
    func GetTagBinding(ctx *Context, name string, id IDInput, state *TagBindingState, opts ...ResourceOption) (*TagBinding, error)
    public static TagBinding Get(string name, Input<string> id, TagBindingState? state, CustomResourceOptions? opts = null)
    public static TagBinding get(String name, Output<String> id, TagBindingState 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.TagBindingCredentials
    The Cluster API Credentials.
    EntityName string
    The qualified name of the entity., for example, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    EntityType string
    The entity type.
    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.TagBindingSchemaRegistryCluster
    TagName string
    The name of the tag 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 TagBindingCredentialsArgs
    The Cluster API Credentials.
    EntityName string
    The qualified name of the entity., for example, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    EntityType string
    The entity type.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster TagBindingSchemaRegistryClusterArgs
    TagName string
    The name of the tag 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 TagBindingCredentials
    The Cluster API Credentials.
    entityName String
    The qualified name of the entity., for example, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    entityType String
    The entity type.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster TagBindingSchemaRegistryCluster
    tagName String
    The name of the tag 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 TagBindingCredentials
    The Cluster API Credentials.
    entityName string
    The qualified name of the entity., for example, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    entityType string
    The entity type.
    restEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster TagBindingSchemaRegistryCluster
    tagName string
    The name of the tag 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 TagBindingCredentialsArgs
    The Cluster API Credentials.
    entity_name str
    The qualified name of the entity., for example, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    entity_type str
    The entity type.
    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 TagBindingSchemaRegistryClusterArgs
    tag_name str
    The name of the tag 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, ${data.confluent_schema_registry_cluster.main.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.main.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}.
    entityType String
    The entity type.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster Property Map
    tagName String
    The name of the tag 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.

    Supporting Types

    TagBindingCredentials, TagBindingCredentialsArgs

    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.

    TagBindingSchemaRegistryCluster, TagBindingSchemaRegistryClusterArgs

    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