bytepluscc.gtm.Pool

bytepluscc v0.0.30, May 25 26

Viewing docs for bytepluscc v0.0.30
published on Monday, May 25, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.30
published on Monday, May 25, 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:
  gTMPoolDemo:
    type: bytepluscc:gtm:Pool
    name: GTMPoolDemo
    properties:
      addresses:
        - rectified_geos:
            - cn_telecom_shanghai
          capacity: 20
          mode: auto
          value: 2001:db8::2
          weight: 20
        - rectified_geos:
            - cn_telecom_beijing
          capacity: 40
          mode: auto
          value: 2001:db8::3
          weight: 21
      gtmId: 162ca39d-*******
      addrType: ipv6
      capacityMode: pool
      capacity: 90
      name: testpool
      remark: testdes

Example coming soon!

Create Pool Resource

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

Constructor syntax

new Pool(name: string, args: PoolArgs, opts?: CustomResourceOptions);

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

@overload
def Pool(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         addresses: Optional[Sequence[PoolAddressArgs]] = None,
         gtm_id: Optional[str] = None,
         name: Optional[str] = None,
         addr_type: Optional[str] = None,
         capacity: Optional[int] = None,
         capacity_mode: Optional[str] = None,
         remark: Optional[str] = None)

func NewPool(ctx *Context, name string, args PoolArgs, opts ...ResourceOption) (*Pool, error)

public Pool(string name, PoolArgs args, CustomResourceOptions? opts = null)

public Pool(String name, PoolArgs args)
public Pool(String name, PoolArgs args, CustomResourceOptions options)

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

resource "bytepluscc_gtm_pool" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args PoolArgs: 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 PoolArgs: 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 PoolArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args PoolArgs: 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 poolResource = new Bytepluscc.Gtm.Pool("poolResource", new()
{
    Addresses = new[]
    {
        new Bytepluscc.Gtm.Inputs.PoolAddressArgs
        {
            Value = "string",
            Capacity = 0,
            Mode = "string",
            RectifiedGeos = new[]
            {
                "string",
            },
            Weight = 0,
        },
    },
    GtmId = "string",
    Name = "string",
    AddrType = "string",
    Capacity = 0,
    CapacityMode = "string",
    Remark = "string",
});

example, err := gtm.NewPool(ctx, "poolResource", &gtm.PoolArgs{
	Addresses: gtm.PoolAddressArray{
		&gtm.PoolAddressArgs{
			Value:    pulumi.String("string"),
			Capacity: pulumi.Int(0),
			Mode:     pulumi.String("string"),
			RectifiedGeos: pulumi.StringArray{
				pulumi.String("string"),
			},
			Weight: pulumi.Int(0),
		},
	},
	GtmId:        pulumi.String("string"),
	Name:         pulumi.String("string"),
	AddrType:     pulumi.String("string"),
	Capacity:     pulumi.Int(0),
	CapacityMode: pulumi.String("string"),
	Remark:       pulumi.String("string"),
})

resource "bytepluscc_gtm_pool" "poolResource" {
  addresses {
    value          = "string"
    capacity       = 0
    mode           = "string"
    rectified_geos = ["string"]
    weight         = 0
  }
  gtm_id        = "string"
  name          = "string"
  addr_type     = "string"
  capacity      = 0
  capacity_mode = "string"
  remark        = "string"
}

var poolResource = new Pool("poolResource", PoolArgs.builder()
    .addresses(PoolAddressArgs.builder()
        .value("string")
        .capacity(0)
        .mode("string")
        .rectifiedGeos("string")
        .weight(0)
        .build())
    .gtmId("string")
    .name("string")
    .addrType("string")
    .capacity(0)
    .capacityMode("string")
    .remark("string")
    .build());

pool_resource = bytepluscc.gtm.Pool("poolResource",
    addresses=[{
        "value": "string",
        "capacity": 0,
        "mode": "string",
        "rectified_geos": ["string"],
        "weight": 0,
    }],
    gtm_id="string",
    name="string",
    addr_type="string",
    capacity=0,
    capacity_mode="string",
    remark="string")

const poolResource = new bytepluscc.gtm.Pool("poolResource", {
    addresses: [{
        value: "string",
        capacity: 0,
        mode: "string",
        rectifiedGeos: ["string"],
        weight: 0,
    }],
    gtmId: "string",
    name: "string",
    addrType: "string",
    capacity: 0,
    capacityMode: "string",
    remark: "string",
});

