1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vpn
  6. getCustomerGateway
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.vpn.getCustomerGateway

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::VPN::CustomerGateway

    Using getCustomerGateway

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCustomerGateway(args: GetCustomerGatewayArgs, opts?: InvokeOptions): Promise<GetCustomerGatewayResult>
function getCustomerGatewayOutput(args: GetCustomerGatewayOutputArgs, opts?: InvokeOptions): Output<GetCustomerGatewayResult>
    def get_customer_gateway(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCustomerGatewayResult
def get_customer_gateway_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCustomerGatewayResult]
    func LookupCustomerGateway(ctx *Context, args *LookupCustomerGatewayArgs, opts ...InvokeOption) (*LookupCustomerGatewayResult, error)
func LookupCustomerGatewayOutput(ctx *Context, args *LookupCustomerGatewayOutputArgs, opts ...InvokeOption) LookupCustomerGatewayResultOutput

    > Note: This function is named LookupCustomerGateway in the Go SDK.

    public static class GetCustomerGateway 
{
    public static Task<GetCustomerGatewayResult> InvokeAsync(GetCustomerGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomerGatewayResult> Invoke(GetCustomerGatewayInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomerGatewayResult> getCustomerGateway(GetCustomerGatewayArgs args, InvokeOptions options)
public static Output<GetCustomerGatewayResult> getCustomerGateway(GetCustomerGatewayArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:vpn/getCustomerGateway:getCustomerGateway
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getCustomerGateway Result

    The following output properties are available:

    AccountId string
    ID of the account to which the user gateway belongs
    Asn int
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    ConnectionCount int
    Number of IPsec connections associated with the user gateway
    CreatedTime string
    Time when the user gateway was created
    CustomerGatewayId string
    Gateway ID
    CustomerGatewayName string
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    Description string
    Description of the user gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, defaults to an empty string
    Id string
    Uniquely identifies the resource.
    IpAddress string
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    IpVersion string
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    ProjectName string
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    Status string
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags List<Volcengine.GetCustomerGatewayTag>
    Tag list
    UpdatedTime string
    Time when the user gateway was updated
    AccountId string
    ID of the account to which the user gateway belongs
    Asn int
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    ConnectionCount int
    Number of IPsec connections associated with the user gateway
    CreatedTime string
    Time when the user gateway was created
    CustomerGatewayId string
    Gateway ID
    CustomerGatewayName string
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    Description string
    Description of the user gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, defaults to an empty string
    Id string
    Uniquely identifies the resource.
    IpAddress string
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    IpVersion string
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    ProjectName string
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    Status string
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    Tags []GetCustomerGatewayTag
    Tag list
    UpdatedTime string
    Time when the user gateway was updated
    accountId String
    ID of the account to which the user gateway belongs
    asn Integer
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    connectionCount Integer
    Number of IPsec connections associated with the user gateway
    createdTime String
    Time when the user gateway was created
    customerGatewayId String
    Gateway ID
    customerGatewayName String
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description String
    Description of the user gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, defaults to an empty string
    id String
    Uniquely identifies the resource.
    ipAddress String
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    ipVersion String
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    projectName String
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    status String
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<GetCustomerGatewayTag>
    Tag list
    updatedTime String
    Time when the user gateway was updated
    accountId string
    ID of the account to which the user gateway belongs
    asn number
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    connectionCount number
    Number of IPsec connections associated with the user gateway
    createdTime string
    Time when the user gateway was created
    customerGatewayId string
    Gateway ID
    customerGatewayName string
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description string
    Description of the user gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, defaults to an empty string
    id string
    Uniquely identifies the resource.
    ipAddress string
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    ipVersion string
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    projectName string
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    status string
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags GetCustomerGatewayTag[]
    Tag list
    updatedTime string
    Time when the user gateway was updated
    account_id str
    ID of the account to which the user gateway belongs
    asn int
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    connection_count int
    Number of IPsec connections associated with the user gateway
    created_time str
    Time when the user gateway was created
    customer_gateway_id str
    Gateway ID
    customer_gateway_name str
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description str
    Description of the user gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, defaults to an empty string
    id str
    Uniquely identifies the resource.
    ip_address str
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    ip_version str
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    project_name str
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    status str
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags Sequence[GetCustomerGatewayTag]
    Tag list
    updated_time str
    Time when the user gateway was updated
    accountId String
    ID of the account to which the user gateway belongs
    asn Number
    User gateway ASN (Autonomous System Number). This parameter is required if you need to use BGP functionality. Valid ASN range is 1–4294967295 (excluding 137718, 150436, and 65533)
    connectionCount Number
    Number of IPsec connections associated with the user gateway
    createdTime String
    Time when the user gateway was created
    customerGatewayId String
    Gateway ID
    customerGatewayName String
    User gateway name. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the user gateway ID
    description String
    Description of the user gateway. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, period (.), space ( ), underscore (_), hyphen (-), equals sign (=), English comma (,), Chinese comma (，), and Chinese period (。). Length must be between 0 and 255 characters. If not specified, defaults to an empty string
    id String
    Uniquely identifies the resource.
    ipAddress String
    Static public IP address of the peer local data center gateway or the VPN gateway egress IP address of another VPC. If the peer does not have a fixed static public IP, enter 0.0.0.0 here
    ipVersion String
    IP address protocol type for the VPN gateway. Options: ipv4 (default), ipv6
    projectName String
    Project to which the user gateway belongs. If not specified, defaults to 'default', meaning the created resource belongs to the default project
    status String
    Status of the user gateway. Creating: creating. Deleting: deleting. Pending: configuring. Available: available
    tags List<Property Map>
    Tag list
    updatedTime String
    Time when the user gateway was updated

    Supporting Types

    GetCustomerGatewayTag

    Key string
    Tag key for user tag
    Value string
    Tag value for user tag
    Key string
    Tag key for user tag
    Value string
    Tag value for user tag
    key String
    Tag key for user tag
    value String
    Tag value for user tag
    key string
    Tag key for user tag
    value string
    Tag value for user tag
    key str
    Tag key for user tag
    value str
    Tag value for user tag
    key String
    Tag key for user tag
    value String
    Tag value for user tag

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.