@huaweicloudos/pulumi/dms/kafkaPermissions.d.ts

A Pulumi package for creating and managing Huaweicloud cloud resources.

import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "../types";
/**
 * Use the resource to grant user permissions of a kafka topic within HuaweiCloud.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as pulumi from "@huaweicloudos/pulumi";
 *
 * const config = new pulumi.Config();
 * const kafkaInstanceId = config.requireObject("kafkaInstanceId");
 * const kafkaTopicName = config.requireObject("kafkaTopicName");
 * const user1 = config.requireObject("user1");
 * const user2 = config.requireObject("user2");
 * const test = new huaweicloud.dms.KafkaPermissions("test", {
 *     instanceId: kafkaInstanceId,
 *     topicName: kafkaTopicName,
 *     policies: [
 *         {
 *             userName: user1,
 *             accessPolicy: "all",
 *         },
 *         {
 *             userName: user2,
 *             accessPolicy: "pub",
 *         },
 *     ],
 * });
 * ```
 *
 * ## Import
 *
 * DMS kafka permissions can be imported using the kafka instance ID and topic name separated by a slash, e.g.bash
 *
 * ```sh
 *  $ pulumi import huaweicloud:Dms/kafkaPermissions:KafkaPermissions permissions c8057fe5-23a8-46ef-ad83-c0055b4e0c5c/topic_1
 * ```
 */
export declare class KafkaPermissions extends pulumi.CustomResource {
    /**
     * Get an existing KafkaPermissions resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: KafkaPermissionsState, opts?: pulumi.CustomResourceOptions): KafkaPermissions;
    /**
     * Returns true if the given object is an instance of KafkaPermissions.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is KafkaPermissions;
    /**
     * Specifies the ID of the DMS kafka instance to which the permissions belongs.
     * Changing this creates a new resource.
     */
    readonly instanceId: pulumi.Output<string>;
    /**
     * Specifies the permissions policies. The object structure is
     * documented below.
     */
    readonly policies: pulumi.Output<outputs.Dms.KafkaPermissionsPolicy[]>;
    /**
     * The region in which to create the DMS kafka permissions resource. If omitted, the
     * provider-level region will be used. Changing this creates a new resource.
     */
    readonly region: pulumi.Output<string>;
    /**
     * Specifies the name of the topic to which the permissions belongs.
     * Changing this creates a new resource.
     */
    readonly topicName: pulumi.Output<string>;
    /**
     * Create a KafkaPermissions resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: KafkaPermissionsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering KafkaPermissions resources.
 */
export interface KafkaPermissionsState {
    /**
     * Specifies the ID of the DMS kafka instance to which the permissions belongs.
     * Changing this creates a new resource.
     */
    instanceId?: pulumi.Input<string>;
    /**
     * Specifies the permissions policies. The object structure is
     * documented below.
     */
    policies?: pulumi.Input<pulumi.Input<inputs.Dms.KafkaPermissionsPolicy>[]>;
    /**
     * The region in which to create the DMS kafka permissions resource. If omitted, the
     * provider-level region will be used. Changing this creates a new resource.
     */
    region?: pulumi.Input<string>;
    /**
     * Specifies the name of the topic to which the permissions belongs.
     * Changing this creates a new resource.
     */
    topicName?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a KafkaPermissions resource.
 */
export interface KafkaPermissionsArgs {
    /**
     * Specifies the ID of the DMS kafka instance to which the permissions belongs.
     * Changing this creates a new resource.
     */
    instanceId: pulumi.Input<string>;
    /**
     * Specifies the permissions policies. The object structure is
     * documented below.
     */
    policies: pulumi.Input<pulumi.Input<inputs.Dms.KafkaPermissionsPolicy>[]>;
    /**
     * The region in which to create the DMS kafka permissions resource. If omitted, the
     * provider-level region will be used. Changing this creates a new resource.
     */
    region?: pulumi.Input<string>;
    /**
     * Specifies the name of the topic to which the permissions belongs.
     * Changing this creates a new resource.
     */
    topicName: pulumi.Input<string>;
}