@pulumi/kong
Version:
A Pulumi package for creating and managing Kong resources.
105 lines (104 loc) • 3.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## # kong.ConsumerAcl
*
* Consumer ACL is a resource that allows you to configure the acl plugin for a consumer.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as kong from "@pulumi/kong";
*
* const myConsumer = new kong.Consumer("my_consumer", {
* username: "User1",
* customId: "123",
* });
* const aclPlugin = new kong.Plugin("acl_plugin", {
* name: "acl",
* configJson: `\x09{
* \x09\x09"allow": ["group1", "group2"]
* \x09}
* `,
* });
* const consumerAcl = new kong.ConsumerAcl("consumer_acl", {
* consumerId: myConsumer.id,
* group: "group2",
* tags: [
* "myTag",
* "otherTag",
* ],
* });
* ```
*/
export declare class ConsumerAcl extends pulumi.CustomResource {
/**
* Get an existing ConsumerAcl 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?: ConsumerAclState, opts?: pulumi.CustomResourceOptions): ConsumerAcl;
/**
* Returns true if the given object is an instance of ConsumerAcl. 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 ConsumerAcl;
/**
* the id of the consumer to be configured
*/
readonly consumerId: pulumi.Output<string>;
/**
* the acl group
*/
readonly group: pulumi.Output<string>;
/**
* A list of strings associated with the consumer acl for grouping and filtering
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Create a ConsumerAcl 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: ConsumerAclArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ConsumerAcl resources.
*/
export interface ConsumerAclState {
/**
* the id of the consumer to be configured
*/
consumerId?: pulumi.Input<string>;
/**
* the acl group
*/
group?: pulumi.Input<string>;
/**
* A list of strings associated with the consumer acl for grouping and filtering
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a ConsumerAcl resource.
*/
export interface ConsumerAclArgs {
/**
* the id of the consumer to be configured
*/
consumerId: pulumi.Input<string>;
/**
* the acl group
*/
group: pulumi.Input<string>;
/**
* A list of strings associated with the consumer acl for grouping and filtering
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}