1. Packages
  2. Confluent Cloud
  3. API Docs
  4. CatalogEntityAttributes
Confluent v1.46.0 published on Friday, May 10, 2024 by Pulumi

confluentcloud.CatalogEntityAttributes

Explore with Pulumi AI

confluentcloud logo
Confluent v1.46.0 published on Friday, May 10, 2024 by Pulumi

    Create CatalogEntityAttributes Resource

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

    Constructor syntax

    new CatalogEntityAttributes(name: string, args: CatalogEntityAttributesArgs, opts?: CustomResourceOptions);
    @overload
    def CatalogEntityAttributes(resource_name: str,
                                args: CatalogEntityAttributesArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def CatalogEntityAttributes(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                entity_name: Optional[str] = None,
                                entity_type: Optional[str] = None,
                                attributes: Optional[Mapping[str, str]] = None,
                                credentials: Optional[CatalogEntityAttributesCredentialsArgs] = None,
                                rest_endpoint: Optional[str] = None,
                                schema_registry_cluster: Optional[CatalogEntityAttributesSchemaRegistryClusterArgs] = None)
    func NewCatalogEntityAttributes(ctx *Context, name string, args CatalogEntityAttributesArgs, opts ...ResourceOption) (*CatalogEntityAttributes, error)
    public CatalogEntityAttributes(string name, CatalogEntityAttributesArgs args, CustomResourceOptions? opts = null)
    public CatalogEntityAttributes(String name, CatalogEntityAttributesArgs args)
    public CatalogEntityAttributes(String name, CatalogEntityAttributesArgs args, CustomResourceOptions options)
    
    type: confluentcloud:CatalogEntityAttributes
    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 CatalogEntityAttributesArgs
    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 CatalogEntityAttributesArgs
    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 CatalogEntityAttributesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogEntityAttributesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogEntityAttributesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var catalogEntityAttributesResource = new ConfluentCloud.CatalogEntityAttributes("catalogEntityAttributesResource", new()
    {
        EntityName = "string",
        EntityType = "string",
        Attributes = 
        {
            { "string", "string" },
        },
        Credentials = new ConfluentCloud.Inputs.CatalogEntityAttributesCredentialsArgs
        {
            Key = "string",
            Secret = "string",
        },
        RestEndpoint = "string",
        SchemaRegistryCluster = new ConfluentCloud.Inputs.CatalogEntityAttributesSchemaRegistryClusterArgs
        {
            Id = "string",
        },
    });
    
    example, err := confluentcloud.NewCatalogEntityAttributes(ctx, "catalogEntityAttributesResource", &confluentcloud.CatalogEntityAttributesArgs{
    	EntityName: pulumi.String("string"),
    	EntityType: pulumi.String("string"),
    	Attributes: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Credentials: &confluentcloud.CatalogEntityAttributesCredentialsArgs{
    		Key:    pulumi.String("string"),
    		Secret: pulumi.String("string"),
    	},
    	RestEndpoint: pulumi.String("string"),
    	SchemaRegistryCluster: &confluentcloud.CatalogEntityAttributesSchemaRegistryClusterArgs{
    		Id: pulumi.String("string"),
    	},
    })
    
    var catalogEntityAttributesResource = new CatalogEntityAttributes("catalogEntityAttributesResource", CatalogEntityAttributesArgs.builder()        
        .entityName("string")
        .entityType("string")
        .attributes(Map.of("string", "string"))
        .credentials(CatalogEntityAttributesCredentialsArgs.builder()
            .key("string")
            .secret("string")
            .build())
        .restEndpoint("string")
        .schemaRegistryCluster(CatalogEntityAttributesSchemaRegistryClusterArgs.builder()
            .id("string")
            .build())
        .build());
    
    catalog_entity_attributes_resource = confluentcloud.CatalogEntityAttributes("catalogEntityAttributesResource",
        entity_name="string",
        entity_type="string",
        attributes={
            "string": "string",
        },
        credentials=confluentcloud.CatalogEntityAttributesCredentialsArgs(
            key="string",
            secret="string",
        ),
        rest_endpoint="string",
        schema_registry_cluster=confluentcloud.CatalogEntityAttributesSchemaRegistryClusterArgs(
            id="string",
        ))
    
    const catalogEntityAttributesResource = new confluentcloud.CatalogEntityAttributes("catalogEntityAttributesResource", {
        entityName: "string",
        entityType: "string",
        attributes: {
            string: "string",
        },
        credentials: {
            key: "string",
            secret: "string",
        },
        restEndpoint: "string",
        schemaRegistryCluster: {
            id: "string",
        },
    });
    
    type: confluentcloud:CatalogEntityAttributes
    properties:
        attributes:
            string: string
        credentials:
            key: string
            secret: string
        entityName: string
        entityType: string
        restEndpoint: string
        schemaRegistryCluster:
            id: string
    

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

    EntityName 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}.
    EntityType string
    The entity type, for example, sr_schema, kafka_topic. Refer to the Entity types to learn more about entity types.
    Attributes Dictionary<string, string>
    The attributes.
    Credentials Pulumi.ConfluentCloud.Inputs.CatalogEntityAttributesCredentials
    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.CatalogEntityAttributesSchemaRegistryCluster
    EntityName 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}.
    EntityType string
    The entity type, for example, sr_schema, kafka_topic. Refer to the Entity types to learn more about entity types.
    Attributes map[string]string
    The attributes.
    Credentials CatalogEntityAttributesCredentialsArgs
    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 CatalogEntityAttributesSchemaRegistryClusterArgs
    entityName 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}.
    entityType String
    The entity type, for example, sr_schema, kafka_topic. Refer to the Entity types to learn more about entity types.
    attributes Map<String,String>
    The attributes.
    credentials CatalogEntityAttributesCredentials
    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 CatalogEntityAttributesSchemaRegistryCluster
    entityName 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}.
    entityType string
    The entity type, for example, sr_schema, kafka_topic. Refer to the Entity types to learn more about entity types.
    attributes {[key: string]: string}
    The attributes.
    credentials CatalogEntityAttributesCredentials
    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 CatalogEntityAttributesSchemaRegistryCluster
    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, kafka_topic. Refer to the Entity types to learn more about entity types.
    attributes Mapping[str, str]
    The attributes.
    credentials CatalogEntityAttributesCredentialsArgs
    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 CatalogEntityAttributesSchemaRegistryClusterArgs
    entityName 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}.
    entityType String
    The entity type, for example, sr_schema, kafka_topic. 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 CatalogEntityAttributes 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 CatalogEntityAttributes Resource

    Get an existing CatalogEntityAttributes 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?: CatalogEntityAttributesState, opts?: CustomResourceOptions): CatalogEntityAttributes
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            attributes: Optional[Mapping[str, str]] = None,
            credentials: Optional[CatalogEntityAttributesCredentialsArgs] = None,
            entity_name: Optional[str] = None,
            entity_type: Optional[str] = None,
            rest_endpoint: Optional[str] = None,
            schema_registry_cluster: Optional[CatalogEntityAttributesSchemaRegistryClusterArgs] = None) -> CatalogEntityAttributes
    func GetCatalogEntityAttributes(ctx *Context, name string, id IDInput, state *CatalogEntityAttributesState, opts ...ResourceOption) (*CatalogEntityAttributes, error)
    public static CatalogEntityAttributes Get(string name, Input<string> id, CatalogEntityAttributesState? state, CustomResourceOptions? opts = null)
    public static CatalogEntityAttributes get(String name, Output<String> id, CatalogEntityAttributesState 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.
    Credentials Pulumi.ConfluentCloud.Inputs.CatalogEntityAttributesCredentials
    The Cluster API Credentials.
    EntityName 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}.
    EntityType string
    The entity type, for example, sr_schema, kafka_topic. 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.CatalogEntityAttributesSchemaRegistryCluster
    Attributes map[string]string
    The attributes.
    Credentials CatalogEntityAttributesCredentialsArgs
    The Cluster API Credentials.
    EntityName 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}.
    EntityType string
    The entity type, for example, sr_schema, kafka_topic. 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 CatalogEntityAttributesSchemaRegistryClusterArgs
    attributes Map<String,String>
    The attributes.
    credentials CatalogEntityAttributesCredentials
    The Cluster API Credentials.
    entityName 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}.
    entityType String
    The entity type, for example, sr_schema, kafka_topic. 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 CatalogEntityAttributesSchemaRegistryCluster
    attributes {[key: string]: string}
    The attributes.
    credentials CatalogEntityAttributesCredentials
    The Cluster API Credentials.
    entityName 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}.
    entityType string
    The entity type, for example, sr_schema, kafka_topic. 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 CatalogEntityAttributesSchemaRegistryCluster
    attributes Mapping[str, str]
    The attributes.
    credentials CatalogEntityAttributesCredentialsArgs
    The Cluster API Credentials.
    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, kafka_topic. 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 CatalogEntityAttributesSchemaRegistryClusterArgs
    attributes Map<String>
    The attributes.
    credentials Property Map
    The Cluster API Credentials.
    entityName 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}.
    entityType String
    The entity type, for example, sr_schema, kafka_topic. 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

    CatalogEntityAttributesCredentials, CatalogEntityAttributesCredentialsArgs

    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.

    CatalogEntityAttributesSchemaRegistryCluster, CatalogEntityAttributesSchemaRegistryClusterArgs

    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.46.0 published on Friday, May 10, 2024 by Pulumi