@lbrlabs/pulumi-cockroach
Version:
A Pulumi package to create and managed cockroach db resources in Pulumi programs.
103 lines (102 loc) • 3.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* List of IP ranges allowed to access the cluster.
*/
export declare class AllowList extends pulumi.CustomResource {
/**
* Get an existing AllowList 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?: AllowListState, opts?: pulumi.CustomResourceOptions): AllowList;
/**
* Returns true if the given object is an instance of AllowList. 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 AllowList;
/**
* IP address component of the [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) range for this entry.
*/
readonly cidrIp: pulumi.Output<string>;
/**
* Map component of the [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) range for this entry.
*/
readonly cidrMask: pulumi.Output<number>;
readonly clusterId: pulumi.Output<string>;
/**
* Name of this allowlist entry.
*/
readonly name: pulumi.Output<string | undefined>;
/**
* Set to 'true' to allow SQL connections from this CIDR range.
*/
readonly sql: pulumi.Output<boolean>;
/**
* Set to 'true' to allow access to the management console from this CIDR range.
*/
readonly ui: pulumi.Output<boolean>;
/**
* Create a AllowList 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: AllowListArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AllowList resources.
*/
export interface AllowListState {
/**
* IP address component of the [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) range for this entry.
*/
cidrIp?: pulumi.Input<string>;
/**
* Map component of the [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) range for this entry.
*/
cidrMask?: pulumi.Input<number>;
clusterId?: pulumi.Input<string>;
/**
* Name of this allowlist entry.
*/
name?: pulumi.Input<string>;
/**
* Set to 'true' to allow SQL connections from this CIDR range.
*/
sql?: pulumi.Input<boolean>;
/**
* Set to 'true' to allow access to the management console from this CIDR range.
*/
ui?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a AllowList resource.
*/
export interface AllowListArgs {
/**
* IP address component of the [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) range for this entry.
*/
cidrIp: pulumi.Input<string>;
/**
* Map component of the [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) range for this entry.
*/
cidrMask: pulumi.Input<number>;
clusterId: pulumi.Input<string>;
/**
* Name of this allowlist entry.
*/
name?: pulumi.Input<string>;
/**
* Set to 'true' to allow SQL connections from this CIDR range.
*/
sql: pulumi.Input<boolean>;
/**
* Set to 'true' to allow access to the management console from this CIDR range.
*/
ui: pulumi.Input<boolean>;
}