type: bytepluscc:gtm:Pool
properties:
    addrType: string
    addresses:
        - capacity: 0
          mode: string
          rectifiedGeos:
            - string
          value: string
          weight: 0
    capacity: 0
    capacityMode: string
    gtmId: string
    name: string
    remark: string

Pool 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 Pool resource accepts the following input properties:

Addresses List<Byteplus.PoolAddress>
GtmId string: UUID of the associated GTM instance
Name string: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
AddrType string: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
Capacity int: Address pool capacity
CapacityMode string: Capacity mode, indicates whether to configure address pool capacity or address capacity
Remark string: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters

Addresses []PoolAddressArgs
GtmId string: UUID of the associated GTM instance
Name string: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
AddrType string: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
Capacity int: Address pool capacity
CapacityMode string: Capacity mode, indicates whether to configure address pool capacity or address capacity
Remark string: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters

addresses list(object)
gtm_id string: UUID of the associated GTM instance
name string: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
addr_type string: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
capacity number: Address pool capacity
capacity_mode string: Capacity mode, indicates whether to configure address pool capacity or address capacity
remark string: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters

addresses List<PoolAddress>
gtmId String: UUID of the associated GTM instance
name String: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
addrType String: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
capacity Integer: Address pool capacity
capacityMode String: Capacity mode, indicates whether to configure address pool capacity or address capacity
remark String: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters

addresses PoolAddress[]
gtmId string: UUID of the associated GTM instance
name string: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
addrType string: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
capacity number: Address pool capacity
capacityMode string: Capacity mode, indicates whether to configure address pool capacity or address capacity
remark string: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters

addresses Sequence[PoolAddressArgs]
gtm_id str: UUID of the associated GTM instance
name str: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
addr_type str: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
capacity int: Address pool capacity
capacity_mode str: Capacity mode, indicates whether to configure address pool capacity or address capacity
remark str: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters

addresses List<Property Map>
gtmId String: UUID of the associated GTM instance
name String: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
addrType String: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
capacity Number: Address pool capacity
capacityMode String: Capacity mode, indicates whether to configure address pool capacity or address capacity
remark String: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters

Outputs

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

CreateTime string: Creation time
Deletable bool: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
Id string: The provider-assigned unique ID for this managed resource.
PoolId string: Address pool ID
UpdateTime string: Update time

CreateTime string: Creation time
Deletable bool: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
Id string: The provider-assigned unique ID for this managed resource.
PoolId string: Address pool ID
UpdateTime string: Update time

create_time string: Creation time
deletable bool: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
id string: The provider-assigned unique ID for this managed resource.
pool_id string: Address pool ID
update_time string: Update time

createTime String: Creation time
deletable Boolean: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
id String: The provider-assigned unique ID for this managed resource.
poolId String: Address pool ID
updateTime String: Update time

createTime string: Creation time
deletable boolean: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
id string: The provider-assigned unique ID for this managed resource.
poolId string: Address pool ID
updateTime string: Update time

create_time str: Creation time
deletable bool: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
id str: The provider-assigned unique ID for this managed resource.
pool_id str: Address pool ID
update_time str: Update time

createTime String: Creation time
deletable Boolean: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
id String: The provider-assigned unique ID for this managed resource.
poolId String: Address pool ID
updateTime String: Update time

Look up Existing Pool Resource

Get an existing Pool 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?: PoolState, opts?: CustomResourceOptions): Pool

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addr_type: Optional[str] = None,
        addresses: Optional[Sequence[PoolAddressArgs]] = None,
        capacity: Optional[int] = None,
        capacity_mode: Optional[str] = None,
        create_time: Optional[str] = None,
        deletable: Optional[bool] = None,
        gtm_id: Optional[str] = None,
        name: Optional[str] = None,
        pool_id: Optional[str] = None,
        remark: Optional[str] = None,
        update_time: Optional[str] = None) -> Pool

func GetPool(ctx *Context, name string, id IDInput, state *PoolState, opts ...ResourceOption) (*Pool, error)

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

public static Pool get(String name, Output<String> id, PoolState state, CustomResourceOptions options)

resources:  _:    type: bytepluscc:gtm:Pool    get:      id: ${id}

