confluentcloud.Schema

Ruleset Pulumi.ConfluentCloud.Inputs.SchemaRuleset

Controls whether a schema should be recreated on update.

RestEndpoint string

The REST endpoint of the Schema Registry cluster. For example, for public networking: https://psrc-00000.us-central1.gcp.confluent.cloud. In the case of private networking, the endpoint might look like https://lsrc-abc123.pr1jy6.us-east-2.aws.confluent.cloud. You can construct it using either:

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

SchemaDetails string

The definition of the Schema.

SchemaReferences List<Pulumi.ConfluentCloud.Inputs.SchemaSchemaReference>

The list of references to other Schemas.

SchemaRegistryCluster Pulumi.ConfluentCloud.Inputs.SchemaSchemaRegistryCluster

Credentials SchemaCredentialsArgs

Format string

The format of the Schema.

SubjectName string

The Cluster API Credentials.

HardDelete bool

Controls whether a schema should be soft or hard deleted. Set it to true if you want to hard delete a schema on destroy. Defaults to false (soft delete).

Metadata SchemaMetadataArgs

Ruleset SchemaRulesetArgs

Controls whether a schema should be recreated on update.

RestEndpoint string

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

Schema string

The definition of the Schema.

SchemaReferences []SchemaSchemaReferenceArgs

The list of references to other Schemas.

SchemaRegistryCluster SchemaSchemaRegistryClusterArgs

format String

The format of the Schema.

subjectName String

The Cluster API Credentials.

hardDelete Boolean

Controls whether a schema should be soft or hard deleted. Set it to true if you want to hard delete a schema on destroy. Defaults to false (soft delete).

recreateOnUpdate Boolean

Controls whether a schema should be recreated on update.

restEndpoint String

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

schemaReferences List<SchemaSchemaReference>

schema String

The definition of the Schema.

The list of references to other Schemas.

schemaRegistryCluster SchemaSchemaRegistryCluster

format string

The format of the Schema.

subjectName string

The Cluster API Credentials.

hardDelete boolean

Controls whether a schema should be soft or hard deleted. Set it to true if you want to hard delete a schema on destroy. Defaults to false (soft delete).

recreateOnUpdate boolean

Controls whether a schema should be recreated on update.

restEndpoint string

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

schemaReferences SchemaSchemaReference[]

schema string

The definition of the Schema.

The list of references to other Schemas.

schemaRegistryCluster SchemaSchemaRegistryCluster

skipValidationDuringPlan boolean

format str

The format of the Schema.

subject_name str

credentials SchemaCredentialsArgs

The Cluster API Credentials.

hard_delete bool

Controls whether a schema should be soft or hard deleted. Set it to true if you want to hard delete a schema on destroy. Defaults to false (soft delete).

metadata SchemaMetadataArgs

recreate_on_update bool

Controls whether a schema should be recreated on update.

rest_endpoint str

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

ruleset SchemaRulesetArgs

schema str

The definition of the Schema.

schema_references Sequence[SchemaSchemaReferenceArgs]

The list of references to other Schemas.

schema_registry_cluster SchemaSchemaRegistryClusterArgs

skip_validation_during_plan bool

format String

The format of the Schema.

subjectName String

credentials Property Map

The Cluster API Credentials.

hardDelete Boolean

Controls whether a schema should be soft or hard deleted. Set it to true if you want to hard delete a schema on destroy. Defaults to false (soft delete).

metadata Property Map

recreateOnUpdate Boolean

Controls whether a schema should be recreated on update.

restEndpoint String

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

ruleset Property Map

schema String

The definition of the Schema.

schemaReferences List<Property Map>

The list of references to other Schemas.

schemaRegistryCluster Property Map

Credentials Pulumi.ConfluentCloud.Inputs.SchemaCredentials

Outputs

All input properties are implicitly available as output properties. Additionally, the Schema resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
SchemaIdentifier int: (Required Integer) The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
Version int: (Required Integer) The version of the Schema, for example, 4.

Id string: The provider-assigned unique ID for this managed resource.
SchemaIdentifier int: (Required Integer) The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
Version int: (Required Integer) The version of the Schema, for example, 4.

id String: The provider-assigned unique ID for this managed resource.
schemaIdentifier Integer: (Required Integer) The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
version Integer: (Required Integer) The version of the Schema, for example, 4.

id string: The provider-assigned unique ID for this managed resource.
schemaIdentifier number: (Required Integer) The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
version number: (Required Integer) The version of the Schema, for example, 4.

id str: The provider-assigned unique ID for this managed resource.
schema_identifier int: (Required Integer) The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
version int: (Required Integer) The version of the Schema, for example, 4.

id String: The provider-assigned unique ID for this managed resource.
schemaIdentifier Number: (Required Integer) The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
version Number: (Required Integer) The version of the Schema, for example, 4.

