AivenKafkaJsonArgs

interface AivenKafkaJsonArgs extends module:@jobcloud/aiven-kafka.AivenKafkaBaseArgs {
aclsFilePath?: string;
definition?: undefined;
identity: string;
service: AivenKafkaServiceReferenceArgs;
topicsFilePath?: string;
usersFilePath?: string;
}

JSON-file configuration mode for AivenKafka.

Remarks

At least one file path is required. Paths resolve from process.cwd() and each file must contain a JSON object map keyed by stable logical identity. JSON ACLs retain string and key-selector compatibility.

Example

CODE

const args: AivenKafkaJsonArgs = {
  identity: 'orders',
  service: { project: 'platform', serviceName: 'kafka-main' },
  topicsFilePath: 'config/kafka-topics.json',
};

Hierarchy

AivenKafkaBaseArgs
AivenKafkaJsonArgs

Properties

`aclsFilePath: string`

Optional path, resolved from process.cwd(), to a JSON object map of ACL entries keyed by stable ACL key.

`definition: undefined`

Typed definitions are not allowed in JSON-file mode.

`identity: string`

Inherited from identity

Required plain-string identity used for deterministic logical-name generation.

This value must be known synchronously at plan time.

`service: AivenKafkaServiceReferenceArgs`

Inherited from service

Kafka service reference.

`topicsFilePath: string`

Optional path, resolved from process.cwd(), to a JSON object map of topic entries keyed by stable topic key.

`usersFilePath: string`

Optional path, resolved from process.cwd(), to a JSON object map of user entries keyed by stable user key.