@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
175 lines • 6.63 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Creates and manages Scaleway Database instance authorized IPs.
* For more information refer to the [API documentation](https://www.scaleway.com/en/developers/api/managed-database-postgre-mysql/#acl-rules-allowed-ips).
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.databases.Instance("main", {
* name: "test-rdb",
* nodeType: "DB-DEV-S",
* engine: "PostgreSQL-15",
* isHaCluster: true,
* disableBackup: true,
* userName: "my_initial_user",
* password: "thiZ_is_v&ry_s3cret",
* });
* const mainAcl = new scaleway.databases.Acl("main", {
* instanceId: main.id,
* aclRules: [{
* ip: "1.2.3.4/32",
* description: "foo",
* }],
* });
* ```
*
* ### Multiple ACL Rules
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.databases.Acl("main", {
* instanceId: mainScalewayRdbInstance.id,
* aclRules: [
* {
* ip: "1.2.3.4/32",
* description: "Office IP",
* },
* {
* ip: "5.6.7.8/32",
* description: "Home IP",
* },
* {
* ip: "10.0.0.0/24",
* description: "Internal network",
* },
* ],
* });
* ```
*
* ### Dynamic ACL Rules with Variables
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const config = new pulumi.Config();
* // Map of allowed IPs with descriptions
* const allowedIps = config.getObject<Record<string, string>>("allowedIps") || {
* "1.2.3.4/32": "Office IP",
* "10.0.0.0/24": "Internal network",
* "5.6.7.8/32": "Home IP",
* };
* const main = new scaleway.databases.Acl("main", {
* aclRules: Object.entries(allowedIps).sort().map(([key, entry]) => ({
* ip: key,
* description: entry,
* })),
* instanceId: mainScalewayRdbInstance.id,
* });
* ```
*
* ## Import
*
* Database Instance can be imported using the `{region}/{id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:index/databaseAcl:DatabaseAcl acl01 fr-par/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/databaseacl.DatabaseAcl has been deprecated in favor of scaleway.databases/acl.Acl
*/
export declare class DatabaseAcl extends pulumi.CustomResource {
/**
* Get an existing DatabaseAcl 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?: DatabaseAclState, opts?: pulumi.CustomResourceOptions): DatabaseAcl;
/**
* Returns true if the given object is an instance of DatabaseAcl. 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 DatabaseAcl;
/**
* A list of ACLs (structure is described below)
*
* > **Important:** The `scaleway.databases.Acl` resource replaces **all** ACL rules for the given instance. Multiple `scaleway.databases.Acl` resources targeting the same `instanceId` will conflict with each other. Use multiple `aclRules` blocks within a single resource instead.
*/
readonly aclRules: pulumi.Output<outputs.DatabaseAclAclRule[]>;
/**
* UUID of the Database Instance.
*
* > **Important:** Updates to `instanceId` will recreate the Database ACL.
*/
readonly instanceId: pulumi.Output<string>;
/**
* `region`) The region in which the Database Instance should be created.
*/
readonly region: pulumi.Output<string | undefined>;
/**
* Create a DatabaseAcl 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.
*/
/** @deprecated scaleway.index/databaseacl.DatabaseAcl has been deprecated in favor of scaleway.databases/acl.Acl */
constructor(name: string, args: DatabaseAclArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DatabaseAcl resources.
*/
export interface DatabaseAclState {
/**
* A list of ACLs (structure is described below)
*
* > **Important:** The `scaleway.databases.Acl` resource replaces **all** ACL rules for the given instance. Multiple `scaleway.databases.Acl` resources targeting the same `instanceId` will conflict with each other. Use multiple `aclRules` blocks within a single resource instead.
*/
aclRules?: pulumi.Input<pulumi.Input<inputs.DatabaseAclAclRule>[] | undefined>;
/**
* UUID of the Database Instance.
*
* > **Important:** Updates to `instanceId` will recreate the Database ACL.
*/
instanceId?: pulumi.Input<string | undefined>;
/**
* `region`) The region in which the Database Instance should be created.
*/
region?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a DatabaseAcl resource.
*/
export interface DatabaseAclArgs {
/**
* A list of ACLs (structure is described below)
*
* > **Important:** The `scaleway.databases.Acl` resource replaces **all** ACL rules for the given instance. Multiple `scaleway.databases.Acl` resources targeting the same `instanceId` will conflict with each other. Use multiple `aclRules` blocks within a single resource instead.
*/
aclRules: pulumi.Input<pulumi.Input<inputs.DatabaseAclAclRule>[]>;
/**
* UUID of the Database Instance.
*
* > **Important:** Updates to `instanceId` will recreate the Database ACL.
*/
instanceId: pulumi.Input<string>;
/**
* `region`) The region in which the Database Instance should be created.
*/
region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=databaseAcl.d.ts.map