1. Packages
  2. Confluent Cloud
  3. API Docs
  4. BusinessMetadata
Confluent v1.47.0 published on Wednesday, Jun 12, 2024 by Pulumi

confluentcloud.BusinessMetadata

Explore with Pulumi AI

confluentcloud logo
Confluent v1.47.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Import

    You can import a Business Metadata by using the Schema Registry cluster ID, Business Metadata name in the format <Schema Registry cluster ID>/<Business Metadata name>, 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/businessMetadata:BusinessMetadata pii lsrc-8wrx70/PII
    

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

    Create BusinessMetadata Resource

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

    Constructor syntax

    new BusinessMetadata(name: string, args?: BusinessMetadataArgs, opts?: CustomResourceOptions);
    @overload
    def BusinessMetadata(resource_name: str,
                         args: Optional[BusinessMetadataArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def BusinessMetadata(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         attribute_definitions: Optional[Sequence[BusinessMetadataAttributeDefinitionArgs]] = None,
                         credentials: Optional[BusinessMetadataCredentialsArgs] = None,
                         description: Optional[str] = None,
                         name: Optional[str] = None,
                         rest_endpoint: Optional[str] = None,
                         schema_registry_cluster: Optional[BusinessMetadataSchemaRegistryClusterArgs] = None)
    func NewBusinessMetadata(ctx *Context, name string, args *BusinessMetadataArgs, opts ...ResourceOption) (*BusinessMetadata, error)
    public BusinessMetadata(string name, BusinessMetadataArgs? args = null, CustomResourceOptions? opts = null)
    public BusinessMetadata(String name, BusinessMetadataArgs args)
    public BusinessMetadata(String name, BusinessMetadataArgs args, CustomResourceOptions options)
    
    type: confluentcloud:BusinessMetadata
    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 BusinessMetadataArgs
    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 BusinessMetadataArgs
    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 BusinessMetadataArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BusinessMetadataArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BusinessMetadataArgs
    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 businessMetadataResource = new ConfluentCloud.BusinessMetadata("businessMetadataResource", new()
    {
        AttributeDefinitions = new[]
        {
            new ConfluentCloud.Inputs.BusinessMetadataAttributeDefinitionArgs
            {
                Name = "string",
                DefaultValue = "string",
                Description = "string",
                IsOptional = false,
                Options = 
                {
                    { "string", "string" },
                },
                Type = "string",
            },
        },
        Credentials = new ConfluentCloud.Inputs.BusinessMetadataCredentialsArgs
        {
            Key = "string",
            Secret = "string",
        },
        Description = "string",
        Name = "string",
        RestEndpoint = "string",
        SchemaRegistryCluster = new ConfluentCloud.Inputs.BusinessMetadataSchemaRegistryClusterArgs
        {
            Id = "string",
        },
    });
    
    example, err := confluentcloud.NewBusinessMetadata(ctx, "businessMetadataResource", &confluentcloud.BusinessMetadataArgs{
    	AttributeDefinitions: confluentcloud.BusinessMetadataAttributeDefinitionArray{
    		&confluentcloud.BusinessMetadataAttributeDefinitionArgs{
    			Name:         pulumi.String("string"),
    			DefaultValue: pulumi.String("string"),
    			Description:  pulumi.String("string"),
    			IsOptional:   pulumi.Bool(false),
    			Options: pulumi.StringMap{
    				"string": pulumi.String("string"),
    			},
    			Type: pulumi.String("string"),
    		},
    	},
    	Credentials: &confluentcloud.BusinessMetadataCredentialsArgs{
    		Key:    pulumi.String("string"),
    		Secret: pulumi.String("string"),
    	},
    	Description:  pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	RestEndpoint: pulumi.String("string"),
    	SchemaRegistryCluster: &confluentcloud.BusinessMetadataSchemaRegistryClusterArgs{
    		Id: pulumi.String("string"),
    	},
    })
    
    var businessMetadataResource = new BusinessMetadata("businessMetadataResource", BusinessMetadataArgs.builder()
        .attributeDefinitions(BusinessMetadataAttributeDefinitionArgs.builder()
            .name("string")
            .defaultValue("string")
            .description("string")
            .isOptional(false)
            .options(Map.of("string", "string"))
            .type("string")
            .build())
        .credentials(BusinessMetadataCredentialsArgs.builder()
            .key("string")
            .secret("string")
            .build())
        .description("string")
        .name("string")
        .restEndpoint("string")
        .schemaRegistryCluster(BusinessMetadataSchemaRegistryClusterArgs.builder()
            .id("string")
            .build())
        .build());
    
    business_metadata_resource = confluentcloud.BusinessMetadata("businessMetadataResource",
        attribute_definitions=[confluentcloud.BusinessMetadataAttributeDefinitionArgs(
            name="string",
            default_value="string",
            description="string",
            is_optional=False,
            options={
                "string": "string",
            },
            type="string",
        )],
        credentials=confluentcloud.BusinessMetadataCredentialsArgs(
            key="string",
            secret="string",
        ),
        description="string",
        name="string",
        rest_endpoint="string",
        schema_registry_cluster=confluentcloud.BusinessMetadataSchemaRegistryClusterArgs(
            id="string",
        ))
    
    const businessMetadataResource = new confluentcloud.BusinessMetadata("businessMetadataResource", {
        attributeDefinitions: [{
            name: "string",
            defaultValue: "string",
            description: "string",
            isOptional: false,
            options: {
                string: "string",
            },
            type: "string",
        }],
        credentials: {
            key: "string",
            secret: "string",
        },
        description: "string",
        name: "string",
        restEndpoint: "string",
        schemaRegistryCluster: {
            id: "string",
        },
    });
    
    type: confluentcloud:BusinessMetadata
    properties:
        attributeDefinitions:
            - defaultValue: string
              description: string
              isOptional: false
              name: string
              options:
                string: string
              type: string
        credentials:
            key: string
            secret: string
        description: string
        name: string
        restEndpoint: string
        schemaRegistryCluster:
            id: string
    

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

    AttributeDefinitions List<Pulumi.ConfluentCloud.Inputs.BusinessMetadataAttributeDefinition>
    The list of attribute definitions (see Business Metadata for more details):
    Credentials Pulumi.ConfluentCloud.Inputs.BusinessMetadataCredentials
    The Cluster API Credentials.
    Description string
    The description of the Business Metadata.
    Name string
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    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.BusinessMetadataSchemaRegistryCluster
    AttributeDefinitions []BusinessMetadataAttributeDefinitionArgs
    The list of attribute definitions (see Business Metadata for more details):
    Credentials BusinessMetadataCredentialsArgs
    The Cluster API Credentials.
    Description string
    The description of the Business Metadata.
    Name string
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster BusinessMetadataSchemaRegistryClusterArgs
    attributeDefinitions List<BusinessMetadataAttributeDefinition>
    The list of attribute definitions (see Business Metadata for more details):
    credentials BusinessMetadataCredentials
    The Cluster API Credentials.
    description String
    The description of the Business Metadata.
    name String
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster BusinessMetadataSchemaRegistryCluster
    attributeDefinitions BusinessMetadataAttributeDefinition[]
    The list of attribute definitions (see Business Metadata for more details):
    credentials BusinessMetadataCredentials
    The Cluster API Credentials.
    description string
    The description of the Business Metadata.
    name string
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    restEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster BusinessMetadataSchemaRegistryCluster
    attribute_definitions Sequence[BusinessMetadataAttributeDefinitionArgs]
    The list of attribute definitions (see Business Metadata for more details):
    credentials BusinessMetadataCredentialsArgs
    The Cluster API Credentials.
    description str
    The description of the Business Metadata.
    name str
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    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 BusinessMetadataSchemaRegistryClusterArgs
    attributeDefinitions List<Property Map>
    The list of attribute definitions (see Business Metadata for more details):
    credentials Property Map
    The Cluster API Credentials.
    description String
    The description of the Business Metadata.
    name String
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    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 BusinessMetadata resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    (Required Integer) The version of the Business Metadata, for example, 1.
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    (Required Integer) The version of the Business Metadata, for example, 1.
    id String
    The provider-assigned unique ID for this managed resource.
    version Integer
    (Required Integer) The version of the Business Metadata, for example, 1.
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    (Required Integer) The version of the Business Metadata, for example, 1.
    id str
    The provider-assigned unique ID for this managed resource.
    version int
    (Required Integer) The version of the Business Metadata, for example, 1.
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    (Required Integer) The version of the Business Metadata, for example, 1.

    Look up Existing BusinessMetadata Resource

    Get an existing BusinessMetadata 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?: BusinessMetadataState, opts?: CustomResourceOptions): BusinessMetadata
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            attribute_definitions: Optional[Sequence[BusinessMetadataAttributeDefinitionArgs]] = None,
            credentials: Optional[BusinessMetadataCredentialsArgs] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            rest_endpoint: Optional[str] = None,
            schema_registry_cluster: Optional[BusinessMetadataSchemaRegistryClusterArgs] = None,
            version: Optional[int] = None) -> BusinessMetadata
    func GetBusinessMetadata(ctx *Context, name string, id IDInput, state *BusinessMetadataState, opts ...ResourceOption) (*BusinessMetadata, error)
    public static BusinessMetadata Get(string name, Input<string> id, BusinessMetadataState? state, CustomResourceOptions? opts = null)
    public static BusinessMetadata get(String name, Output<String> id, BusinessMetadataState 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:
    AttributeDefinitions List<Pulumi.ConfluentCloud.Inputs.BusinessMetadataAttributeDefinition>
    The list of attribute definitions (see Business Metadata for more details):
    Credentials Pulumi.ConfluentCloud.Inputs.BusinessMetadataCredentials
    The Cluster API Credentials.
    Description string
    The description of the Business Metadata.
    Name string
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    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.BusinessMetadataSchemaRegistryCluster
    Version int
    (Required Integer) The version of the Business Metadata, for example, 1.
    AttributeDefinitions []BusinessMetadataAttributeDefinitionArgs
    The list of attribute definitions (see Business Metadata for more details):
    Credentials BusinessMetadataCredentialsArgs
    The Cluster API Credentials.
    Description string
    The description of the Business Metadata.
    Name string
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster BusinessMetadataSchemaRegistryClusterArgs
    Version int
    (Required Integer) The version of the Business Metadata, for example, 1.
    attributeDefinitions List<BusinessMetadataAttributeDefinition>
    The list of attribute definitions (see Business Metadata for more details):
    credentials BusinessMetadataCredentials
    The Cluster API Credentials.
    description String
    The description of the Business Metadata.
    name String
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster BusinessMetadataSchemaRegistryCluster
    version Integer
    (Required Integer) The version of the Business Metadata, for example, 1.
    attributeDefinitions BusinessMetadataAttributeDefinition[]
    The list of attribute definitions (see Business Metadata for more details):
    credentials BusinessMetadataCredentials
    The Cluster API Credentials.
    description string
    The description of the Business Metadata.
    name string
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    restEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster BusinessMetadataSchemaRegistryCluster
    version number
    (Required Integer) The version of the Business Metadata, for example, 1.
    attribute_definitions Sequence[BusinessMetadataAttributeDefinitionArgs]
    The list of attribute definitions (see Business Metadata for more details):
    credentials BusinessMetadataCredentialsArgs
    The Cluster API Credentials.
    description str
    The description of the Business Metadata.
    name str
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    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 BusinessMetadataSchemaRegistryClusterArgs
    version int
    (Required Integer) The version of the Business Metadata, for example, 1.
    attributeDefinitions List<Property Map>
    The list of attribute definitions (see Business Metadata for more details):
    credentials Property Map
    The Cluster API Credentials.
    description String
    The description of the Business Metadata.
    name String
    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster Property Map
    version Number
    (Required Integer) The version of the Business Metadata, for example, 1.

    Supporting Types

    BusinessMetadataAttributeDefinition, BusinessMetadataAttributeDefinitionArgs

    Name string
    The name of the attribute.
    DefaultValue string
    The default value of this attribute.
    Description string
    The description of this attribute.
    IsOptional bool
    An optional flag to control whether the attribute should be optional or required. The default value is false.
    Options Dictionary<string, string>
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    Type string
    (Required String) The type of the attribute, it always returns string.
    Name string
    The name of the attribute.
    DefaultValue string
    The default value of this attribute.
    Description string
    The description of this attribute.
    IsOptional bool
    An optional flag to control whether the attribute should be optional or required. The default value is false.
    Options map[string]string
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    Type string
    (Required String) The type of the attribute, it always returns string.
    name String
    The name of the attribute.
    defaultValue String
    The default value of this attribute.
    description String
    The description of this attribute.
    isOptional Boolean
    An optional flag to control whether the attribute should be optional or required. The default value is false.
    options Map<String,String>
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    type String
    (Required String) The type of the attribute, it always returns string.
    name string
    The name of the attribute.
    defaultValue string
    The default value of this attribute.
    description string
    The description of this attribute.
    isOptional boolean
    An optional flag to control whether the attribute should be optional or required. The default value is false.
    options {[key: string]: string}
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    type string
    (Required String) The type of the attribute, it always returns string.
    name str
    The name of the attribute.
    default_value str
    The default value of this attribute.
    description str
    The description of this attribute.
    is_optional bool
    An optional flag to control whether the attribute should be optional or required. The default value is false.
    options Mapping[str, str]
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    type str
    (Required String) The type of the attribute, it always returns string.
    name String
    The name of the attribute.
    defaultValue String
    The default value of this attribute.
    description String
    The description of this attribute.
    isOptional Boolean
    An optional flag to control whether the attribute should be optional or required. The default value is false.
    options Map<String>
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    type String
    (Required String) The type of the attribute, it always returns string.

    BusinessMetadataCredentials, BusinessMetadataCredentialsArgs

    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.

    BusinessMetadataSchemaRegistryCluster, BusinessMetadataSchemaRegistryClusterArgs

    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.47.0 published on Wednesday, Jun 12, 2024 by Pulumi