Confluent v1.25.0, Sep 22 23

Confluent v1.25.0 published on Friday, Sep 22, 2023 by Pulumi

confluentcloud.BusinessMetadata

Explore with Pulumi AI

Confluent v1.25.0 published on Friday, Sep 22, 2023 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

new BusinessMetadata(name: string, args?: BusinessMetadataArgs, opts?: CustomResourceOptions);

@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)
@overload
def BusinessMetadata(resource_name: str,
                     args: Optional[BusinessMetadataArgs] = None,
                     opts: Optional[ResourceOptions] = 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.

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.

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 attribute.
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 attribute.
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 attribute.
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 attribute.
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 attribute.
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 attribute.
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 attribute.
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 attribute.
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 attribute.
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 attribute.
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 attribute.
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 attribute.
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 the Business Metadata.
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:
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 the Business Metadata.
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:
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 the Business Metadata.
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:
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 the Business Metadata.
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:
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 the Business Metadata.
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:
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 the Business Metadata.
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:
type String: (Required String) The type of the attribute, it always returns string.

BusinessMetadataCredentials, BusinessMetadataCredentialsArgs

Key string: The Schema Registry API Key.
Secret string

Key string: The Schema Registry API Key.
Secret string

key String: The Schema Registry API Key.
secret String

key string: The Schema Registry API Key.
secret string

key str: The Schema Registry API Key.
secret str

key String: The Schema Registry API Key.
secret String

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.

Confluent v1.25.0 published on Friday, Sep 22, 2023 by Pulumi

pulumi/pulumi-confluentcloud

confluentcloud.BusinessMetadata

On this page

On this page

Import

Create BusinessMetadata Resource

BusinessMetadata Resource Properties

Inputs

Outputs

Look up Existing BusinessMetadata Resource

Supporting Types

BusinessMetadataAttributeDefinition, BusinessMetadataAttributeDefinitionArgs

BusinessMetadataCredentials, BusinessMetadataCredentialsArgs

BusinessMetadataSchemaRegistryCluster, BusinessMetadataSchemaRegistryClusterArgs

Package Details

On this page

On this page