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

volcenginecc.natgateway.getNgw

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::NatGateway::NGW

    Using getNgw

    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 getNgw(args: GetNgwArgs, opts?: InvokeOptions): Promise<GetNgwResult>
function getNgwOutput(args: GetNgwOutputArgs, opts?: InvokeOptions): Output<GetNgwResult>
    def get_ngw(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetNgwResult
def get_ngw_output(id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetNgwResult]
    func LookupNgw(ctx *Context, args *LookupNgwArgs, opts ...InvokeOption) (*LookupNgwResult, error)
func LookupNgwOutput(ctx *Context, args *LookupNgwOutputArgs, opts ...InvokeOption) LookupNgwResultOutput

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

    public static class GetNgw 
{
    public static Task<GetNgwResult> InvokeAsync(GetNgwArgs args, InvokeOptions? opts = null)
    public static Output<GetNgwResult> Invoke(GetNgwInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNgwResult> getNgw(GetNgwArgs args, InvokeOptions options)
public static Output<GetNgwResult> getNgw(GetNgwArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:natgateway/getNgw:getNgw
  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.

    getNgw Result

    The following output properties are available:

    BillingType int
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    BusinessStatus string
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    CreatedTime string
    Creation time
    DeletedTime string
    Deletion time
    Description string
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    DirectMode bool
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    DnatEntryIds List<string>
    DNAT rule ID list.
    EipAddresses List<Volcengine.GetNgwEipAddress>
    Information about the public IP bound to the NAT Gateway
    ExpiredTime string
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    Id string
    Uniquely identifies the resource.
    LockReason string
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    NatGatewayId string
    NAT gateway ID.
    NatGatewayName string
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    NatIpAddresses List<Volcengine.GetNgwNatIpAddress>
    Transit IP list for private NAT instance
    NetworkInterfaceId string
    Network interface ID occupied by the NAT gateway.
    NetworkType string
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    Period int
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    PeriodUnit string
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    ProjectName string
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    SmartScheduleEnabled bool
    Whether to enable intelligent scheduling
    SmartScheduleRule string
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    SnatEntryIds List<string>
    SNAT rule ID list
    Spec string
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    Status string
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    SubnetId string
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    Tags List<Volcengine.GetNgwTag>
    Tag list
    UpdatedTime string
    Last operation time of the NAT Gateway
    VpcId string
    ID of the private network where the NAT Gateway is located
    ZoneId string
    ID of the primary availability zone the NAT Gateway belongs to
    BillingType int
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    BusinessStatus string
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    CreatedTime string
    Creation time
    DeletedTime string
    Deletion time
    Description string
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    DirectMode bool
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    DnatEntryIds []string
    DNAT rule ID list.
    EipAddresses []GetNgwEipAddress
    Information about the public IP bound to the NAT Gateway
    ExpiredTime string
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    Id string
    Uniquely identifies the resource.
    LockReason string
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    NatGatewayId string
    NAT gateway ID.
    NatGatewayName string
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    NatIpAddresses []GetNgwNatIpAddress
    Transit IP list for private NAT instance
    NetworkInterfaceId string
    Network interface ID occupied by the NAT gateway.
    NetworkType string
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    Period int
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    PeriodUnit string
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    ProjectName string
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    SmartScheduleEnabled bool
    Whether to enable intelligent scheduling
    SmartScheduleRule string
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    SnatEntryIds []string
    SNAT rule ID list
    Spec string
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    Status string
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    SubnetId string
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    Tags []GetNgwTag
    Tag list
    UpdatedTime string
    Last operation time of the NAT Gateway
    VpcId string
    ID of the private network where the NAT Gateway is located
    ZoneId string
    ID of the primary availability zone the NAT Gateway belongs to
    billingType Integer
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    businessStatus String
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    createdTime String
    Creation time
    deletedTime String
    Deletion time
    description String
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    directMode Boolean
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnatEntryIds List<String>
    DNAT rule ID list.
    eipAddresses List<GetNgwEipAddress>
    Information about the public IP bound to the NAT Gateway
    expiredTime String
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    id String
    Uniquely identifies the resource.
    lockReason String
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    natGatewayId String
    NAT gateway ID.
    natGatewayName String
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    natIpAddresses List<GetNgwNatIpAddress>
    Transit IP list for private NAT instance
    networkInterfaceId String
    Network interface ID occupied by the NAT gateway.
    networkType String
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    period Integer
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    periodUnit String
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    projectName String
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smartScheduleEnabled Boolean
    Whether to enable intelligent scheduling
    smartScheduleRule String
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    snatEntryIds List<String>
    SNAT rule ID list
    spec String
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    status String
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    subnetId String
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    tags List<GetNgwTag>
    Tag list
    updatedTime String
    Last operation time of the NAT Gateway
    vpcId String
    ID of the private network where the NAT Gateway is located
    zoneId String
    ID of the primary availability zone the NAT Gateway belongs to
    billingType number
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    businessStatus string
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    createdTime string
    Creation time
    deletedTime string
    Deletion time
    description string
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    directMode boolean
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnatEntryIds string[]
    DNAT rule ID list.
    eipAddresses GetNgwEipAddress[]
    Information about the public IP bound to the NAT Gateway
    expiredTime string
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    id string
    Uniquely identifies the resource.
    lockReason string
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    natGatewayId string
    NAT gateway ID.
    natGatewayName string
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    natIpAddresses GetNgwNatIpAddress[]
    Transit IP list for private NAT instance
    networkInterfaceId string
    Network interface ID occupied by the NAT gateway.
    networkType string
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    overdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    period number
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    periodUnit string
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    projectName string
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smartScheduleEnabled boolean
    Whether to enable intelligent scheduling
    smartScheduleRule string
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    snatEntryIds string[]
    SNAT rule ID list
    spec string
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    status string
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    subnetId string
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    tags GetNgwTag[]
    Tag list
    updatedTime string
    Last operation time of the NAT Gateway
    vpcId string
    ID of the private network where the NAT Gateway is located
    zoneId string
    ID of the primary availability zone the NAT Gateway belongs to
    billing_type int
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    business_status str
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    created_time str
    Creation time
    deleted_time str
    Deletion time
    description str
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    direct_mode bool
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnat_entry_ids Sequence[str]
    DNAT rule ID list.
    eip_addresses Sequence[GetNgwEipAddress]
    Information about the public IP bound to the NAT Gateway
    expired_time str
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    id str
    Uniquely identifies the resource.
    lock_reason str
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    nat_gateway_id str
    NAT gateway ID.
    nat_gateway_name str
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    nat_ip_addresses Sequence[GetNgwNatIpAddress]
    Transit IP list for private NAT instance
    network_interface_id str
    Network interface ID occupied by the NAT gateway.
    network_type str
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    overdue_time str
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    period int
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    period_unit str
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    project_name str
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smart_schedule_enabled bool
    Whether to enable intelligent scheduling
    smart_schedule_rule str
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    snat_entry_ids Sequence[str]
    SNAT rule ID list
    spec str
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    status str
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    subnet_id str
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    tags Sequence[GetNgwTag]
    Tag list
    updated_time str
    Last operation time of the NAT Gateway
    vpc_id str
    ID of the private network where the NAT Gateway is located
    zone_id str
    ID of the primary availability zone the NAT Gateway belongs to
    billingType Number
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    businessStatus String
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    createdTime String
    Creation time
    deletedTime String
    Deletion time
    description String
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    directMode Boolean
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnatEntryIds List<String>
    DNAT rule ID list.
    eipAddresses List<Property Map>
    Information about the public IP bound to the NAT Gateway
    expiredTime String
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    id String
    Uniquely identifies the resource.
    lockReason String
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    natGatewayId String
    NAT gateway ID.
    natGatewayName String
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    natIpAddresses List<Property Map>
    Transit IP list for private NAT instance
    networkInterfaceId String
    Network interface ID occupied by the NAT gateway.
    networkType String
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    period Number
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    periodUnit String
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    projectName String
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smartScheduleEnabled Boolean
    Whether to enable intelligent scheduling
    smartScheduleRule String
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    snatEntryIds List<String>
    SNAT rule ID list
    spec String
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    status String
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    subnetId String
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    tags List<Property Map>
    Tag list
    updatedTime String
    Last operation time of the NAT Gateway
    vpcId String
    ID of the private network where the NAT Gateway is located
    zoneId String
    ID of the primary availability zone the NAT Gateway belongs to

    Supporting Types

    GetNgwEipAddress

    AllocationId string
    Public IP ID
    EipAddress string
    Public IP address
    UsingStatus string
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    AllocationId string
    Public IP ID
    EipAddress string
    Public IP address
    UsingStatus string
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    allocationId String
    Public IP ID
    eipAddress String
    Public IP address
    usingStatus String
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    allocationId string
    Public IP ID
    eipAddress string
    Public IP address
    usingStatus string
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    allocation_id str
    Public IP ID
    eip_address str
    Public IP address
    using_status str
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    allocationId String
    Public IP ID
    eipAddress String
    Public IP address
    usingStatus String
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.

    GetNgwNatIpAddress

    NatIpAddress string
    Transit IP address
    NatIpId string
    Transit IP ID
    NatIpAddress string
    Transit IP address
    NatIpId string
    Transit IP ID
    natIpAddress String
    Transit IP address
    natIpId String
    Transit IP ID
    natIpAddress string
    Transit IP address
    natIpId string
    Transit IP ID
    nat_ip_address str
    Transit IP address
    nat_ip_id str
    Transit IP ID
    natIpAddress String
    Transit IP address
    natIpId String
    Transit IP ID

    GetNgwTag

    Key string
    User tag key.
    Value string
    User tag value
    Key string
    User tag key.
    Value string
    User tag value
    key String
    User tag key.
    value String
    User tag value
    key string
    User tag key.
    value string
    User tag value
    key str
    User tag key.
    value str
    User tag value
    key String
    User tag key.
    value String
    User tag value

    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.