1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. rdsmssql
  5. AllowList
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.rdsmssql.AllowList

bytepluscc logo
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    API request parameter - Create RDS SQL Server allowlist (CreateAllowList)

    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
    Allowlist name
    AllowListCategory string
    Allowlist category
    AllowListDesc string
    Allowlist description
    AllowListType string
    IP address type in the allowlist. Only IPv4 is supported
    AllowListValue string
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    AssociatedInstanceNum int
    Number of bound instances. Required when unbinding an instance from the allowlist
    AssociatedInstances List<Byteplus.AllowListAssociatedInstance>
    InstanceId string
    Instance ID
    ProjectName string
    Project name
    UserAllowList string
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence
    AllowListName string
    Allowlist name
    AllowList string
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    AllowListCategory string
    Allowlist category
    AllowListDesc string
    Allowlist description
    AllowListType string
    IP address type in the allowlist. Only IPv4 is supported
    AssociatedInstanceNum int
    Number of bound instances. Required when unbinding an instance from the allowlist
    AssociatedInstances []AllowListAssociatedInstanceArgs
    InstanceId string
    Instance ID
    ProjectName string
    Project name
    UserAllowList string
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence
    allowListName String
    Allowlist name
    allowList String
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    allowListCategory String
    Allowlist category
    allowListDesc String
    Allowlist description
    allowListType String
    IP address type in the allowlist. Only IPv4 is supported
    associatedInstanceNum Integer
    Number of bound instances. Required when unbinding an instance from the allowlist
    associatedInstances List<AllowListAssociatedInstance>
    instanceId String
    Instance ID
    projectName String
    Project name
    userAllowList String
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence
    allowListName string
    Allowlist name
    allowList string
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    allowListCategory string
    Allowlist category
    allowListDesc string
    Allowlist description
    allowListType string
    IP address type in the allowlist. Only IPv4 is supported
    associatedInstanceNum number
    Number of bound instances. Required when unbinding an instance from the allowlist
    associatedInstances AllowListAssociatedInstance[]
    instanceId string
    Instance ID
    projectName string
    Project name
    userAllowList string
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence
    allow_list_name str
    Allowlist name
    allow_list str
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    allow_list_category str
    Allowlist category
    allow_list_desc str
    Allowlist description
    allow_list_type str
    IP address type in the allowlist. Only IPv4 is supported
    associated_instance_num int
    Number of bound instances. Required when unbinding an instance from the allowlist
    associated_instances Sequence[AllowListAssociatedInstanceArgs]
    instance_id str
    Instance ID
    project_name str
    Project name
    user_allow_list str
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence
    allowListName String
    Allowlist name
    allowList String
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    allowListCategory String
    Allowlist category
    allowListDesc String
    Allowlist description
    allowListType String
    IP address type in the allowlist. Only IPv4 is supported
    associatedInstanceNum Number
    Number of bound instances. Required when unbinding an instance from the allowlist
    associatedInstances List<Property Map>
    instanceId String
    Instance ID
    projectName String
    Project name
    userAllowList String
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence

    Outputs

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

    AllowListId string
    Allowlist ID
    AllowListIpNum int
    Allowlist IP count
    Id string
    The provider-assigned unique ID for this managed resource.
    AllowListId string
    Allowlist ID
    AllowListIpNum int
    Allowlist IP count
    Id string
    The provider-assigned unique ID for this managed resource.
    allowListId String
    Allowlist ID
    allowListIpNum Integer
    Allowlist IP count
    id String
    The provider-assigned unique ID for this managed resource.
    allowListId string
    Allowlist ID
    allowListIpNum number
    Allowlist IP count
    id string
    The provider-assigned unique ID for this managed resource.
    allow_list_id str
    Allowlist ID
    allow_list_ip_num int
    Allowlist IP count
    id str
    The provider-assigned unique ID for this managed resource.
    allowListId String
    Allowlist ID
    allowListIpNum Number
    Allowlist IP count
    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
    Allowlist category
    AllowListDesc string
    Allowlist description
    AllowListId string
    Allowlist ID
    AllowListIpNum int
    Allowlist IP count
    AllowListName string
    Allowlist name
    AllowListType string
    IP address type in the allowlist. Only IPv4 is supported
    AllowListValue string
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    AssociatedInstanceNum int
    Number of bound instances. Required when unbinding an instance from the allowlist
    AssociatedInstances List<Byteplus.AllowListAssociatedInstance>
    InstanceId string
    Instance ID
    ProjectName string
    Project name
    UserAllowList string
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence
    AllowList string
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    AllowListCategory string
    Allowlist category
    AllowListDesc string
    Allowlist description
    AllowListId string
    Allowlist ID
    AllowListIpNum int
    Allowlist IP count
    AllowListName string
    Allowlist name
    AllowListType string
    IP address type in the allowlist. Only IPv4 is supported
    AssociatedInstanceNum int
    Number of bound instances. Required when unbinding an instance from the allowlist
    AssociatedInstances []AllowListAssociatedInstanceArgs
    InstanceId string
    Instance ID
    ProjectName string
    Project name
    UserAllowList string
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence
    allowList String
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    allowListCategory String
    Allowlist category
    allowListDesc String
    Allowlist description
    allowListId String
    Allowlist ID
    allowListIpNum Integer
    Allowlist IP count
    allowListName String
    Allowlist name
    allowListType String
    IP address type in the allowlist. Only IPv4 is supported
    associatedInstanceNum Integer
    Number of bound instances. Required when unbinding an instance from the allowlist
    associatedInstances List<AllowListAssociatedInstance>
    instanceId String
    Instance ID
    projectName String
    Project name
    userAllowList String
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence
    allowList string
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    allowListCategory string
    Allowlist category
    allowListDesc string
    Allowlist description
    allowListId string
    Allowlist ID
    allowListIpNum number
    Allowlist IP count
    allowListName string
    Allowlist name
    allowListType string
    IP address type in the allowlist. Only IPv4 is supported
    associatedInstanceNum number
    Number of bound instances. Required when unbinding an instance from the allowlist
    associatedInstances AllowListAssociatedInstance[]
    instanceId string
    Instance ID
    projectName string
    Project name
    userAllowList string
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence
    allow_list str
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    allow_list_category str
    Allowlist category
    allow_list_desc str
    Allowlist description
    allow_list_id str
    Allowlist ID
    allow_list_ip_num int
    Allowlist IP count
    allow_list_name str
    Allowlist name
    allow_list_type str
    IP address type in the allowlist. Only IPv4 is supported
    associated_instance_num int
    Number of bound instances. Required when unbinding an instance from the allowlist
    associated_instances Sequence[AllowListAssociatedInstanceArgs]
    instance_id str
    Instance ID
    project_name str
    Project name
    user_allow_list str
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence
    allowList String
    IP allowlist. Separate multiple IP addresses with commas (,). No duplicates allowed
    allowListCategory String
    Allowlist category
    allowListDesc String
    Allowlist description
    allowListId String
    Allowlist ID
    allowListIpNum Number
    Allowlist IP count
    allowListName String
    Allowlist name
    allowListType String
    IP address type in the allowlist. Only IPv4 is supported
    associatedInstanceNum Number
    Number of bound instances. Required when unbinding an instance from the allowlist
    associatedInstances List<Property Map>
    instanceId String
    Instance ID
    projectName String
    Project name
    userAllowList String
    IP addresses outside the security group that need to be added to the allowlist. Enter IP addresses or CIDR-formatted IP ranges. If both this field and AllowList are specified, AllowList takes precedence

    Supporting Types

    AllowListAssociatedInstance, AllowListAssociatedInstanceArgs

    InstanceId string
    Instance ID
    InstanceId string
    Instance ID
    instanceId String
    Instance ID
    instanceId string
    Instance ID
    instance_id str
    Instance ID
    instanceId String
    Instance 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.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.21
    published on Thursday, Apr 2, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.