Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsVirtualEndpointGatewayIp
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IsVirtualEndpointGatewayIp

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, update, or delete a VPC endpoint gateway IP by using virtual endpoint gateway resource. For more information, about the VPC endpoint gateway, see about VPC gateways.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

    import * as pulumi from "@pulumi/pulumi";

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

    {}

    Example Usage

    The following example creates a Virtual Private Endpoint gateway IP.

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = new ibm.IsVirtualEndpointGatewayIp("example", {
    gateway: ibm_is_virtual_endpoint_gateway.example.id,
    reservedIp: ibm_is_subnet_reserved_ip.example.reserved_ip,
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.IsVirtualEndpointGatewayIp("example",
    gateway=ibm_is_virtual_endpoint_gateway["example"]["id"],
    reserved_ip=ibm_is_subnet_reserved_ip["example"]["reserved_ip"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIsVirtualEndpointGatewayIp(ctx, "example", &ibm.IsVirtualEndpointGatewayIpArgs{
			Gateway:    pulumi.Any(ibm_is_virtual_endpoint_gateway.Example.Id),
			ReservedIp: pulumi.Any(ibm_is_subnet_reserved_ip.Example.Reserved_ip),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = new Ibm.IsVirtualEndpointGatewayIp("example", new()
    {
        Gateway = ibm_is_virtual_endpoint_gateway.Example.Id,
        ReservedIp = ibm_is_subnet_reserved_ip.Example.Reserved_ip,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVirtualEndpointGatewayIp;
import com.pulumi.ibm.IsVirtualEndpointGatewayIpArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new IsVirtualEndpointGatewayIp("example", IsVirtualEndpointGatewayIpArgs.builder()
            .gateway(ibm_is_virtual_endpoint_gateway.example().id())
            .reservedIp(ibm_is_subnet_reserved_ip.example().reserved_ip())
            .build());

    }
}

    resources:
  example:
    type: ibm:IsVirtualEndpointGatewayIp
    properties:
      gateway: ${ibm_is_virtual_endpoint_gateway.example.id}
      reservedIp: ${ibm_is_subnet_reserved_ip.example.reserved_ip}

    Create IsVirtualEndpointGatewayIp Resource

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

    Constructor syntax

    new IsVirtualEndpointGatewayIp(name: string, args: IsVirtualEndpointGatewayIpArgs, opts?: CustomResourceOptions);
    @overload
def IsVirtualEndpointGatewayIp(resource_name: str,
                               args: IsVirtualEndpointGatewayIpInitArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def IsVirtualEndpointGatewayIp(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               gateway: Optional[str] = None,
                               reserved_ip: Optional[str] = None,
                               is_virtual_endpoint_gateway_ip_id: Optional[str] = None,
                               timeouts: Optional[IsVirtualEndpointGatewayIpTimeoutsArgs] = None)
    func NewIsVirtualEndpointGatewayIp(ctx *Context, name string, args IsVirtualEndpointGatewayIpArgs, opts ...ResourceOption) (*IsVirtualEndpointGatewayIp, error)
    public IsVirtualEndpointGatewayIp(string name, IsVirtualEndpointGatewayIpArgs args, CustomResourceOptions? opts = null)
    public IsVirtualEndpointGatewayIp(String name, IsVirtualEndpointGatewayIpArgs args)
public IsVirtualEndpointGatewayIp(String name, IsVirtualEndpointGatewayIpArgs args, CustomResourceOptions options)

    type: ibm:IsVirtualEndpointGatewayIp
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 IsVirtualEndpointGatewayIpArgs
    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 IsVirtualEndpointGatewayIpInitArgs
    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 IsVirtualEndpointGatewayIpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsVirtualEndpointGatewayIpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsVirtualEndpointGatewayIpArgs
    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 isVirtualEndpointGatewayIpResource = new Ibm.IsVirtualEndpointGatewayIp("isVirtualEndpointGatewayIpResource", new()
{
    Gateway = "string",
    ReservedIp = "string",
    IsVirtualEndpointGatewayIpId = "string",
    Timeouts = new Ibm.Inputs.IsVirtualEndpointGatewayIpTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewIsVirtualEndpointGatewayIp(ctx, "isVirtualEndpointGatewayIpResource", &ibm.IsVirtualEndpointGatewayIpArgs{
	Gateway:                      pulumi.String("string"),
	ReservedIp:                   pulumi.String("string"),
	IsVirtualEndpointGatewayIpId: pulumi.String("string"),
	Timeouts: &ibm.IsVirtualEndpointGatewayIpTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var isVirtualEndpointGatewayIpResource = new IsVirtualEndpointGatewayIp("isVirtualEndpointGatewayIpResource", IsVirtualEndpointGatewayIpArgs.builder()
    .gateway("string")
    .reservedIp("string")
    .isVirtualEndpointGatewayIpId("string")
    .timeouts(IsVirtualEndpointGatewayIpTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    is_virtual_endpoint_gateway_ip_resource = ibm.IsVirtualEndpointGatewayIp("isVirtualEndpointGatewayIpResource",
    gateway="string",
    reserved_ip="string",
    is_virtual_endpoint_gateway_ip_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const isVirtualEndpointGatewayIpResource = new ibm.IsVirtualEndpointGatewayIp("isVirtualEndpointGatewayIpResource", {
    gateway: "string",
    reservedIp: "string",
    isVirtualEndpointGatewayIpId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:IsVirtualEndpointGatewayIp
properties:
    gateway: string
    isVirtualEndpointGatewayIpId: string
    reservedIp: string
    timeouts:
        create: string
        delete: string
        update: string

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

    Gateway string
    The endpoint gateway ID.
    ReservedIp string
    Endpoint gateway IP id
    IsVirtualEndpointGatewayIpId string
    (String) The IPs target ID.
    Timeouts IsVirtualEndpointGatewayIpTimeouts
    Gateway string
    The endpoint gateway ID.
    ReservedIp string
    Endpoint gateway IP id
    IsVirtualEndpointGatewayIpId string
    (String) The IPs target ID.
    Timeouts IsVirtualEndpointGatewayIpTimeoutsArgs
    gateway String
    The endpoint gateway ID.
    reservedIp String
    Endpoint gateway IP id
    isVirtualEndpointGatewayIpId String
    (String) The IPs target ID.
    timeouts IsVirtualEndpointGatewayIpTimeouts
    gateway string
    The endpoint gateway ID.
    reservedIp string
    Endpoint gateway IP id
    isVirtualEndpointGatewayIpId string
    (String) The IPs target ID.
    timeouts IsVirtualEndpointGatewayIpTimeouts
    gateway str
    The endpoint gateway ID.
    reserved_ip str
    Endpoint gateway IP id
    is_virtual_endpoint_gateway_ip_id str
    (String) The IPs target ID.
    timeouts IsVirtualEndpointGatewayIpTimeoutsArgs
    gateway String
    The endpoint gateway ID.
    reservedIp String
    Endpoint gateway IP id
    isVirtualEndpointGatewayIpId String
    (String) The IPs target ID.
    timeouts Property Map

    Outputs

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

    Address string
    (String) The endpoint gateway IP address.
    AutoDelete bool
    (String) The endpoint gateway IP auto delete.
    CreatedAt string
    (Timestamp) The created date and time of the endpoint gateway IP.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (String) The IPs target name.
    ResourceType string
    (String) The endpoint gateway resource type.
    Targets List<IsVirtualEndpointGatewayIpTarget>
    (List) The endpoint gateway target details.
    Address string
    (String) The endpoint gateway IP address.
    AutoDelete bool
    (String) The endpoint gateway IP auto delete.
    CreatedAt string
    (Timestamp) The created date and time of the endpoint gateway IP.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (String) The IPs target name.
    ResourceType string
    (String) The endpoint gateway resource type.
    Targets []IsVirtualEndpointGatewayIpTarget
    (List) The endpoint gateway target details.
    address String
    (String) The endpoint gateway IP address.
    autoDelete Boolean
    (String) The endpoint gateway IP auto delete.
    createdAt String
    (Timestamp) The created date and time of the endpoint gateway IP.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (String) The IPs target name.
    resourceType String
    (String) The endpoint gateway resource type.
    targets List<IsVirtualEndpointGatewayIpTarget>
    (List) The endpoint gateway target details.
    address string
    (String) The endpoint gateway IP address.
    autoDelete boolean
    (String) The endpoint gateway IP auto delete.
    createdAt string
    (Timestamp) The created date and time of the endpoint gateway IP.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (String) The IPs target name.
    resourceType string
    (String) The endpoint gateway resource type.
    targets IsVirtualEndpointGatewayIpTarget[]
    (List) The endpoint gateway target details.
    address str
    (String) The endpoint gateway IP address.
    auto_delete bool
    (String) The endpoint gateway IP auto delete.
    created_at str
    (Timestamp) The created date and time of the endpoint gateway IP.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (String) The IPs target name.
    resource_type str
    (String) The endpoint gateway resource type.
    targets Sequence[IsVirtualEndpointGatewayIpTarget]
    (List) The endpoint gateway target details.
    address String
    (String) The endpoint gateway IP address.
    autoDelete Boolean
    (String) The endpoint gateway IP auto delete.
    createdAt String
    (Timestamp) The created date and time of the endpoint gateway IP.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (String) The IPs target name.
    resourceType String
    (String) The endpoint gateway resource type.
    targets List<Property Map>
    (List) The endpoint gateway target details.

    Look up Existing IsVirtualEndpointGatewayIp Resource

    Get an existing IsVirtualEndpointGatewayIp 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?: IsVirtualEndpointGatewayIpState, opts?: CustomResourceOptions): IsVirtualEndpointGatewayIp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        auto_delete: Optional[bool] = None,
        created_at: Optional[str] = None,
        gateway: Optional[str] = None,
        is_virtual_endpoint_gateway_ip_id: Optional[str] = None,
        name: Optional[str] = None,
        reserved_ip: Optional[str] = None,
        resource_type: Optional[str] = None,
        targets: Optional[Sequence[IsVirtualEndpointGatewayIpTargetArgs]] = None,
        timeouts: Optional[IsVirtualEndpointGatewayIpTimeoutsArgs] = None) -> IsVirtualEndpointGatewayIp
    func GetIsVirtualEndpointGatewayIp(ctx *Context, name string, id IDInput, state *IsVirtualEndpointGatewayIpState, opts ...ResourceOption) (*IsVirtualEndpointGatewayIp, error)
    public static IsVirtualEndpointGatewayIp Get(string name, Input<string> id, IsVirtualEndpointGatewayIpState? state, CustomResourceOptions? opts = null)
    public static IsVirtualEndpointGatewayIp get(String name, Output<String> id, IsVirtualEndpointGatewayIpState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsVirtualEndpointGatewayIp    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:
    Address string
    (String) The endpoint gateway IP address.
    AutoDelete bool
    (String) The endpoint gateway IP auto delete.
    CreatedAt string
    (Timestamp) The created date and time of the endpoint gateway IP.
    Gateway string
    The endpoint gateway ID.
    IsVirtualEndpointGatewayIpId string
    (String) The IPs target ID.
    Name string
    (String) The IPs target name.
    ReservedIp string
    Endpoint gateway IP id
    ResourceType string
    (String) The endpoint gateway resource type.
    Targets List<IsVirtualEndpointGatewayIpTarget>
    (List) The endpoint gateway target details.
    Timeouts IsVirtualEndpointGatewayIpTimeouts
    Address string
    (String) The endpoint gateway IP address.
    AutoDelete bool
    (String) The endpoint gateway IP auto delete.
    CreatedAt string
    (Timestamp) The created date and time of the endpoint gateway IP.
    Gateway string
    The endpoint gateway ID.
    IsVirtualEndpointGatewayIpId string
    (String) The IPs target ID.
    Name string
    (String) The IPs target name.
    ReservedIp string
    Endpoint gateway IP id
    ResourceType string
    (String) The endpoint gateway resource type.
    Targets []IsVirtualEndpointGatewayIpTargetArgs
    (List) The endpoint gateway target details.
    Timeouts IsVirtualEndpointGatewayIpTimeoutsArgs
    address String
    (String) The endpoint gateway IP address.
    autoDelete Boolean
    (String) The endpoint gateway IP auto delete.
    createdAt String
    (Timestamp) The created date and time of the endpoint gateway IP.
    gateway String
    The endpoint gateway ID.
    isVirtualEndpointGatewayIpId String
    (String) The IPs target ID.
    name String
    (String) The IPs target name.
    reservedIp String
    Endpoint gateway IP id
    resourceType String
    (String) The endpoint gateway resource type.
    targets List<IsVirtualEndpointGatewayIpTarget>
    (List) The endpoint gateway target details.
    timeouts IsVirtualEndpointGatewayIpTimeouts
    address string
    (String) The endpoint gateway IP address.
    autoDelete boolean
    (String) The endpoint gateway IP auto delete.
    createdAt string
    (Timestamp) The created date and time of the endpoint gateway IP.
    gateway string
    The endpoint gateway ID.
    isVirtualEndpointGatewayIpId string
    (String) The IPs target ID.
    name string
    (String) The IPs target name.
    reservedIp string
    Endpoint gateway IP id
    resourceType string
    (String) The endpoint gateway resource type.
    targets IsVirtualEndpointGatewayIpTarget[]
    (List) The endpoint gateway target details.
    timeouts IsVirtualEndpointGatewayIpTimeouts
    address str
    (String) The endpoint gateway IP address.
    auto_delete bool
    (String) The endpoint gateway IP auto delete.
    created_at str
    (Timestamp) The created date and time of the endpoint gateway IP.
    gateway str
    The endpoint gateway ID.
    is_virtual_endpoint_gateway_ip_id str
    (String) The IPs target ID.
    name str
    (String) The IPs target name.
    reserved_ip str
    Endpoint gateway IP id
    resource_type str
    (String) The endpoint gateway resource type.
    targets Sequence[IsVirtualEndpointGatewayIpTargetArgs]
    (List) The endpoint gateway target details.
    timeouts IsVirtualEndpointGatewayIpTimeoutsArgs
    address String
    (String) The endpoint gateway IP address.
    autoDelete Boolean
    (String) The endpoint gateway IP auto delete.
    createdAt String
    (Timestamp) The created date and time of the endpoint gateway IP.
    gateway String
    The endpoint gateway ID.
    isVirtualEndpointGatewayIpId String
    (String) The IPs target ID.
    name String
    (String) The IPs target name.
    reservedIp String
    Endpoint gateway IP id
    resourceType String
    (String) The endpoint gateway resource type.
    targets List<Property Map>
    (List) The endpoint gateway target details.
    timeouts Property Map

    Supporting Types

    IsVirtualEndpointGatewayIpTarget, IsVirtualEndpointGatewayIpTargetArgs

    Id string
    (String) The IPs target ID.
    Name string
    (String) The IPs target name.
    ResourceType string
    (String) The endpoint gateway resource type.
    Id string
    (String) The IPs target ID.
    Name string
    (String) The IPs target name.
    ResourceType string
    (String) The endpoint gateway resource type.
    id String
    (String) The IPs target ID.
    name String
    (String) The IPs target name.
    resourceType String
    (String) The endpoint gateway resource type.
    id string
    (String) The IPs target ID.
    name string
    (String) The IPs target name.
    resourceType string
    (String) The endpoint gateway resource type.
    id str
    (String) The IPs target ID.
    name str
    (String) The IPs target name.
    resource_type str
    (String) The endpoint gateway resource type.
    id String
    (String) The IPs target ID.
    name String
    (String) The IPs target name.
    resourceType String
    (String) The endpoint gateway resource type.

    IsVirtualEndpointGatewayIpTimeouts, IsVirtualEndpointGatewayIpTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    The ibm_is_virtual_endpoint_gateway_ip resource can be imported by using virtual endpoint gateway ID and gateway IP ID.

    Example

    $ pulumi import ibm:index/isVirtualEndpointGatewayIp:IsVirtualEndpointGatewayIp example d7bec597-4726-451f-8a63-e62e6f19c32c/d7bec597-4726-451f-8a63-e62e6f19d35f

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm