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

volcenginecc.natgateway.getNatIp

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::NatIp

    Using getNatIp

    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 getNatIp(args: GetNatIpArgs, opts?: InvokeOptions): Promise<GetNatIpResult>
function getNatIpOutput(args: GetNatIpOutputArgs, opts?: InvokeOptions): Output<GetNatIpResult>
    def get_nat_ip(id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetNatIpResult
def get_nat_ip_output(id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetNatIpResult]
    func LookupNatIp(ctx *Context, args *LookupNatIpArgs, opts ...InvokeOption) (*LookupNatIpResult, error)
func LookupNatIpOutput(ctx *Context, args *LookupNatIpOutputArgs, opts ...InvokeOption) LookupNatIpResultOutput

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

    public static class GetNatIp 
{
    public static Task<GetNatIpResult> InvokeAsync(GetNatIpArgs args, InvokeOptions? opts = null)
    public static Output<GetNatIpResult> Invoke(GetNatIpInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNatIpResult> getNatIp(GetNatIpArgs args, InvokeOptions options)
public static Output<GetNatIpResult> getNatIp(GetNatIpArgs args, InvokeOptions options)

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

    getNatIp Result

    The following output properties are available:

    Id string
    Uniquely identifies the resource.
    IsDefault bool
    Whether this is the default transit IP. true: Yes. false: No.
    NatGatewayId string
    Private NAT gateway ID.
    NatIp string
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    NatIpDescription string
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    NatIpId string
    Transit IP ID.
    NatIpName string
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    Status string
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    UsingStatus string
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    Id string
    Uniquely identifies the resource.
    IsDefault bool
    Whether this is the default transit IP. true: Yes. false: No.
    NatGatewayId string
    Private NAT gateway ID.
    NatIp string
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    NatIpDescription string
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    NatIpId string
    Transit IP ID.
    NatIpName string
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    Status string
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    UsingStatus string
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    id String
    Uniquely identifies the resource.
    isDefault Boolean
    Whether this is the default transit IP. true: Yes. false: No.
    natGatewayId String
    Private NAT gateway ID.
    natIp String
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    natIpDescription String
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    natIpId String
    Transit IP ID.
    natIpName String
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    status String
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    usingStatus String
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    id string
    Uniquely identifies the resource.
    isDefault boolean
    Whether this is the default transit IP. true: Yes. false: No.
    natGatewayId string
    Private NAT gateway ID.
    natIp string
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    natIpDescription string
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    natIpId string
    Transit IP ID.
    natIpName string
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    status string
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    usingStatus string
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    id str
    Uniquely identifies the resource.
    is_default bool
    Whether this is the default transit IP. true: Yes. false: No.
    nat_gateway_id str
    Private NAT gateway ID.
    nat_ip str
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    nat_ip_description str
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    nat_ip_id str
    Transit IP ID.
    nat_ip_name str
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    status str
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    using_status str
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    id String
    Uniquely identifies the resource.
    isDefault Boolean
    Whether this is the default transit IP. true: Yes. false: No.
    natGatewayId String
    Private NAT gateway ID.
    natIp String
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    natIpDescription String
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    natIpId String
    Transit IP ID.
    natIpName String
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    status String
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    usingStatus String
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.

    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.