import {
  to = bytepluscc_gtm_pool.example
  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:

AddrType string: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
Addresses List<Byteplus.PoolAddress>
Capacity int: Address pool capacity
CapacityMode string: Capacity mode, indicates whether to configure address pool capacity or address capacity
CreateTime string: Creation time
Deletable bool: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
GtmId string: UUID of the associated GTM instance
Name string: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
PoolId string: Address pool ID
Remark string: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
UpdateTime string: Update time

AddrType string: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
Addresses []PoolAddressArgs
Capacity int: Address pool capacity
CapacityMode string: Capacity mode, indicates whether to configure address pool capacity or address capacity
CreateTime string: Creation time
Deletable bool: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
GtmId string: UUID of the associated GTM instance
Name string: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
PoolId string: Address pool ID
Remark string: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
UpdateTime string: Update time

addr_type string: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
addresses list(object)
capacity number: Address pool capacity
capacity_mode string: Capacity mode, indicates whether to configure address pool capacity or address capacity
create_time string: Creation time
deletable bool: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
gtm_id string: UUID of the associated GTM instance
name string: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
pool_id string: Address pool ID
remark string: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
update_time string: Update time

addrType String: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
addresses List<PoolAddress>
capacity Integer: Address pool capacity
capacityMode String: Capacity mode, indicates whether to configure address pool capacity or address capacity
createTime String: Creation time
deletable Boolean: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
gtmId String: UUID of the associated GTM instance
name String: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
poolId String: Address pool ID
remark String: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
updateTime String: Update time

addrType string: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
addresses PoolAddress[]
capacity number: Address pool capacity
capacityMode string: Capacity mode, indicates whether to configure address pool capacity or address capacity
createTime string: Creation time
deletable boolean: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
gtmId string: UUID of the associated GTM instance
name string: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
poolId string: Address pool ID
remark string: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
updateTime string: Update time

addr_type str: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
addresses Sequence[PoolAddressArgs]
capacity int: Address pool capacity
capacity_mode str: Capacity mode, indicates whether to configure address pool capacity or address capacity
create_time str: Creation time
deletable bool: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
gtm_id str: UUID of the associated GTM instance
name str: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
pool_id str: Address pool ID
remark str: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
update_time str: Update time

addrType String: Target address type of the address pool. If you do not set this parameter, Cloud Scheduling GTM will automatically determine the target address type. ipv4: IPv4 address. ipv6: IPv6 address. cname: Domain name
addresses List<Property Map>
capacity Number: Address pool capacity
capacityMode String: Capacity mode, indicates whether to configure address pool capacity or address capacity
createTime String: Creation time
deletable Boolean: Whether the address pool can be deleted. true: The address pool is not referenced by any routing rule and can be deleted. false: The address pool is referenced by one or more routing rules and cannot be deleted
gtmId String: UUID of the associated GTM instance
name String: Address pool name. UTF-8 format. Maximum length is 64 UTF-8 characters
poolId String: Address pool ID
remark String: Address pool remarks. Default is an empty string. UTF-8 format. Maximum length is 128 UTF-8 characters
updateTime String: Update time

Supporting Types

PoolAddress, PoolAddressArgs

Value string: Target address value
Capacity int: Address capacity
Mode string: Address availability mode
RectifiedGeos List<string>: List of geographic route codes to be corrected
Weight int: Address weight

Value string: Target address value
Capacity int: Address capacity
Mode string: Address availability mode
RectifiedGeos []string: List of geographic route codes to be corrected
Weight int: Address weight

value string: Target address value
capacity number: Address capacity
mode string: Address availability mode
rectified_geos list(string): List of geographic route codes to be corrected
weight number: Address weight

value String: Target address value
capacity Integer: Address capacity
mode String: Address availability mode
rectifiedGeos List<String>: List of geographic route codes to be corrected
weight Integer: Address weight

value string: Target address value
capacity number: Address capacity
mode string: Address availability mode
rectifiedGeos string[]: List of geographic route codes to be corrected
weight number: Address weight

value str: Target address value
capacity int: Address capacity
mode str: Address availability mode
rectified_geos Sequence[str]: List of geographic route codes to be corrected
weight int: Address weight

value String: Target address value
capacity Number: Address capacity
mode String: Address availability mode
rectifiedGeos List<String>: List of geographic route codes to be corrected
weight Number: Address weight

Import

$ pulumi import bytepluscc:gtm/pool:Pool example "gtm_id|pool_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.30
published on Monday, May 25, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

On this page

On this page

Example Usage

Create Pool Resource

Constructor syntax

Parameters

Constructor example

Pool Resource Properties

Inputs

Outputs

Look up Existing Pool Resource

Supporting Types

PoolAddress, PoolAddressArgs

Import

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

bytepluscc.gtm.Pool

On this page

On this page

Example Usage

Create Pool Resource

Constructor syntax

Parameters

Constructor example

Pool Resource Properties

Inputs

Outputs

Look up Existing Pool Resource

Supporting Types

PoolAddress, PoolAddressArgs

Import

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.