Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsVirtualEndpointGateway
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IsVirtualEndpointGateway

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

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

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";
Copy
import pulumi
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
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) {
    }
}
Copy
{}
Copy

Example Usage

The following example, creates a Virtual Private Endpoint gateway.

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

const example = new ibm.IsVirtualEndpointGateway("example", {
    target: {
        name: "ibm-ntp-server",
        resourceType: "provider_infrastructure_service",
    },
    vpc: ibm_is_vpc.example.id,
    resourceGroup: data.ibm_resource_group.example.id,
    securityGroups: [ibm_is_security_group.example.id],
});
const example1 = new ibm.IsVirtualEndpointGateway("example1", {
    target: {
        name: "ibm-ntp-server",
        resourceType: "provider_infrastructure_service",
    },
    vpc: ibm_is_vpc.example.id,
    ips: [{
        subnet: ibm_is_subnet.example.id,
        name: "example-reserved-ip",
    }],
    resourceGroup: data.ibm_resource_group.example.id,
    securityGroups: [ibm_is_security_group.example.id],
});
const example3 = new ibm.IsVirtualEndpointGateway("example3", {
    target: {
        name: "ibm-ntp-server",
        resourceType: "provider_infrastructure_service",
    },
    vpc: ibm_is_vpc.example.id,
    ips: [{
        subnet: ibm_is_subnet.example.id,
        name: "example-reserved-ip",
    }],
    resourceGroup: data.ibm_resource_group.example.id,
    securityGroups: [ibm_is_security_group.example.id],
});
const example4 = new ibm.IsVirtualEndpointGateway("example4", {
    target: {
        crn: "crn:v1:bluemix:public:cloud-object-storage:global:::endpoint:s3.direct.mil01.cloud-object-storage.appdomain.cloud",
        resourceType: "provider_cloud_service",
    },
    vpc: ibm_is_vpc.example.id,
    resourceGroup: data.ibm_resource_group.example.id,
    securityGroups: [ibm_is_security_group.example.id],
});
// Create endpoint gateway with target as private path service gateway
const example5 = new ibm.IsVirtualEndpointGateway("example5", {
    target: {
        crn: "crn:v1:bluemix:public:is:us-south:a/123456::private-path-service-gateway:r134-fb880975-db45-4459-8548-64e3995ac213",
        resourceType: "private_path_service_gateway",
    },
    vpc: ibm_is_vpc.example.id,
    resourceGroup: data.ibm_resource_group.example.id,
    securityGroups: [ibm_is_security_group.example.id],
});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.IsVirtualEndpointGateway("example",
    target={
        "name": "ibm-ntp-server",
        "resource_type": "provider_infrastructure_service",
    },
    vpc=ibm_is_vpc["example"]["id"],
    resource_group=data["ibm_resource_group"]["example"]["id"],
    security_groups=[ibm_is_security_group["example"]["id"]])
example1 = ibm.IsVirtualEndpointGateway("example1",
    target={
        "name": "ibm-ntp-server",
        "resource_type": "provider_infrastructure_service",
    },
    vpc=ibm_is_vpc["example"]["id"],
    ips=[{
        "subnet": ibm_is_subnet["example"]["id"],
        "name": "example-reserved-ip",
    }],
    resource_group=data["ibm_resource_group"]["example"]["id"],
    security_groups=[ibm_is_security_group["example"]["id"]])
example3 = ibm.IsVirtualEndpointGateway("example3",
    target={
        "name": "ibm-ntp-server",
        "resource_type": "provider_infrastructure_service",
    },
    vpc=ibm_is_vpc["example"]["id"],
    ips=[{
        "subnet": ibm_is_subnet["example"]["id"],
        "name": "example-reserved-ip",
    }],
    resource_group=data["ibm_resource_group"]["example"]["id"],
    security_groups=[ibm_is_security_group["example"]["id"]])
example4 = ibm.IsVirtualEndpointGateway("example4",
    target={
        "crn": "crn:v1:bluemix:public:cloud-object-storage:global:::endpoint:s3.direct.mil01.cloud-object-storage.appdomain.cloud",
        "resource_type": "provider_cloud_service",
    },
    vpc=ibm_is_vpc["example"]["id"],
    resource_group=data["ibm_resource_group"]["example"]["id"],
    security_groups=[ibm_is_security_group["example"]["id"]])
# Create endpoint gateway with target as private path service gateway
example5 = ibm.IsVirtualEndpointGateway("example5",
    target={
        "crn": "crn:v1:bluemix:public:is:us-south:a/123456::private-path-service-gateway:r134-fb880975-db45-4459-8548-64e3995ac213",
        "resource_type": "private_path_service_gateway",
    },
    vpc=ibm_is_vpc["example"]["id"],
    resource_group=data["ibm_resource_group"]["example"]["id"],
    security_groups=[ibm_is_security_group["example"]["id"]])
