AivenKafkaDefinitionArgs

interface AivenKafkaDefinitionArgs extends module:@jobcloud/pulumi-components..AivenKafkaBaseArgs {
aclsFilePath?: undefined;
definition: AivenKafkaDefinition;
identity: string;
service: AivenKafkaServiceReferenceArgs;
topicsFilePath?: undefined;
usersFilePath?: undefined;
}

Typed-definition configuration mode for AivenKafka.

Remarks

Build definition with defineAivenKafkaTopics(), defineAivenKafkaUsers(), and defineAivenKafkaDefinition(). Handles are plan-time relationships, not Pulumi resources.

Example

CODE

const topics = defineAivenKafkaTopics({
  orders: { create: { topicName: 'company.orders.v1', partitions: 3, replication: 3 } },
});
const args: AivenKafkaDefinitionArgs = {
  identity: 'orders',
  service: { project: 'platform', serviceName: 'kafka-main' },
  definition: defineAivenKafkaDefinition({ topics, users: defineAivenKafkaUsers({}), acls: {} }),
};

Hierarchy

AivenKafkaBaseArgs
AivenKafkaDefinitionArgs

Properties

`aclsFilePath: undefined`

JSON ACL files are not allowed in typed-definition mode.

`definition: AivenKafkaDefinition`

Immutable typed definition built by defineAivenKafkaDefinition().

`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: undefined`

JSON topic files are not allowed in typed-definition mode.

`usersFilePath: undefined`

JSON user files are not allowed in typed-definition mode.