bytepluscc.rdsmssql.AllowList

bytepluscc v0.0.20, Mar 26 26

Viewing docs for bytepluscc v0.0.20
published on Thursday, Mar 26, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.20
published on Thursday, Mar 26, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  rDSMsSQLAllowlistDemo:
    type: bytepluscc:rdsmssql:AllowList
    name: RDSMsSQLAllowlistDemo
    properties:
      projectName: default
      allowListName: ccapi-test-all
      allowListDesc: ccapi-test
      allowListType: IPv4
      allowListCategory: Ordinary
      allowList: 192.168.0.0/24,192.168.0.1,192.168.0.2
      userAllowList: 192.168.0.0/24,192.168.0.1,192.168.0.2
      associatedInstances:
        - instance_id: mssql-9b195******

Create AllowList Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AllowList(name: string, args: AllowListArgs, opts?: CustomResourceOptions);

@overload
def AllowList(resource_name: str,
              args: AllowListArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def AllowList(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              allow_list_name: Optional[str] = None,
              allow_list: Optional[str] = None,
              allow_list_category: Optional[str] = None,
              allow_list_desc: Optional[str] = None,
              allow_list_type: Optional[str] = None,
              associated_instance_num: Optional[int] = None,
              associated_instances: Optional[Sequence[AllowListAssociatedInstanceArgs]] = None,
              instance_id: Optional[str] = None,
              project_name: Optional[str] = None,
              user_allow_list: Optional[str] = None)

func NewAllowList(ctx *Context, name string, args AllowListArgs, opts ...ResourceOption) (*AllowList, error)

public AllowList(string name, AllowListArgs args, CustomResourceOptions? opts = null)

public AllowList(String name, AllowListArgs args)
public AllowList(String name, AllowListArgs args, CustomResourceOptions options)

type: bytepluscc:rdsmssql:AllowList
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args AllowListArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AllowListArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AllowListArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AllowListArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AllowListArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleallowListResourceResourceFromRdsmssqlallowList = new Bytepluscc.Rdsmssql.AllowList("exampleallowListResourceResourceFromRdsmssqlallowList", new()
{
    AllowListName = "string",
    AllowListValue = "string",
    AllowListCategory = "string",
    AllowListDesc = "string",
    AllowListType = "string",
    AssociatedInstanceNum = 0,
    AssociatedInstances = new[]
    {
        new Bytepluscc.Rdsmssql.Inputs.AllowListAssociatedInstanceArgs
        {
            InstanceId = "string",
        },
    },
    InstanceId = "string",
    ProjectName = "string",
    UserAllowList = "string",
});

example, err := rdsmssql.NewAllowList(ctx, "exampleallowListResourceResourceFromRdsmssqlallowList", &rdsmssql.AllowListArgs{
	AllowListName:         pulumi.String("string"),
	AllowList:             pulumi.String("string"),
	AllowListCategory:     pulumi.String("string"),
	AllowListDesc:         pulumi.String("string"),
	AllowListType:         pulumi.String("string"),
	AssociatedInstanceNum: pulumi.Int(0),
	AssociatedInstances: rdsmssql.AllowListAssociatedInstanceArray{
		&rdsmssql.AllowListAssociatedInstanceArgs{
			InstanceId: pulumi.String("string"),
		},
	},
	InstanceId:    pulumi.String("string"),
	ProjectName:   pulumi.String("string"),
	UserAllowList: pulumi.String("string"),
})

var exampleallowListResourceResourceFromRdsmssqlallowList = new com.byteplus.bytepluscc.rdsmssql.AllowList("exampleallowListResourceResourceFromRdsmssqlallowList", com.byteplus.bytepluscc.rdsmssql.AllowListArgs.builder()
    .allowListName("string")
    .allowList("string")
    .allowListCategory("string")
    .allowListDesc("string")
    .allowListType("string")
    .associatedInstanceNum(0)
    .associatedInstances(AllowListAssociatedInstanceArgs.builder()
        .instanceId("string")
        .build())
    .instanceId("string")
    .projectName("string")
    .userAllowList("string")
    .build());

exampleallow_list_resource_resource_from_rdsmssqlallow_list = bytepluscc.rdsmssql.AllowList("exampleallowListResourceResourceFromRdsmssqlallowList",
    allow_list_name="string",
    allow_list="string",
    allow_list_category="string",
    allow_list_desc="string",
    allow_list_type="string",
    associated_instance_num=0,
    associated_instances=[{
        "instance_id": "string",
    }],
    instance_id="string",
    project_name="string",
    user_allow_list="string")

const exampleallowListResourceResourceFromRdsmssqlallowList = new bytepluscc.rdsmssql.AllowList("exampleallowListResourceResourceFromRdsmssqlallowList", {
    allowListName: "string",
    allowList: "string",
    allowListCategory: "string",
    allowListDesc: "string",
    allowListType: "string",
    associatedInstanceNum: 0,
    associatedInstances: [{
        instanceId: "string",
    }],
    instanceId: "string",
    projectName: "string",
    userAllowList: "string",
});

type: bytepluscc:rdsmssql:AllowList
properties:
    allowList: string
    allowListCategory: string
    allowListDesc: string
    allowListName: string
    allowListType: string
    associatedInstanceNum: 0
    associatedInstances:
        - instanceId: string
    instanceId: string
    projectName: string
    userAllowList: string

AllowList Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AllowList resource accepts the following input properties:

AllowListName string: 白名单名称。
AllowListCategory string: 白名单分类。
AllowListDesc string: 白名单描述。
AllowListType string: 白名单内的IP地址类型，当前仅支持IPv4。
AllowListValue string: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
AssociatedInstanceNum int: 绑定的实例数量。解绑实例的白名单时必传。
AssociatedInstances List<Byteplus.AllowListAssociatedInstance>
InstanceId string: 实例ID。
ProjectName string: 项目名称。
UserAllowList string: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

AllowListName string: 白名单名称。
AllowList string: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
AllowListCategory string: 白名单分类。
AllowListDesc string: 白名单描述。
AllowListType string: 白名单内的IP地址类型，当前仅支持IPv4。
AssociatedInstanceNum int: 绑定的实例数量。解绑实例的白名单时必传。
AssociatedInstances []AllowListAssociatedInstanceArgs
InstanceId string: 实例ID。
ProjectName string: 项目名称。
UserAllowList string: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

allowListName String: 白名单名称。
allowList String: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
allowListCategory String: 白名单分类。
allowListDesc String: 白名单描述。
allowListType String: 白名单内的IP地址类型，当前仅支持IPv4。
associatedInstanceNum Integer: 绑定的实例数量。解绑实例的白名单时必传。
associatedInstances List<AllowListAssociatedInstance>
instanceId String: 实例ID。
projectName String: 项目名称。
userAllowList String: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

allowListName string: 白名单名称。
allowList string: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
allowListCategory string: 白名单分类。
allowListDesc string: 白名单描述。
allowListType string: 白名单内的IP地址类型，当前仅支持IPv4。
associatedInstanceNum number: 绑定的实例数量。解绑实例的白名单时必传。
associatedInstances AllowListAssociatedInstance[]
instanceId string: 实例ID。
projectName string: 项目名称。
userAllowList string: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

allow_list_name str: 白名单名称。
allow_list str: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
allow_list_category str: 白名单分类。
allow_list_desc str: 白名单描述。
allow_list_type str: 白名单内的IP地址类型，当前仅支持IPv4。
associated_instance_num int: 绑定的实例数量。解绑实例的白名单时必传。
associated_instances Sequence[AllowListAssociatedInstanceArgs]
instance_id str: 实例ID。
project_name str: 项目名称。
user_allow_list str: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

allowListName String: 白名单名称。
allowList String: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
allowListCategory String: 白名单分类。
allowListDesc String: 白名单描述。
allowListType String: 白名单内的IP地址类型，当前仅支持IPv4。
associatedInstanceNum Number: 绑定的实例数量。解绑实例的白名单时必传。
associatedInstances List<Property Map>
instanceId String: 实例ID。
projectName String: 项目名称。
userAllowList String: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

Outputs

All input properties are implicitly available as output properties. Additionally, the AllowList resource produces the following output properties:

AllowListId string: 白名单的id。
AllowListIpNum int: AllowListIP数量。
Id string: The provider-assigned unique ID for this managed resource.

AllowListId string: 白名单的id。
AllowListIpNum int: AllowListIP数量。
Id string: The provider-assigned unique ID for this managed resource.

allowListId String: 白名单的id。
allowListIpNum Integer: AllowListIP数量。
id String: The provider-assigned unique ID for this managed resource.

allowListId string: 白名单的id。
allowListIpNum number: AllowListIP数量。
id string: The provider-assigned unique ID for this managed resource.

allow_list_id str: 白名单的id。
allow_list_ip_num int: AllowListIP数量。
id str: The provider-assigned unique ID for this managed resource.

allowListId String: 白名单的id。
allowListIpNum Number: AllowListIP数量。
id String: The provider-assigned unique ID for this managed resource.

Look up Existing AllowList Resource

Get an existing AllowList resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AllowListState, opts?: CustomResourceOptions): AllowList

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_list: Optional[str] = None,
        allow_list_category: Optional[str] = None,
        allow_list_desc: Optional[str] = None,
        allow_list_id: Optional[str] = None,
        allow_list_ip_num: Optional[int] = None,
        allow_list_name: Optional[str] = None,
        allow_list_type: Optional[str] = None,
        associated_instance_num: Optional[int] = None,
        associated_instances: Optional[Sequence[AllowListAssociatedInstanceArgs]] = None,
        instance_id: Optional[str] = None,
        project_name: Optional[str] = None,
        user_allow_list: Optional[str] = None) -> AllowList