Copy
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.NewIsVirtualEndpointGateway(ctx, "example", &ibm.IsVirtualEndpointGatewayArgs{
			Target: &ibm.IsVirtualEndpointGatewayTargetArgs{
				Name:         pulumi.String("ibm-ntp-server"),
				ResourceType: pulumi.String("provider_infrastructure_service"),
			},
			Vpc:           pulumi.Any(ibm_is_vpc.Example.Id),
			ResourceGroup: pulumi.Any(data.Ibm_resource_group.Example.Id),
			SecurityGroups: pulumi.StringArray{
				ibm_is_security_group.Example.Id,
			},
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsVirtualEndpointGateway(ctx, "example1", &ibm.IsVirtualEndpointGatewayArgs{
			Target: &ibm.IsVirtualEndpointGatewayTargetArgs{
				Name:         pulumi.String("ibm-ntp-server"),
				ResourceType: pulumi.String("provider_infrastructure_service"),
			},
			Vpc: pulumi.Any(ibm_is_vpc.Example.Id),
			Ips: ibm.IsVirtualEndpointGatewayIpTypeArray{
				&ibm.IsVirtualEndpointGatewayIpTypeArgs{
					Subnet: pulumi.Any(ibm_is_subnet.Example.Id),
					Name:   pulumi.String("example-reserved-ip"),
				},
			},
			ResourceGroup: pulumi.Any(data.Ibm_resource_group.Example.Id),
			SecurityGroups: pulumi.StringArray{
				ibm_is_security_group.Example.Id,
			},
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsVirtualEndpointGateway(ctx, "example3", &ibm.IsVirtualEndpointGatewayArgs{
			Target: &ibm.IsVirtualEndpointGatewayTargetArgs{
				Name:         pulumi.String("ibm-ntp-server"),
				ResourceType: pulumi.String("provider_infrastructure_service"),
			},
			Vpc: pulumi.Any(ibm_is_vpc.Example.Id),
			Ips: ibm.IsVirtualEndpointGatewayIpTypeArray{
				&ibm.IsVirtualEndpointGatewayIpTypeArgs{
					Subnet: pulumi.Any(ibm_is_subnet.Example.Id),
					Name:   pulumi.String("example-reserved-ip"),
				},
			},
			ResourceGroup: pulumi.Any(data.Ibm_resource_group.Example.Id),
			SecurityGroups: pulumi.StringArray{
				ibm_is_security_group.Example.Id,
			},
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsVirtualEndpointGateway(ctx, "example4", &ibm.IsVirtualEndpointGatewayArgs{
			Target: &ibm.IsVirtualEndpointGatewayTargetArgs{
				Crn:          pulumi.String("crn:v1:bluemix:public:cloud-object-storage:global:::endpoint:s3.direct.mil01.cloud-object-storage.appdomain.cloud"),
				ResourceType: pulumi.String("provider_cloud_service"),
			},
			Vpc:           pulumi.Any(ibm_is_vpc.Example.Id),
			ResourceGroup: pulumi.Any(data.Ibm_resource_group.Example.Id),
			SecurityGroups: pulumi.StringArray{
				ibm_is_security_group.Example.Id,
			},
		})
		if err != nil {
			return err
		}
		// Create endpoint gateway with target as private path service gateway
		_, err = ibm.NewIsVirtualEndpointGateway(ctx, "example5", &ibm.IsVirtualEndpointGatewayArgs{
			Target: &ibm.IsVirtualEndpointGatewayTargetArgs{
				Crn:          pulumi.String("crn:v1:bluemix:public:is:us-south:a/123456::private-path-service-gateway:r134-fb880975-db45-4459-8548-64e3995ac213"),
				ResourceType: pulumi.String("private_path_service_gateway"),
			},
			Vpc:           pulumi.Any(ibm_is_vpc.Example.Id),
			ResourceGroup: pulumi.Any(data.Ibm_resource_group.Example.Id),
			SecurityGroups: pulumi.StringArray{
				ibm_is_security_group.Example.Id,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = new Ibm.IsVirtualEndpointGateway("example", new()
    {
        Target = new Ibm.Inputs.IsVirtualEndpointGatewayTargetArgs
        {
            Name = "ibm-ntp-server",
            ResourceType = "provider_infrastructure_service",
        },
        Vpc = ibm_is_vpc.Example.Id,
        ResourceGroup = data.Ibm_resource_group.Example.Id,
        SecurityGroups = new[]
        {
            ibm_is_security_group.Example.Id,
        },
    });

    var example1 = new Ibm.IsVirtualEndpointGateway("example1", new()
    {
        Target = new Ibm.Inputs.IsVirtualEndpointGatewayTargetArgs
        {
            Name = "ibm-ntp-server",
            ResourceType = "provider_infrastructure_service",
        },
        Vpc = ibm_is_vpc.Example.Id,
        Ips = new[]
        {
            new Ibm.Inputs.IsVirtualEndpointGatewayIpArgs
            {
                Subnet = ibm_is_subnet.Example.Id,
                Name = "example-reserved-ip",
            },
        },
        ResourceGroup = data.Ibm_resource_group.Example.Id,
        SecurityGroups = new[]
        {
            ibm_is_security_group.Example.Id,
        },
    });

    var example3 = new Ibm.IsVirtualEndpointGateway("example3", new()
    {
        Target = new Ibm.Inputs.IsVirtualEndpointGatewayTargetArgs
        {
            Name = "ibm-ntp-server",
            ResourceType = "provider_infrastructure_service",
        },
        Vpc = ibm_is_vpc.Example.Id,
        Ips = new[]
        {
            new Ibm.Inputs.IsVirtualEndpointGatewayIpArgs
            {
                Subnet = ibm_is_subnet.Example.Id,
                Name = "example-reserved-ip",
            },
        },
        ResourceGroup = data.Ibm_resource_group.Example.Id,
        SecurityGroups = new[]
        {
            ibm_is_security_group.Example.Id,
        },
    });

    var example4 = new Ibm.IsVirtualEndpointGateway("example4", new()
    {
        Target = new Ibm.Inputs.IsVirtualEndpointGatewayTargetArgs
        {
            Crn = "crn:v1:bluemix:public:cloud-object-storage:global:::endpoint:s3.direct.mil01.cloud-object-storage.appdomain.cloud",
            ResourceType = "provider_cloud_service",
        },
        Vpc = ibm_is_vpc.Example.Id,
        ResourceGroup = data.Ibm_resource_group.Example.Id,
        SecurityGroups = new[]
        {
            ibm_is_security_group.Example.Id,
        },
    });

    // Create endpoint gateway with target as private path service gateway
    var example5 = new Ibm.IsVirtualEndpointGateway("example5", new()
    {
        Target = new Ibm.Inputs.IsVirtualEndpointGatewayTargetArgs
        {
            Crn = "crn:v1:bluemix:public:is:us-south:a/123456::private-path-service-gateway:r134-fb880975-db45-4459-8548-64e3995ac213",
            ResourceType = "private_path_service_gateway",
        },
        Vpc = ibm_is_vpc.Example.Id,
        ResourceGroup = data.Ibm_resource_group.Example.Id,
        SecurityGroups = new[]
        {
            ibm_is_security_group.Example.Id,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVirtualEndpointGateway;
import com.pulumi.ibm.IsVirtualEndpointGatewayArgs;
import com.pulumi.ibm.inputs.IsVirtualEndpointGatewayTargetArgs;
import com.pulumi.ibm.inputs.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 IsVirtualEndpointGateway("example", IsVirtualEndpointGatewayArgs.builder()
            .target(IsVirtualEndpointGatewayTargetArgs.builder()
                .name("ibm-ntp-server")
                .resourceType("provider_infrastructure_service")
                .build())
            .vpc(ibm_is_vpc.example().id())
            .resourceGroup(data.ibm_resource_group().example().id())
            .securityGroups(ibm_is_security_group.example().id())
            .build());

        var example1 = new IsVirtualEndpointGateway("example1", IsVirtualEndpointGatewayArgs.builder()
            .target(IsVirtualEndpointGatewayTargetArgs.builder()
                .name("ibm-ntp-server")
                .resourceType("provider_infrastructure_service")
                .build())
            .vpc(ibm_is_vpc.example().id())
            .ips(IsVirtualEndpointGatewayIpArgs.builder()
                .subnet(ibm_is_subnet.example().id())
                .name("example-reserved-ip")
                .build())
            .resourceGroup(data.ibm_resource_group().example().id())
            .securityGroups(ibm_is_security_group.example().id())
            .build());

        var example3 = new IsVirtualEndpointGateway("example3", IsVirtualEndpointGatewayArgs.builder()
            .target(IsVirtualEndpointGatewayTargetArgs.builder()
                .name("ibm-ntp-server")
                .resourceType("provider_infrastructure_service")
                .build())
            .vpc(ibm_is_vpc.example().id())
            .ips(IsVirtualEndpointGatewayIpArgs.builder()
                .subnet(ibm_is_subnet.example().id())
                .name("example-reserved-ip")
                .build())
            .resourceGroup(data.ibm_resource_group().example().id())
            .securityGroups(ibm_is_security_group.example().id())
            .build());

        var example4 = new IsVirtualEndpointGateway("example4", IsVirtualEndpointGatewayArgs.builder()
            .target(IsVirtualEndpointGatewayTargetArgs.builder()
                .crn("crn:v1:bluemix:public:cloud-object-storage:global:::endpoint:s3.direct.mil01.cloud-object-storage.appdomain.cloud")
                .resourceType("provider_cloud_service")
                .build())
            .vpc(ibm_is_vpc.example().id())
            .resourceGroup(data.ibm_resource_group().example().id())
            .securityGroups(ibm_is_security_group.example().id())
            .build());

        // Create endpoint gateway with target as private path service gateway
        var example5 = new IsVirtualEndpointGateway("example5", IsVirtualEndpointGatewayArgs.builder()
            .target(IsVirtualEndpointGatewayTargetArgs.builder()
                .crn("crn:v1:bluemix:public:is:us-south:a/123456::private-path-service-gateway:r134-fb880975-db45-4459-8548-64e3995ac213")
                .resourceType("private_path_service_gateway")
                .build())
            .vpc(ibm_is_vpc.example().id())
            .resourceGroup(data.ibm_resource_group().example().id())
            .securityGroups(ibm_is_security_group.example().id())
            .build());

    }
}
Copy
resources:
  example:
    type: ibm:IsVirtualEndpointGateway
    properties:
      target:
        name: ibm-ntp-server
        resourceType: provider_infrastructure_service
      vpc: ${ibm_is_vpc.example.id}
      resourceGroup: ${data.ibm_resource_group.example.id}
      securityGroups:
        - ${ibm_is_security_group.example.id}
  example1:
    type: ibm:IsVirtualEndpointGateway
    properties:
      target:
        name: ibm-ntp-server
        resourceType: provider_infrastructure_service
      vpc: ${ibm_is_vpc.example.id}
      ips:
        - subnet: ${ibm_is_subnet.example.id}
          name: example-reserved-ip
      resourceGroup: ${data.ibm_resource_group.example.id}
      securityGroups:
        - ${ibm_is_security_group.example.id}
  example3:
    type: ibm:IsVirtualEndpointGateway
    properties:
      target:
        name: ibm-ntp-server
        resourceType: provider_infrastructure_service
      vpc: ${ibm_is_vpc.example.id}
      ips:
        - subnet: ${ibm_is_subnet.example.id}
          name: example-reserved-ip
      resourceGroup: ${data.ibm_resource_group.example.id}
      securityGroups:
        - ${ibm_is_security_group.example.id}
  example4:
    type: ibm:IsVirtualEndpointGateway
    properties:
      target:
        crn: crn:v1:bluemix:public:cloud-object-storage:global:::endpoint:s3.direct.mil01.cloud-object-storage.appdomain.cloud
        resourceType: provider_cloud_service
      vpc: ${ibm_is_vpc.example.id}
      resourceGroup: ${data.ibm_resource_group.example.id}
      securityGroups:
        - ${ibm_is_security_group.example.id}
  # Create endpoint gateway with target as private path service gateway
  example5:
    type: ibm:IsVirtualEndpointGateway
    properties:
      target:
        crn: crn:v1:bluemix:public:is:us-south:a/123456::private-path-service-gateway:r134-fb880975-db45-4459-8548-64e3995ac213
        resourceType: private_path_service_gateway
      vpc: ${ibm_is_vpc.example.id}
      resourceGroup: ${data.ibm_resource_group.example.id}
      securityGroups:
        - ${ibm_is_security_group.example.id}
Copy

Create IsVirtualEndpointGateway Resource

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

Constructor syntax

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

@overload
def IsVirtualEndpointGateway(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             target: Optional[IsVirtualEndpointGatewayTargetArgs] = None,
                             vpc: Optional[str] = None,
                             access_tags: Optional[Sequence[str]] = None,
                             allow_dns_resolution_binding: Optional[bool] = None,
                             ips: Optional[Sequence[IsVirtualEndpointGatewayIpArgs]] = None,
                             is_virtual_endpoint_gateway_id: Optional[str] = None,
                             name: Optional[str] = None,
                             resource_group: Optional[str] = None,
                             security_groups: Optional[Sequence[str]] = None,
                             tags: Optional[Sequence[str]] = None,
                             timeouts: Optional[IsVirtualEndpointGatewayTimeoutsArgs] = None)
func NewIsVirtualEndpointGateway(ctx *Context, name string, args IsVirtualEndpointGatewayArgs, opts ...ResourceOption) (*IsVirtualEndpointGateway, error)
public IsVirtualEndpointGateway(string name, IsVirtualEndpointGatewayArgs args, CustomResourceOptions? opts = null)
public IsVirtualEndpointGateway(String name, IsVirtualEndpointGatewayArgs args)
public IsVirtualEndpointGateway(String name, IsVirtualEndpointGatewayArgs args, CustomResourceOptions options)

type: ibm:IsVirtualEndpointGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IsVirtualEndpointGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IsVirtualEndpointGatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IsVirtualEndpointGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IsVirtualEndpointGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IsVirtualEndpointGatewayArgs
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 isVirtualEndpointGatewayResource = new Ibm.IsVirtualEndpointGateway("isVirtualEndpointGatewayResource", new()
{
    Target = new Ibm.Inputs.IsVirtualEndpointGatewayTargetArgs
    {
        ResourceType = "string",
        Crn = "string",
        Name = "string",
    },
    Vpc = "string",
    AccessTags = new[]
    {
        "string",
    },
    AllowDnsResolutionBinding = false,
    Ips = new[]
    {
        new Ibm.Inputs.IsVirtualEndpointGatewayIpArgs
        {
            Address = "string",
            Id = "string",
            Name = "string",
            ResourceType = "string",
            Subnet = "string",
        },
    },
    IsVirtualEndpointGatewayId = "string",
    Name = "string",
    ResourceGroup = "string",
    SecurityGroups = new[]
    {
        "string",
    },
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.IsVirtualEndpointGatewayTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := ibm.NewIsVirtualEndpointGateway(ctx, "isVirtualEndpointGatewayResource", &ibm.IsVirtualEndpointGatewayArgs{
Target: &.IsVirtualEndpointGatewayTargetArgs{
ResourceType: pulumi.String("string"),
Crn: pulumi.String("string"),
Name: pulumi.String("string"),
},
Vpc: pulumi.String("string"),
AccessTags: pulumi.StringArray{
pulumi.String("string"),
},
AllowDnsResolutionBinding: pulumi.Bool(false),
Ips: .IsVirtualEndpointGatewayIpTypeArray{
&.IsVirtualEndpointGatewayIpTypeArgs{
Address: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceType: pulumi.String("string"),
Subnet: pulumi.String("string"),
},
},
IsVirtualEndpointGatewayId: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceGroup: pulumi.String("string"),
SecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &.IsVirtualEndpointGatewayTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var isVirtualEndpointGatewayResource = new IsVirtualEndpointGateway("isVirtualEndpointGatewayResource", IsVirtualEndpointGatewayArgs.builder()
    .target(IsVirtualEndpointGatewayTargetArgs.builder()
        .resourceType("string")
        .crn("string")
        .name("string")
        .build())
    .vpc("string")
    .accessTags("string")
    .allowDnsResolutionBinding(false)
    .ips(IsVirtualEndpointGatewayIpArgs.builder()
        .address("string")
        .id("string")
        .name("string")
        .resourceType("string")
        .subnet("string")
        .build())
    .isVirtualEndpointGatewayId("string")
    .name("string")
    .resourceGroup("string")
    .securityGroups("string")
    .tags("string")
    .timeouts(IsVirtualEndpointGatewayTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
is_virtual_endpoint_gateway_resource = ibm.IsVirtualEndpointGateway("isVirtualEndpointGatewayResource",
    target={
        "resource_type": "string",
        "crn": "string",
        "name": "string",
    },
    vpc="string",
    access_tags=["string"],
    allow_dns_resolution_binding=False,
    ips=[{
        "address": "string",
        "id": "string",
        "name": "string",
        "resource_type": "string",
        "subnet": "string",
    }],
    is_virtual_endpoint_gateway_id="string",
    name="string",
    resource_group="string",
    security_groups=["string"],
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const isVirtualEndpointGatewayResource = new ibm.IsVirtualEndpointGateway("isVirtualEndpointGatewayResource", {
    target: {
        resourceType: "string",
        crn: "string",
        name: "string",
    },
    vpc: "string",
    accessTags: ["string"],
    allowDnsResolutionBinding: false,
    ips: [{
        address: "string",
        id: "string",
        name: "string",
        resourceType: "string",
        subnet: "string",
    }],
    isVirtualEndpointGatewayId: "string",
    name: "string",
    resourceGroup: "string",
    securityGroups: ["string"],
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: ibm:IsVirtualEndpointGateway
properties:
    accessTags:
        - string
    allowDnsResolutionBinding: false
    ips:
        - address: string
          id: string
          name: string
          resourceType: string
          subnet: string
    isVirtualEndpointGatewayId: string
    name: string
    resourceGroup: string
    securityGroups:
        - string
    tags:
        - string
    target:
        crn: string
        name: string
        resourceType: string
    timeouts:
        create: string
        delete: string
        update: string
    vpc: string
Copy

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

Target This property is required. IsVirtualEndpointGatewayTarget

The endpoint gateway target.

Nested scheme for target:

Vpc This property is required. string

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

AccessTags List<string>

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

AllowDnsResolutionBinding bool
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
Ips List<IsVirtualEndpointGatewayIp>

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

IsVirtualEndpointGatewayId string
The endpoint gateway resource group IPs ID.
Name string
The endpoint gateway name.
ResourceGroup string
The resource group ID.
SecurityGroups List<string>
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
Tags List<string>
A list of tags associated with the instance.
Timeouts IsVirtualEndpointGatewayTimeouts
Target This property is required. IsVirtualEndpointGatewayTargetArgs

The endpoint gateway target.

Nested scheme for target:

Vpc This property is required. string

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

AccessTags []string

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

AllowDnsResolutionBinding bool
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
Ips []IsVirtualEndpointGatewayIpTypeArgs

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

IsVirtualEndpointGatewayId string
The endpoint gateway resource group IPs ID.
Name string
The endpoint gateway name.
ResourceGroup string
The resource group ID.
SecurityGroups []string
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
Tags []string
A list of tags associated with the instance.
Timeouts IsVirtualEndpointGatewayTimeoutsArgs
target This property is required. IsVirtualEndpointGatewayTarget

The endpoint gateway target.

Nested scheme for target:

vpc This property is required. String

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

accessTags List<String>

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

allowDnsResolutionBinding Boolean
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
ips List<IsVirtualEndpointGatewayIp>

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

isVirtualEndpointGatewayId String
The endpoint gateway resource group IPs ID.
name String
The endpoint gateway name.
resourceGroup String
The resource group ID.
securityGroups List<String>
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
tags List<String>
A list of tags associated with the instance.
timeouts IsVirtualEndpointGatewayTimeouts
target This property is required. IsVirtualEndpointGatewayTarget

The endpoint gateway target.

Nested scheme for target:

vpc This property is required. string

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

accessTags string[]

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

allowDnsResolutionBinding boolean
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
ips IsVirtualEndpointGatewayIp[]

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

isVirtualEndpointGatewayId string
The endpoint gateway resource group IPs ID.
name string
The endpoint gateway name.
resourceGroup string
The resource group ID.
securityGroups string[]
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
tags string[]
A list of tags associated with the instance.
timeouts IsVirtualEndpointGatewayTimeouts
target This property is required. IsVirtualEndpointGatewayTargetArgs

The endpoint gateway target.

Nested scheme for target:

vpc This property is required. str

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

access_tags Sequence[str]

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

allow_dns_resolution_binding bool
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
ips Sequence[IsVirtualEndpointGatewayIpArgs]

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

is_virtual_endpoint_gateway_id str
The endpoint gateway resource group IPs ID.
name str
The endpoint gateway name.
resource_group str
The resource group ID.
security_groups Sequence[str]
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
tags Sequence[str]
A list of tags associated with the instance.
timeouts IsVirtualEndpointGatewayTimeoutsArgs
target This property is required. Property Map

The endpoint gateway target.

Nested scheme for target:

vpc This property is required. String

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

accessTags List<String>

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

allowDnsResolutionBinding Boolean
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
ips List<Property Map>

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

isVirtualEndpointGatewayId String
The endpoint gateway resource group IPs ID.
name String
The endpoint gateway name.
resourceGroup String
The resource group ID.
securityGroups List<String>
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
tags List<String>
A list of tags associated with the instance.
timeouts Property Map

Outputs

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

CreatedAt string
(Timestamp) The created date and time of the endpoint gateway.
Crn string
(String) The CRN for this endpoint gateway.
HealthState string
(String) The health state of the endpoint gateway.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleReasons List<IsVirtualEndpointGatewayLifecycleReason>
The reasons for the current lifecycle_state (if any).
LifecycleState string
(String) The lifecycle state of the endpoint gateway.
ResourceType string
(String) The endpoint gateway resource type.
ServiceEndpoints List<string>
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
CreatedAt string
(Timestamp) The created date and time of the endpoint gateway.
Crn string
(String) The CRN for this endpoint gateway.
HealthState string
(String) The health state of the endpoint gateway.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleReasons []IsVirtualEndpointGatewayLifecycleReason
The reasons for the current lifecycle_state (if any).
LifecycleState string
(String) The lifecycle state of the endpoint gateway.
ResourceType string
(String) The endpoint gateway resource type.
ServiceEndpoints []string
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
createdAt String
(Timestamp) The created date and time of the endpoint gateway.
crn String
(String) The CRN for this endpoint gateway.
healthState String
(String) The health state of the endpoint gateway.
id String
The provider-assigned unique ID for this managed resource.
lifecycleReasons List<IsVirtualEndpointGatewayLifecycleReason>
The reasons for the current lifecycle_state (if any).
lifecycleState String
(String) The lifecycle state of the endpoint gateway.
resourceType String
(String) The endpoint gateway resource type.
serviceEndpoints List<String>
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
createdAt string
(Timestamp) The created date and time of the endpoint gateway.
crn string
(String) The CRN for this endpoint gateway.
healthState string
(String) The health state of the endpoint gateway.
id string
The provider-assigned unique ID for this managed resource.
lifecycleReasons IsVirtualEndpointGatewayLifecycleReason[]
The reasons for the current lifecycle_state (if any).
lifecycleState string
(String) The lifecycle state of the endpoint gateway.
resourceType string
(String) The endpoint gateway resource type.
serviceEndpoints string[]
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
created_at str
(Timestamp) The created date and time of the endpoint gateway.
crn str
(String) The CRN for this endpoint gateway.
health_state str
(String) The health state of the endpoint gateway.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_reasons Sequence[IsVirtualEndpointGatewayLifecycleReason]
The reasons for the current lifecycle_state (if any).
lifecycle_state str
(String) The lifecycle state of the endpoint gateway.
resource_type str
(String) The endpoint gateway resource type.
service_endpoints Sequence[str]
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
createdAt String
(Timestamp) The created date and time of the endpoint gateway.
crn String
(String) The CRN for this endpoint gateway.
healthState String
(String) The health state of the endpoint gateway.
id String
The provider-assigned unique ID for this managed resource.
lifecycleReasons List<Property Map>
The reasons for the current lifecycle_state (if any).
lifecycleState String
(String) The lifecycle state of the endpoint gateway.
resourceType String
(String) The endpoint gateway resource type.
serviceEndpoints List<String>
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service

Look up Existing IsVirtualEndpointGateway Resource

Get an existing IsVirtualEndpointGateway 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?: IsVirtualEndpointGatewayState, opts?: CustomResourceOptions): IsVirtualEndpointGateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_tags: Optional[Sequence[str]] = None,
        allow_dns_resolution_binding: Optional[bool] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        health_state: Optional[str] = None,
        ips: Optional[Sequence[IsVirtualEndpointGatewayIpArgs]] = None,
        is_virtual_endpoint_gateway_id: Optional[str] = None,
        lifecycle_reasons: Optional[Sequence[IsVirtualEndpointGatewayLifecycleReasonArgs]] = None,
        lifecycle_state: Optional[str] = None,
        name: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_type: Optional[str] = None,
        security_groups: Optional[Sequence[str]] = None,
        service_endpoints: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[str]] = None,
        target: Optional[IsVirtualEndpointGatewayTargetArgs] = None,
        timeouts: Optional[IsVirtualEndpointGatewayTimeoutsArgs] = None,
        vpc: Optional[str] = None) -> IsVirtualEndpointGateway
func GetIsVirtualEndpointGateway(ctx *Context, name string, id IDInput, state *IsVirtualEndpointGatewayState, opts ...ResourceOption) (*IsVirtualEndpointGateway, error)
public static IsVirtualEndpointGateway Get(string name, Input<string> id, IsVirtualEndpointGatewayState? state, CustomResourceOptions? opts = null)
public static IsVirtualEndpointGateway get(String name, Output<String> id, IsVirtualEndpointGatewayState state, CustomResourceOptions options)
resources:  _:    type: ibm:IsVirtualEndpointGateway    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccessTags List<string>

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

AllowDnsResolutionBinding bool
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
CreatedAt string
(Timestamp) The created date and time of the endpoint gateway.
Crn string
(String) The CRN for this endpoint gateway.
HealthState string
(String) The health state of the endpoint gateway.
Ips List<IsVirtualEndpointGatewayIp>

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

IsVirtualEndpointGatewayId string
The endpoint gateway resource group IPs ID.
LifecycleReasons List<IsVirtualEndpointGatewayLifecycleReason>
The reasons for the current lifecycle_state (if any).
LifecycleState string
(String) The lifecycle state of the endpoint gateway.
Name string
The endpoint gateway name.
ResourceGroup string
The resource group ID.
ResourceType string
(String) The endpoint gateway resource type.
SecurityGroups List<string>
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
ServiceEndpoints List<string>
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
Tags List<string>
A list of tags associated with the instance.
Target IsVirtualEndpointGatewayTarget

The endpoint gateway target.

Nested scheme for target:

Timeouts IsVirtualEndpointGatewayTimeouts
Vpc string

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

AccessTags []string

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

AllowDnsResolutionBinding bool
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
CreatedAt string
(Timestamp) The created date and time of the endpoint gateway.
Crn string
(String) The CRN for this endpoint gateway.
HealthState string
(String) The health state of the endpoint gateway.
Ips []IsVirtualEndpointGatewayIpTypeArgs

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

IsVirtualEndpointGatewayId string
The endpoint gateway resource group IPs ID.
LifecycleReasons []IsVirtualEndpointGatewayLifecycleReasonArgs
The reasons for the current lifecycle_state (if any).
LifecycleState string
(String) The lifecycle state of the endpoint gateway.
Name string
The endpoint gateway name.
ResourceGroup string
The resource group ID.
ResourceType string
(String) The endpoint gateway resource type.
SecurityGroups []string
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
ServiceEndpoints []string
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
Tags []string
A list of tags associated with the instance.
Target IsVirtualEndpointGatewayTargetArgs

The endpoint gateway target.

Nested scheme for target:

Timeouts IsVirtualEndpointGatewayTimeoutsArgs
Vpc string

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

accessTags List<String>

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

allowDnsResolutionBinding Boolean
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
createdAt String
(Timestamp) The created date and time of the endpoint gateway.
crn String
(String) The CRN for this endpoint gateway.
healthState String
(String) The health state of the endpoint gateway.
ips List<IsVirtualEndpointGatewayIp>

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

isVirtualEndpointGatewayId String
The endpoint gateway resource group IPs ID.
lifecycleReasons List<IsVirtualEndpointGatewayLifecycleReason>
The reasons for the current lifecycle_state (if any).
lifecycleState String
(String) The lifecycle state of the endpoint gateway.
name String
The endpoint gateway name.
resourceGroup String
The resource group ID.
resourceType String
(String) The endpoint gateway resource type.
securityGroups List<String>
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
serviceEndpoints List<String>
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
tags List<String>
A list of tags associated with the instance.
target IsVirtualEndpointGatewayTarget

The endpoint gateway target.

Nested scheme for target:

timeouts IsVirtualEndpointGatewayTimeouts
vpc String

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

accessTags string[]

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

allowDnsResolutionBinding boolean
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
createdAt string
(Timestamp) The created date and time of the endpoint gateway.
crn string
(String) The CRN for this endpoint gateway.
healthState string
(String) The health state of the endpoint gateway.
ips IsVirtualEndpointGatewayIp[]

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

isVirtualEndpointGatewayId string
The endpoint gateway resource group IPs ID.
lifecycleReasons IsVirtualEndpointGatewayLifecycleReason[]
The reasons for the current lifecycle_state (if any).
lifecycleState string
(String) The lifecycle state of the endpoint gateway.
name string
The endpoint gateway name.
resourceGroup string
The resource group ID.
resourceType string
(String) The endpoint gateway resource type.
securityGroups string[]
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
serviceEndpoints string[]
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
tags string[]
A list of tags associated with the instance.
target IsVirtualEndpointGatewayTarget

The endpoint gateway target.

Nested scheme for target:

timeouts IsVirtualEndpointGatewayTimeouts
vpc string

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

access_tags Sequence[str]

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

allow_dns_resolution_binding bool
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
created_at str
(Timestamp) The created date and time of the endpoint gateway.
crn str
(String) The CRN for this endpoint gateway.
health_state str
(String) The health state of the endpoint gateway.
ips Sequence[IsVirtualEndpointGatewayIpArgs]

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

is_virtual_endpoint_gateway_id str
The endpoint gateway resource group IPs ID.
lifecycle_reasons Sequence[IsVirtualEndpointGatewayLifecycleReasonArgs]
The reasons for the current lifecycle_state (if any).
lifecycle_state str
(String) The lifecycle state of the endpoint gateway.
name str
The endpoint gateway name.
resource_group str
The resource group ID.
resource_type str
(String) The endpoint gateway resource type.
security_groups Sequence[str]
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
service_endpoints Sequence[str]
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
tags Sequence[str]
A list of tags associated with the instance.
target IsVirtualEndpointGatewayTargetArgs

The endpoint gateway target.

Nested scheme for target:

timeouts IsVirtualEndpointGatewayTimeoutsArgs
vpc str

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

accessTags List<String>

A list of access management tags to attach to the virtual endpoint gateway.

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

allowDnsResolutionBinding Boolean
Indicates whether to allow this endpoint gateway to participate in DNS resolution bindings with a VPC that has dns.enable_hub set to true.
createdAt String
(Timestamp) The created date and time of the endpoint gateway.
crn String
(String) The CRN for this endpoint gateway.
healthState String
(String) The health state of the endpoint gateway.
ips List<Property Map>

The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.

Nested scheme for ips:

isVirtualEndpointGatewayId String
The endpoint gateway resource group IPs ID.
lifecycleReasons List<Property Map>
The reasons for the current lifecycle_state (if any).
lifecycleState String
(String) The lifecycle state of the endpoint gateway.
name String
The endpoint gateway name.
resourceGroup String
The resource group ID.
resourceType String
(String) The endpoint gateway resource type.
securityGroups List<String>
The security groups to use for this endpoint gateway. If unspecified, the VPC's default security group is used. NOTE: either of ibm.IsSecurityGroupTarget resource or security_groups attribute should be used, both can't be use together.
serviceEndpoints List<String>
(Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
tags List<String>
A list of tags associated with the instance.
target Property Map

The endpoint gateway target.

Nested scheme for target:

timeouts Property Map
vpc String

The VPC ID.

NOTE: ips configured inline in this resource are not modifiable. Prefer using ibm.IsVirtualEndpointGatewayIp resource to bind/unbind new reserved IPs to endpoint gateways and use the resource ibm.IsSubnetReservedIp to create new reserved IP.

Supporting Types

IsVirtualEndpointGatewayIp
, IsVirtualEndpointGatewayIpArgs

Address string
The endpoint gateway IPs Address.
Id string
The unique identifier for this reserved IP. Conflicts with other properties (name, subnet)
Name string
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated list of randomly-selected words.
ResourceType string
(String) The endpoint gateway resource type.
Subnet string

The subnet in which to create this reserved IP.

NOTE: id and (name, subnet) are mutually exclusive.

Address string
The endpoint gateway IPs Address.
Id string
The unique identifier for this reserved IP. Conflicts with other properties (name, subnet)
Name string
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated list of randomly-selected words.
ResourceType string
(String) The endpoint gateway resource type.
Subnet string

The subnet in which to create this reserved IP.

NOTE: id and (name, subnet) are mutually exclusive.

address String
The endpoint gateway IPs Address.
id String
The unique identifier for this reserved IP. Conflicts with other properties (name, subnet)
name String
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated list of randomly-selected words.
resourceType String
(String) The endpoint gateway resource type.
subnet String

The subnet in which to create this reserved IP.

NOTE: id and (name, subnet) are mutually exclusive.

address string
The endpoint gateway IPs Address.
id string
The unique identifier for this reserved IP. Conflicts with other properties (name, subnet)
name string
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated list of randomly-selected words.
resourceType string
(String) The endpoint gateway resource type.
subnet string

The subnet in which to create this reserved IP.

NOTE: id and (name, subnet) are mutually exclusive.

address str
The endpoint gateway IPs Address.
id str
The unique identifier for this reserved IP. Conflicts with other properties (name, subnet)
name str
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated list of randomly-selected words.
resource_type str
(String) The endpoint gateway resource type.
subnet str

The subnet in which to create this reserved IP.

NOTE: id and (name, subnet) are mutually exclusive.

address String
The endpoint gateway IPs Address.
id String
The unique identifier for this reserved IP. Conflicts with other properties (name, subnet)
name String
The name for this reserved IP. The name must not be used by another reserved IP in the subnet. Names starting with ibm- are reserved for provider-owned resources, and are not allowed. If unspecified, the name will be a hyphenated list of randomly-selected words.
resourceType String
(String) The endpoint gateway resource type.
subnet String

The subnet in which to create this reserved IP.

NOTE: id and (name, subnet) are mutually exclusive.

IsVirtualEndpointGatewayLifecycleReason
, IsVirtualEndpointGatewayLifecycleReasonArgs

Code This property is required. string
Message This property is required. string
MoreInfo This property is required. string
Code This property is required. string
Message This property is required. string
MoreInfo This property is required. string
code This property is required. String
message This property is required. String
moreInfo This property is required. String
code This property is required. string
message This property is required. string
moreInfo This property is required. string
code This property is required. str
message This property is required. str
more_info This property is required. str
code This property is required. String
message This property is required. String
moreInfo This property is required. String

IsVirtualEndpointGatewayTarget
, IsVirtualEndpointGatewayTargetArgs

ResourceType This property is required. string
The endpoint gateway target resource type. The possible values are provider_cloud_service, provider_infrastructure_service and private_path_service_gateway.
Crn string

The CRN for this provider cloud service, or the CRN for the user's instance of a provider cloud service.

NOTE: If crn is not specified, name must be specified.

Name string

The endpoint gateway target name.

NOTE: If name is not specified, crn must be specified.

ResourceType This property is required. string
The endpoint gateway target resource type. The possible values are provider_cloud_service, provider_infrastructure_service and private_path_service_gateway.
Crn string

The CRN for this provider cloud service, or the CRN for the user's instance of a provider cloud service.

NOTE: If crn is not specified, name must be specified.

Name string

The endpoint gateway target name.

NOTE: If name is not specified, crn must be specified.

resourceType This property is required. String
The endpoint gateway target resource type. The possible values are provider_cloud_service, provider_infrastructure_service and private_path_service_gateway.
crn String

The CRN for this provider cloud service, or the CRN for the user's instance of a provider cloud service.

NOTE: If crn is not specified, name must be specified.

name String

The endpoint gateway target name.

NOTE: If name is not specified, crn must be specified.

resourceType This property is required. string
The endpoint gateway target resource type. The possible values are provider_cloud_service, provider_infrastructure_service and private_path_service_gateway.
crn string

The CRN for this provider cloud service, or the CRN for the user's instance of a provider cloud service.

NOTE: If crn is not specified, name must be specified.

name string

The endpoint gateway target name.

NOTE: If name is not specified, crn must be specified.

resource_type This property is required. str
The endpoint gateway target resource type. The possible values are provider_cloud_service, provider_infrastructure_service and private_path_service_gateway.
crn str

The CRN for this provider cloud service, or the CRN for the user's instance of a provider cloud service.

NOTE: If crn is not specified, name must be specified.

name str

The endpoint gateway target name.

NOTE: If name is not specified, crn must be specified.

resourceType This property is required. String
The endpoint gateway target resource type. The possible values are provider_cloud_service, provider_infrastructure_service and private_path_service_gateway.
crn String

The CRN for this provider cloud service, or the CRN for the user's instance of a provider cloud service.

NOTE: If crn is not specified, name must be specified.

name String

The endpoint gateway target name.

NOTE: If name is not specified, crn must be specified.

IsVirtualEndpointGatewayTimeouts
, IsVirtualEndpointGatewayTimeoutsArgs

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 resource can be imported by using virtual endpoint gateway ID.

Example

$ pulumi import ibm:index/isVirtualEndpointGateway:IsVirtualEndpointGateway example d7bec597-4726-451f-8a63-xxxxsdf345
Copy

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 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm