@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
104 lines (103 loc) • 4.15 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages the access control for a Linode Database. Only one `linode.DatabaseAccessControls` resource should be defined per-database.
* For more information, see the Linode APIv4 docs for [MySQL](https://techdocs.akamai.com/linode-api/reference/put-databases-mysql-instance) and [PostgreSQL](https://techdocs.akamai.com/linode-api/reference/put-databases-postgre-sql-instance).
*
* ## Example Usage
*
* Grant a Linode access to a database:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const my_instance = new linode.Instance("my-instance", {
* label: "myinstance",
* region: "us-southeast",
* type: "g6-nanode-1",
* image: "linode/alpine3.19",
* });
* const my_db = new linode.DatabaseMysql("my-db", {
* label: "mydatabase",
* engineId: "mysql/8.0.30",
* region: "us-southeast",
* type: "g6-nanode-1",
* });
* const my_access = new linode.DatabaseAccessControls("my-access", {
* databaseId: my_db.id,
* databaseType: "mysql",
* allowLists: [my_instance.ipAddress],
* });
* ```
*/
export declare class DatabaseAccessControls extends pulumi.CustomResource {
/**
* Get an existing DatabaseAccessControls 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?: DatabaseAccessControlsState, opts?: pulumi.CustomResourceOptions): DatabaseAccessControls;
/**
* Returns true if the given object is an instance of DatabaseAccessControls. 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 DatabaseAccessControls;
/**
* A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.
*/
readonly allowLists: pulumi.Output<string[]>;
/**
* The unique ID of the target database.
*/
readonly databaseId: pulumi.Output<number>;
/**
* The unique type of the target database. (`mysql`, `postgresql`)
*/
readonly databaseType: pulumi.Output<string>;
/**
* Create a DatabaseAccessControls 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: DatabaseAccessControlsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DatabaseAccessControls resources.
*/
export interface DatabaseAccessControlsState {
/**
* A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.
*/
allowLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The unique ID of the target database.
*/
databaseId?: pulumi.Input<number>;
/**
* The unique type of the target database. (`mysql`, `postgresql`)
*/
databaseType?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DatabaseAccessControls resource.
*/
export interface DatabaseAccessControlsArgs {
/**
* A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.
*/
allowLists: pulumi.Input<pulumi.Input<string>[]>;
/**
* The unique ID of the target database.
*/
databaseId: pulumi.Input<number>;
/**
* The unique type of the target database. (`mysql`, `postgresql`)
*/
databaseType: pulumi.Input<string>;
}