func GetAllowList(ctx *Context, name string, id IDInput, state *AllowListState, opts ...ResourceOption) (*AllowList, error)

public static AllowList Get(string name, Input<string> id, AllowListState? state, CustomResourceOptions? opts = null)

public static AllowList get(String name, Output<String> id, AllowListState state, CustomResourceOptions options)

resources:  _:    type: bytepluscc:rdsmssql:AllowList    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllowListCategory string: 白名单分类。
AllowListDesc string: 白名单描述。
AllowListId string: 白名单的id。
AllowListIpNum int: AllowListIP数量。
AllowListName string: 白名单名称。
AllowListType string: 白名单内的IP地址类型，当前仅支持IPv4。
AllowListValue string: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
AssociatedInstanceNum int: 绑定的实例数量。解绑实例的白名单时必传。
AssociatedInstances List<Byteplus.AllowListAssociatedInstance>
InstanceId string: 实例ID。
ProjectName string: 项目名称。
UserAllowList string: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

AllowList string: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
AllowListCategory string: 白名单分类。
AllowListDesc string: 白名单描述。
AllowListId string: 白名单的id。
AllowListIpNum int: AllowListIP数量。
AllowListName string: 白名单名称。
AllowListType string: 白名单内的IP地址类型，当前仅支持IPv4。
AssociatedInstanceNum int: 绑定的实例数量。解绑实例的白名单时必传。
AssociatedInstances []AllowListAssociatedInstanceArgs
InstanceId string: 实例ID。
ProjectName string: 项目名称。
UserAllowList string: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