Look up Existing Schema Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credentials: Optional[SchemaCredentialsArgs] = None,
        format: Optional[str] = None,
        hard_delete: Optional[bool] = None,
        metadata: Optional[SchemaMetadataArgs] = None,
        recreate_on_update: Optional[bool] = None,
        rest_endpoint: Optional[str] = None,
        ruleset: Optional[SchemaRulesetArgs] = None,
        schema: Optional[str] = None,
        schema_identifier: Optional[int] = None,
        schema_references: Optional[Sequence[SchemaSchemaReferenceArgs]] = None,
        schema_registry_cluster: Optional[SchemaSchemaRegistryClusterArgs] = None,
        skip_validation_during_plan: Optional[bool] = None,
        subject_name: Optional[str] = None,
        version: Optional[int] = None) -> Schema

func GetSchema(ctx *Context, name string, id IDInput, state *SchemaState, opts ...ResourceOption) (*Schema, error)

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

public static Schema get(String name, Output<String> id, SchemaState state, CustomResourceOptions options)

resources:  _:    type: confluentcloud:Schema    get:      id: ${id}

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:

The Cluster API Credentials.

Format string

The format of the Schema.

HardDelete bool

Controls whether a schema should be soft or hard deleted. Set it to true if you want to hard delete a schema on destroy. Defaults to false (soft delete).

Metadata Pulumi.ConfluentCloud.Inputs.SchemaMetadata

Ruleset Pulumi.ConfluentCloud.Inputs.SchemaRuleset

Controls whether a schema should be recreated on update.

RestEndpoint string

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

SchemaDetails string

The definition of the Schema.

SchemaIdentifier int

(Required Integer) The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.

SchemaReferences List<Pulumi.ConfluentCloud.Inputs.SchemaSchemaReference>

The list of references to other Schemas.

SchemaRegistryCluster Pulumi.ConfluentCloud.Inputs.SchemaSchemaRegistryCluster

Credentials SchemaCredentialsArgs

SubjectName string

Version int

(Required Integer) The version of the Schema, for example, 4.

The Cluster API Credentials.

Format string

The format of the Schema.

HardDelete bool

Controls whether a schema should be soft or hard deleted. Set it to true if you want to hard delete a schema on destroy. Defaults to false (soft delete).

Metadata SchemaMetadataArgs

Ruleset SchemaRulesetArgs

Controls whether a schema should be recreated on update.

RestEndpoint string

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

Schema string

The definition of the Schema.

SchemaIdentifier int

SchemaReferences []SchemaSchemaReferenceArgs

The list of references to other Schemas.

SchemaRegistryCluster SchemaSchemaRegistryClusterArgs

SubjectName string

Version int

(Required Integer) The version of the Schema, for example, 4.

The Cluster API Credentials.

format String

The format of the Schema.

hardDelete Boolean

Controls whether a schema should be soft or hard deleted. Set it to true if you want to hard delete a schema on destroy. Defaults to false (soft delete).

recreateOnUpdate Boolean

Controls whether a schema should be recreated on update.

restEndpoint String

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

schemaReferences List<SchemaSchemaReference>

schema String

The definition of the Schema.

schemaIdentifier Integer

The list of references to other Schemas.

schemaRegistryCluster SchemaSchemaRegistryCluster

subjectName String

version Integer

(Required Integer) The version of the Schema, for example, 4.

The Cluster API Credentials.

format string

The format of the Schema.

hardDelete boolean

Controls whether a schema should be soft or hard deleted. Set it to true if you want to hard delete a schema on destroy. Defaults to false (soft delete).

recreateOnUpdate boolean

Controls whether a schema should be recreated on update.

restEndpoint string

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

schemaReferences SchemaSchemaReference[]

schema string

The definition of the Schema.

schemaIdentifier number

The list of references to other Schemas.

schemaRegistryCluster SchemaSchemaRegistryCluster

skipValidationDuringPlan boolean

subjectName string

version number

(Required Integer) The version of the Schema, for example, 4.

credentials SchemaCredentialsArgs

The Cluster API Credentials.

format str

The format of the Schema.

hard_delete bool

Controls whether a schema should be soft or hard deleted. Set it to true if you want to hard delete a schema on destroy. Defaults to false (soft delete).

metadata SchemaMetadataArgs

recreate_on_update bool

Controls whether a schema should be recreated on update.

rest_endpoint str

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

ruleset SchemaRulesetArgs

schema str

The definition of the Schema.

schema_identifier int

schema_references Sequence[SchemaSchemaReferenceArgs]

The list of references to other Schemas.

schema_registry_cluster SchemaSchemaRegistryClusterArgs

skip_validation_during_plan bool

subject_name str

version int

(Required Integer) The version of the Schema, for example, 4.

credentials Property Map

The Cluster API Credentials.

format String

The format of the Schema.

hardDelete Boolean

Controls whether a schema should be soft or hard deleted. Set it to true if you want to hard delete a schema on destroy. Defaults to false (soft delete).

metadata Property Map

recreateOnUpdate Boolean

Controls whether a schema should be recreated on update.

restEndpoint String

data.confluent_schema_registry_cluster.essentials.private_regional_rest_endpoints["us-east-2"], or
https://${data.confluent_schema_registry_cluster.essentials.id}${data.confluent_network.main.endpoint_suffix}

ruleset Property Map

schema String

The definition of the Schema.

schemaIdentifier Number

schemaReferences List<Property Map>

The list of references to other Schemas.

schemaRegistryCluster Property Map