@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
198 lines (197 loc) • 8.11 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage rds postgresql allowlist
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.rds_postgresql.Allowlist("foo", {
* allowLists: ["10.0.0.0/24"],
* allowListDesc: "acc-test",
* allowListName: "acc-test-allowlist",
* allowListType: "IPv4",
* securityGroupBindInfos: [{
* bindMode: "IngressDirectionIp",
* securityGroupId: "sg-1jojfhw8rca9s1n7ampztrq6w",
* }],
* });
* const example = new volcengine.rds_postgresql.Allowlist("example", {
* allowListName: "unify_new",
* instanceIds: [
* "postgres-72715e0d9f58",
* "postgres-eb3a578a6d73",
* ],
* });
* ```
*
* ## Import
*
* RdsPostgresqlAllowlist can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:rds_postgresql/allowlist:Allowlist default resource_id
* ```
*/
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;
/**
* The category of the allow list. Valid values: Ordinary, Default. When this parameter is used as a request parameter, there is no default value.
*/
readonly allowListCategory: pulumi.Output<string>;
/**
* The description of the postgresql allow list.
*/
readonly allowListDesc: pulumi.Output<string | undefined>;
/**
* The name of the postgresql allow list.
*/
readonly allowListName: pulumi.Output<string>;
/**
* The type of IP address in the whitelist. Currently only `IPv4` addresses are supported.
*/
readonly allowListType: pulumi.Output<string>;
/**
* Enter an IP address or a range of IP addresses in CIDR format. This field cannot be used together with the userAllowList field.
*/
readonly allowLists: pulumi.Output<string[]>;
/**
* The total number of instances bound under the whitelist.
*/
readonly associatedInstanceNum: pulumi.Output<number>;
/**
* The list of postgresql instances.
*/
readonly associatedInstances: pulumi.Output<outputs.rds_postgresql.AllowlistAssociatedInstance[]>;
/**
* IDs of PostgreSQL instances to unify allowlists. When set, creation uses UnifyNewAllowList to merge existing instance allowlists into a new one. Supports merging and generating allowlists of up to 300 instances.
*/
readonly instanceIds: pulumi.Output<string[]>;
/**
* The information of security groups to bind with the allow list.
*/
readonly securityGroupBindInfos: pulumi.Output<outputs.rds_postgresql.AllowlistSecurityGroupBindInfo[] | undefined>;
/**
* Whether to update the security groups bound to the allowlist when modifying.
*/
readonly updateSecurityGroup: pulumi.Output<boolean | undefined>;
/**
* IP addresses outside security groups to be added to the allowlist. Cannot be used with allow_list.
*/
readonly userAllowLists: pulumi.Output<string[]>;
/**
* 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 {
/**
* The category of the allow list. Valid values: Ordinary, Default. When this parameter is used as a request parameter, there is no default value.
*/
allowListCategory?: pulumi.Input<string>;
/**
* The description of the postgresql allow list.
*/
allowListDesc?: pulumi.Input<string>;
/**
* The name of the postgresql allow list.
*/
allowListName?: pulumi.Input<string>;
/**
* The type of IP address in the whitelist. Currently only `IPv4` addresses are supported.
*/
allowListType?: pulumi.Input<string>;
/**
* Enter an IP address or a range of IP addresses in CIDR format. This field cannot be used together with the userAllowList field.
*/
allowLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The total number of instances bound under the whitelist.
*/
associatedInstanceNum?: pulumi.Input<number>;
/**
* The list of postgresql instances.
*/
associatedInstances?: pulumi.Input<pulumi.Input<inputs.rds_postgresql.AllowlistAssociatedInstance>[]>;
/**
* IDs of PostgreSQL instances to unify allowlists. When set, creation uses UnifyNewAllowList to merge existing instance allowlists into a new one. Supports merging and generating allowlists of up to 300 instances.
*/
instanceIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The information of security groups to bind with the allow list.
*/
securityGroupBindInfos?: pulumi.Input<pulumi.Input<inputs.rds_postgresql.AllowlistSecurityGroupBindInfo>[]>;
/**
* Whether to update the security groups bound to the allowlist when modifying.
*/
updateSecurityGroup?: pulumi.Input<boolean>;
/**
* IP addresses outside security groups to be added to the allowlist. Cannot be used with allow_list.
*/
userAllowLists?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a Allowlist resource.
*/
export interface AllowlistArgs {
/**
* The category of the allow list. Valid values: Ordinary, Default. When this parameter is used as a request parameter, there is no default value.
*/
allowListCategory?: pulumi.Input<string>;
/**
* The description of the postgresql allow list.
*/
allowListDesc?: pulumi.Input<string>;
/**
* The name of the postgresql allow list.
*/
allowListName: pulumi.Input<string>;
/**
* The type of IP address in the whitelist. Currently only `IPv4` addresses are supported.
*/
allowListType?: pulumi.Input<string>;
/**
* Enter an IP address or a range of IP addresses in CIDR format. This field cannot be used together with the userAllowList field.
*/
allowLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* IDs of PostgreSQL instances to unify allowlists. When set, creation uses UnifyNewAllowList to merge existing instance allowlists into a new one. Supports merging and generating allowlists of up to 300 instances.
*/
instanceIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The information of security groups to bind with the allow list.
*/
securityGroupBindInfos?: pulumi.Input<pulumi.Input<inputs.rds_postgresql.AllowlistSecurityGroupBindInfo>[]>;
/**
* Whether to update the security groups bound to the allowlist when modifying.
*/
updateSecurityGroup?: pulumi.Input<boolean>;
/**
* IP addresses outside security groups to be added to the allowlist. Cannot be used with allow_list.
*/
userAllowLists?: pulumi.Input<pulumi.Input<string>[]>;
}