allowList String: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
allowListCategory String: 白名单分类。
allowListDesc String: 白名单描述。
allowListId String: 白名单的id。
allowListIpNum Integer: AllowListIP数量。
allowListName String: 白名单名称。
allowListType String: 白名单内的IP地址类型，当前仅支持IPv4。
associatedInstanceNum Integer: 绑定的实例数量。解绑实例的白名单时必传。
associatedInstances List<AllowListAssociatedInstance>
instanceId String: 实例ID。
projectName String: 项目名称。
userAllowList String: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

allowList string: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
allowListCategory string: 白名单分类。
allowListDesc string: 白名单描述。
allowListId string: 白名单的id。
allowListIpNum number: AllowListIP数量。
allowListName string: 白名单名称。
allowListType string: 白名单内的IP地址类型，当前仅支持IPv4。
associatedInstanceNum number: 绑定的实例数量。解绑实例的白名单时必传。
associatedInstances AllowListAssociatedInstance[]
instanceId string: 实例ID。
projectName string: 项目名称。
userAllowList string: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

allow_list str: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
allow_list_category str: 白名单分类。
allow_list_desc str: 白名单描述。
allow_list_id str: 白名单的id。
allow_list_ip_num int: AllowListIP数量。
allow_list_name str: 白名单名称。
allow_list_type str: 白名单内的IP地址类型，当前仅支持IPv4。
associated_instance_num int: 绑定的实例数量。解绑实例的白名单时必传。
associated_instances Sequence[AllowListAssociatedInstanceArgs]
instance_id str: 实例ID。
project_name str: 项目名称。
user_allow_list str: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

allowList String: IP 白名单，多个 IP 地址请以英文逗号（,）隔开，不可重复。
allowListCategory String: 白名单分类。
allowListDesc String: 白名单描述。
allowListId String: 白名单的id。
allowListIpNum Number: AllowListIP数量。
allowListName String: 白名单名称。
allowListType String: 白名单内的IP地址类型，当前仅支持IPv4。
associatedInstanceNum Number: 绑定的实例数量。解绑实例的白名单时必传。
associatedInstances List<Property Map>
instanceId String: 实例ID。
projectName String: 项目名称。
userAllowList String: 安全组之外的、需要加入白名单的IP地址，可输入IP地址或CIDR格式的IP地址段。如果该字段与AllowList同时指定，以AllowList为准。

Supporting Types

AllowListAssociatedInstance, AllowListAssociatedInstanceArgs

InstanceId string: 实例ID。

InstanceId string: 实例ID。

instanceId String: 实例ID。

instanceId string: 实例ID。

instance_id str: 实例ID。

instanceId String: 实例ID。

Import

$ pulumi import bytepluscc:rdsmssql/allowList:AllowList example "allow_list_id"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.20
published on Thursday, Mar 26, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.rdsmssql.AllowList

On this page

On this page

Example Usage

Create AllowList Resource

Constructor syntax

Parameters

Constructor example

AllowList Resource Properties

Inputs

Outputs

Look up Existing AllowList Resource

Supporting Types

AllowListAssociatedInstance, AllowListAssociatedInstanceArgs

Import

Package Details

On this page

On this page