import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * The allowlist is a security measure for database connections. Only IP addresses in the allowlist can access the database. * * ## Import * * ```sh * $ pulumi import volcenginecc:rdsmysql/allowList:AllowList example "allow_list_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, 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; /** * Allowlist category. Values: Ordinary: Ordinary allowlist. Default: Default allowlist. Note: When used as a request parameter, the default value is Ordinary. */ readonly allowListCategory: pulumi.Output; /** * Allowlist remarks. */ readonly allowListDesc: pulumi.Output; /** * Allowlist ID. */ readonly allowListId: pulumi.Output; /** * Total number of IP addresses (or ranges) in the allowlist. */ readonly allowListIpNum: pulumi.Output; /** * Allowlist name. */ readonly allowListName: pulumi.Output; /** * IP address types in the allowlist. Only IPv4 addresses are currently supported. */ readonly allowListType: pulumi.Output; /** * IP address list in the allowlist */ readonly allowLists: pulumi.Output; /** * Total number of instances bound to the allowlist. */ readonly associatedInstanceNum: pulumi.Output; readonly associatedInstances: pulumi.Output; /** * Ignore instance status check. Values: true: Yes. false: No. Default value. */ readonly ignoreInstanceStatus: pulumi.Output; /** * Instance ID. */ readonly instanceId: pulumi.Output; /** * List of IP addresses and IP ranges included in the allowlist. Returned when the WithIpList request parameter is set to true; returns null when set to false or not specified. */ readonly ipLists: pulumi.Output; /** * Modification method. Available values: Cover (default): Overwrite the original allowlist with the values from the AllowList parameter. Append: Add the IP addresses entered in the AllowList parameter to the original allowlist. Delete: Remove the IP addresses entered in the AllowList parameter from the original allowlist. At least one IP address must remain. */ readonly modifyMode: pulumi.Output; /** * Project. Note: If the AK/SK used to call the API belongs to a sub-account that only has permission for a specific project, you need to provide this request parameter. */ readonly projectName: pulumi.Output; readonly securityGroupBindInfos: pulumi.Output; /** * List of security group IDs to associate. Note: You can call the DescribeSecurityGroups API to query security group information, including security group IDs. A single allowlist can add up to 10 security groups at a time. This field cannot be used together with SecurityGroupBindInfos. */ readonly securityGroupIds: pulumi.Output; /** * Whether to update the security group bound to the allowlist. true: update. false: do not update. Default value. This field is effective only when the allowlist is already bound to a security group. You can call the DescribeAllowLists API to check if the allowlist is bound to a security group. */ readonly updateSecurityGroup: pulumi.Output; /** * IP addresses entered by the user in this list. The IPs in the AllowList field are the union of IPs included in UserAllowList and SecurityGroupBindInfos. */ readonly userAllowLists: pulumi.Output; /** * 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 { /** * Allowlist category. Values: Ordinary: Ordinary allowlist. Default: Default allowlist. Note: When used as a request parameter, the default value is Ordinary. */ allowListCategory?: pulumi.Input; /** * Allowlist remarks. */ allowListDesc?: pulumi.Input; /** * Allowlist ID. */ allowListId?: pulumi.Input; /** * Total number of IP addresses (or ranges) in the allowlist. */ allowListIpNum?: pulumi.Input; /** * Allowlist name. */ allowListName?: pulumi.Input; /** * IP address types in the allowlist. Only IPv4 addresses are currently supported. */ allowListType?: pulumi.Input; /** * IP address list in the allowlist */ allowLists?: pulumi.Input[]>; /** * Total number of instances bound to the allowlist. */ associatedInstanceNum?: pulumi.Input; associatedInstances?: pulumi.Input[]>; /** * Ignore instance status check. Values: true: Yes. false: No. Default value. */ ignoreInstanceStatus?: pulumi.Input; /** * Instance ID. */ instanceId?: pulumi.Input; /** * List of IP addresses and IP ranges included in the allowlist. Returned when the WithIpList request parameter is set to true; returns null when set to false or not specified. */ ipLists?: pulumi.Input[]>; /** * Modification method. Available values: Cover (default): Overwrite the original allowlist with the values from the AllowList parameter. Append: Add the IP addresses entered in the AllowList parameter to the original allowlist. Delete: Remove the IP addresses entered in the AllowList parameter from the original allowlist. At least one IP address must remain. */ modifyMode?: pulumi.Input; /** * Project. Note: If the AK/SK used to call the API belongs to a sub-account that only has permission for a specific project, you need to provide this request parameter. */ projectName?: pulumi.Input; securityGroupBindInfos?: pulumi.Input[]>; /** * List of security group IDs to associate. Note: You can call the DescribeSecurityGroups API to query security group information, including security group IDs. A single allowlist can add up to 10 security groups at a time. This field cannot be used together with SecurityGroupBindInfos. */ securityGroupIds?: pulumi.Input[]>; /** * Whether to update the security group bound to the allowlist. true: update. false: do not update. Default value. This field is effective only when the allowlist is already bound to a security group. You can call the DescribeAllowLists API to check if the allowlist is bound to a security group. */ updateSecurityGroup?: pulumi.Input; /** * IP addresses entered by the user in this list. The IPs in the AllowList field are the union of IPs included in UserAllowList and SecurityGroupBindInfos. */ userAllowLists?: pulumi.Input[]>; } /** * The set of arguments for constructing a AllowList resource. */ export interface AllowListArgs { /** * Allowlist category. Values: Ordinary: Ordinary allowlist. Default: Default allowlist. Note: When used as a request parameter, the default value is Ordinary. */ allowListCategory?: pulumi.Input; /** * Allowlist remarks. */ allowListDesc?: pulumi.Input; /** * Allowlist name. */ allowListName?: pulumi.Input; /** * IP address types in the allowlist. Only IPv4 addresses are currently supported. */ allowListType?: pulumi.Input; /** * IP address list in the allowlist */ allowLists?: pulumi.Input[]>; /** * Total number of instances bound to the allowlist. */ associatedInstanceNum?: pulumi.Input; associatedInstances?: pulumi.Input[]>; /** * Ignore instance status check. Values: true: Yes. false: No. Default value. */ ignoreInstanceStatus?: pulumi.Input; /** * Instance ID. */ instanceId?: pulumi.Input; /** * Modification method. Available values: Cover (default): Overwrite the original allowlist with the values from the AllowList parameter. Append: Add the IP addresses entered in the AllowList parameter to the original allowlist. Delete: Remove the IP addresses entered in the AllowList parameter from the original allowlist. At least one IP address must remain. */ modifyMode?: pulumi.Input; /** * Project. Note: If the AK/SK used to call the API belongs to a sub-account that only has permission for a specific project, you need to provide this request parameter. */ projectName?: pulumi.Input; securityGroupBindInfos?: pulumi.Input[]>; /** * List of security group IDs to associate. Note: You can call the DescribeSecurityGroups API to query security group information, including security group IDs. A single allowlist can add up to 10 security groups at a time. This field cannot be used together with SecurityGroupBindInfos. */ securityGroupIds?: pulumi.Input[]>; /** * Whether to update the security group bound to the allowlist. true: update. false: do not update. Default value. This field is effective only when the allowlist is already bound to a security group. You can call the DescribeAllowLists API to check if the allowlist is bound to a security group. */ updateSecurityGroup?: pulumi.Input; /** * IP addresses entered by the user in this list. The IPs in the AllowList field are the union of IPs included in UserAllowList and SecurityGroupBindInfos. */ userAllowLists?: pulumi.Input[]>; }