ibm.IsVirtualEndpointGateway
Explore with Pulumi AI
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";
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.
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],
});
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"]])
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
})
}
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,
},
});
});
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());
}
}
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}
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 string
- The unique name of the resource.
- args IsVirtualEndpointGatewayArgs
- 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 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 string
- The unique name of the resource.
- args IsVirtualEndpointGatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IsVirtualEndpointGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
},
});
example, err := ibm.NewIsVirtualEndpointGateway(ctx, "isVirtualEndpointGatewayResource", &ibm.IsVirtualEndpointGatewayArgs{
Target: &ibm.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: ibm.IsVirtualEndpointGatewayIpTypeArray{
&ibm.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: &ibm.IsVirtualEndpointGatewayTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
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());
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",
})
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",
},
});
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
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
Is
Virtual Endpoint Gateway Target The endpoint gateway target.
Nested scheme for
target
:- Vpc string
The VPC ID.
NOTE:
ips
configured inline in this resource are not modifiable. Prefer usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.IsSubnetReservedIp
to create new reserved IP.- 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 formatkey:value
.- Allow
Dns boolResolution Binding - 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<Is
Virtual Endpoint Gateway Ip> The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.
Nested scheme for
ips
:- Is
Virtual stringEndpoint Gateway Id - The endpoint gateway resource group IPs ID.
- Name string
- The endpoint gateway name.
- Resource
Group string - The resource group ID.
- Security
Groups 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 orsecurity_groups
attribute should be used, both can't be use together. - List<string>
- A list of tags associated with the instance.
- Timeouts
Is
Virtual Endpoint Gateway Timeouts
- Target
Is
Virtual Endpoint Gateway Target Args The endpoint gateway target.
Nested scheme for
target
:- Vpc string
The VPC ID.
NOTE:
ips
configured inline in this resource are not modifiable. Prefer usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.IsSubnetReservedIp
to create new reserved IP.- []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 formatkey:value
.- Allow
Dns boolResolution Binding - 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
[]Is
Virtual Endpoint Gateway Ip Type Args The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.
Nested scheme for
ips
:- Is
Virtual stringEndpoint Gateway Id - The endpoint gateway resource group IPs ID.
- Name string
- The endpoint gateway name.
- Resource
Group string - The resource group ID.
- Security
Groups []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 orsecurity_groups
attribute should be used, both can't be use together. - []string
- A list of tags associated with the instance.
- Timeouts
Is
Virtual Endpoint Gateway Timeouts Args
- target
Is
Virtual Endpoint Gateway Target The endpoint gateway target.
Nested scheme for
target
:- vpc String
The VPC ID.
NOTE:
ips
configured inline in this resource are not modifiable. Prefer usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.IsSubnetReservedIp
to create new reserved IP.- 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 formatkey:value
.- allow
Dns BooleanResolution Binding - 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<Is
Virtual Endpoint Gateway Ip> The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.
Nested scheme for
ips
:- is
Virtual StringEndpoint Gateway Id - The endpoint gateway resource group IPs ID.
- name String
- The endpoint gateway name.
- resource
Group String - The resource group ID.
- security
Groups 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 orsecurity_groups
attribute should be used, both can't be use together. - List<String>
- A list of tags associated with the instance.
- timeouts
Is
Virtual Endpoint Gateway Timeouts
- target
Is
Virtual Endpoint Gateway Target The endpoint gateway target.
Nested scheme for
target
:- vpc string
The VPC ID.
NOTE:
ips
configured inline in this resource are not modifiable. Prefer usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.IsSubnetReservedIp
to create new reserved IP.- 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 formatkey:value
.- allow
Dns booleanResolution Binding - 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
Is
Virtual Endpoint Gateway Ip[] The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.
Nested scheme for
ips
:- is
Virtual stringEndpoint Gateway Id - The endpoint gateway resource group IPs ID.
- name string
- The endpoint gateway name.
- resource
Group string - The resource group ID.
- security
Groups 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 orsecurity_groups
attribute should be used, both can't be use together. - string[]
- A list of tags associated with the instance.
- timeouts
Is
Virtual Endpoint Gateway Timeouts
- target
Is
Virtual Endpoint Gateway Target Args The endpoint gateway target.
Nested scheme for
target
:- vpc str
The VPC ID.
NOTE:
ips
configured inline in this resource are not modifiable. Prefer usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.IsSubnetReservedIp
to create new reserved IP.- 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 formatkey:value
.- allow_
dns_ boolresolution_ binding - 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[Is
Virtual Endpoint Gateway Ip Args] The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.
Nested scheme for
ips
:- is_
virtual_ strendpoint_ gateway_ id - 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 orsecurity_groups
attribute should be used, both can't be use together. - Sequence[str]
- A list of tags associated with the instance.
- timeouts
Is
Virtual Endpoint Gateway Timeouts Args
- target Property Map
The endpoint gateway target.
Nested scheme for
target
:- vpc String
The VPC ID.
NOTE:
ips
configured inline in this resource are not modifiable. Prefer usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.IsSubnetReservedIp
to create new reserved IP.- 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 formatkey:value
.- allow
Dns BooleanResolution Binding - 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
:- is
Virtual StringEndpoint Gateway Id - The endpoint gateway resource group IPs ID.
- name String
- The endpoint gateway name.
- resource
Group String - The resource group ID.
- security
Groups 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 orsecurity_groups
attribute should be used, both can't be use together. - 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:
- Created
At string - (Timestamp) The created date and time of the endpoint gateway.
- Crn string
- (String) The CRN for this endpoint gateway.
- Health
State string - (String) The health state of the endpoint gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Reasons List<IsVirtual Endpoint Gateway Lifecycle Reason> - The reasons for the current lifecycle_state (if any).
- Lifecycle
State string - (String) The lifecycle state of the endpoint gateway.
- Resource
Type string - (String) The endpoint gateway resource type.
- Service
Endpoints List<string> - (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
- Created
At string - (Timestamp) The created date and time of the endpoint gateway.
- Crn string
- (String) The CRN for this endpoint gateway.
- Health
State string - (String) The health state of the endpoint gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Reasons []IsVirtual Endpoint Gateway Lifecycle Reason - The reasons for the current lifecycle_state (if any).
- Lifecycle
State string - (String) The lifecycle state of the endpoint gateway.
- Resource
Type string - (String) The endpoint gateway resource type.
- Service
Endpoints []string - (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
- created
At String - (Timestamp) The created date and time of the endpoint gateway.
- crn String
- (String) The CRN for this endpoint gateway.
- health
State String - (String) The health state of the endpoint gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Reasons List<IsVirtual Endpoint Gateway Lifecycle Reason> - The reasons for the current lifecycle_state (if any).
- lifecycle
State String - (String) The lifecycle state of the endpoint gateway.
- resource
Type String - (String) The endpoint gateway resource type.
- service
Endpoints List<String> - (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
- created
At string - (Timestamp) The created date and time of the endpoint gateway.
- crn string
- (String) The CRN for this endpoint gateway.
- health
State string - (String) The health state of the endpoint gateway.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Reasons IsVirtual Endpoint Gateway Lifecycle Reason[] - The reasons for the current lifecycle_state (if any).
- lifecycle
State string - (String) The lifecycle state of the endpoint gateway.
- resource
Type string - (String) The endpoint gateway resource type.
- service
Endpoints 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[IsVirtual Endpoint Gateway Lifecycle Reason] - 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
- created
At String - (Timestamp) The created date and time of the endpoint gateway.
- crn String
- (String) The CRN for this endpoint gateway.
- health
State String - (String) The health state of the endpoint gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Reasons List<Property Map> - The reasons for the current lifecycle_state (if any).
- lifecycle
State String - (String) The lifecycle state of the endpoint gateway.
- resource
Type String - (String) The endpoint gateway resource type.
- service
Endpoints 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
- 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.
- 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 formatkey:value
.- Allow
Dns boolResolution Binding - 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 string - (Timestamp) The created date and time of the endpoint gateway.
- Crn string
- (String) The CRN for this endpoint gateway.
- Health
State string - (String) The health state of the endpoint gateway.
- Ips
List<Is
Virtual Endpoint Gateway Ip> The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.
Nested scheme for
ips
:- Is
Virtual stringEndpoint Gateway Id - The endpoint gateway resource group IPs ID.
- Lifecycle
Reasons List<IsVirtual Endpoint Gateway Lifecycle Reason> - The reasons for the current lifecycle_state (if any).
- Lifecycle
State string - (String) The lifecycle state of the endpoint gateway.
- Name string
- The endpoint gateway name.
- Resource
Group string - The resource group ID.
- Resource
Type string - (String) The endpoint gateway resource type.
- Security
Groups 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 orsecurity_groups
attribute should be used, both can't be use together. - Service
Endpoints List<string> - (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
- List<string>
- A list of tags associated with the instance.
- Target
Is
Virtual Endpoint Gateway Target The endpoint gateway target.
Nested scheme for
target
:- Timeouts
Is
Virtual Endpoint Gateway Timeouts - Vpc string
The VPC ID.
NOTE:
ips
configured inline in this resource are not modifiable. Prefer usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.IsSubnetReservedIp
to create new reserved IP.
- []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 formatkey:value
.- Allow
Dns boolResolution Binding - 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 string - (Timestamp) The created date and time of the endpoint gateway.
- Crn string
- (String) The CRN for this endpoint gateway.
- Health
State string - (String) The health state of the endpoint gateway.
- Ips
[]Is
Virtual Endpoint Gateway Ip Type Args The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.
Nested scheme for
ips
:- Is
Virtual stringEndpoint Gateway Id - The endpoint gateway resource group IPs ID.
- Lifecycle
Reasons []IsVirtual Endpoint Gateway Lifecycle Reason Args - The reasons for the current lifecycle_state (if any).
- Lifecycle
State string - (String) The lifecycle state of the endpoint gateway.
- Name string
- The endpoint gateway name.
- Resource
Group string - The resource group ID.
- Resource
Type string - (String) The endpoint gateway resource type.
- Security
Groups []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 orsecurity_groups
attribute should be used, both can't be use together. - Service
Endpoints []string - (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
- []string
- A list of tags associated with the instance.
- Target
Is
Virtual Endpoint Gateway Target Args The endpoint gateway target.
Nested scheme for
target
:- Timeouts
Is
Virtual Endpoint Gateway Timeouts Args - Vpc string
The VPC ID.
NOTE:
ips
configured inline in this resource are not modifiable. Prefer usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.IsSubnetReservedIp
to create new reserved IP.
- 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 formatkey:value
.- allow
Dns BooleanResolution Binding - 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 String - (Timestamp) The created date and time of the endpoint gateway.
- crn String
- (String) The CRN for this endpoint gateway.
- health
State String - (String) The health state of the endpoint gateway.
- ips
List<Is
Virtual Endpoint Gateway Ip> The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.
Nested scheme for
ips
:- is
Virtual StringEndpoint Gateway Id - The endpoint gateway resource group IPs ID.
- lifecycle
Reasons List<IsVirtual Endpoint Gateway Lifecycle Reason> - The reasons for the current lifecycle_state (if any).
- lifecycle
State String - (String) The lifecycle state of the endpoint gateway.
- name String
- The endpoint gateway name.
- resource
Group String - The resource group ID.
- resource
Type String - (String) The endpoint gateway resource type.
- security
Groups 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 orsecurity_groups
attribute should be used, both can't be use together. - service
Endpoints List<String> - (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
- List<String>
- A list of tags associated with the instance.
- target
Is
Virtual Endpoint Gateway Target The endpoint gateway target.
Nested scheme for
target
:- timeouts
Is
Virtual Endpoint Gateway Timeouts - vpc String
The VPC ID.
NOTE:
ips
configured inline in this resource are not modifiable. Prefer usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.IsSubnetReservedIp
to create new reserved IP.
- 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 formatkey:value
.- allow
Dns booleanResolution Binding - 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 string - (Timestamp) The created date and time of the endpoint gateway.
- crn string
- (String) The CRN for this endpoint gateway.
- health
State string - (String) The health state of the endpoint gateway.
- ips
Is
Virtual Endpoint Gateway Ip[] The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.
Nested scheme for
ips
:- is
Virtual stringEndpoint Gateway Id - The endpoint gateway resource group IPs ID.
- lifecycle
Reasons IsVirtual Endpoint Gateway Lifecycle Reason[] - The reasons for the current lifecycle_state (if any).
- lifecycle
State string - (String) The lifecycle state of the endpoint gateway.
- name string
- The endpoint gateway name.
- resource
Group string - The resource group ID.
- resource
Type string - (String) The endpoint gateway resource type.
- security
Groups 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 orsecurity_groups
attribute should be used, both can't be use together. - service
Endpoints string[] - (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
- string[]
- A list of tags associated with the instance.
- target
Is
Virtual Endpoint Gateway Target The endpoint gateway target.
Nested scheme for
target
:- timeouts
Is
Virtual Endpoint Gateway Timeouts - vpc string
The VPC ID.
NOTE:
ips
configured inline in this resource are not modifiable. Prefer usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.IsSubnetReservedIp
to create new reserved IP.
- 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 formatkey:value
.- allow_
dns_ boolresolution_ binding - 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[Is
Virtual Endpoint Gateway Ip Args] The reserved IPs to bind to this endpoint gateway. At most one reserved IP per zone is allowed.
Nested scheme for
ips
:- is_
virtual_ strendpoint_ gateway_ id - The endpoint gateway resource group IPs ID.
- lifecycle_
reasons Sequence[IsVirtual Endpoint Gateway Lifecycle Reason Args] - 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 orsecurity_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
- Sequence[str]
- A list of tags associated with the instance.
- target
Is
Virtual Endpoint Gateway Target Args The endpoint gateway target.
Nested scheme for
target
:- timeouts
Is
Virtual Endpoint Gateway Timeouts Args - vpc str
The VPC ID.
NOTE:
ips
configured inline in this resource are not modifiable. Prefer usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.IsSubnetReservedIp
to create new reserved IP.
- 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 formatkey:value
.- allow
Dns BooleanResolution Binding - 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 String - (Timestamp) The created date and time of the endpoint gateway.
- crn String
- (String) The CRN for this endpoint gateway.
- health
State 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
:- is
Virtual StringEndpoint Gateway Id - The endpoint gateway resource group IPs ID.
- lifecycle
Reasons List<Property Map> - The reasons for the current lifecycle_state (if any).
- lifecycle
State String - (String) The lifecycle state of the endpoint gateway.
- name String
- The endpoint gateway name.
- resource
Group String - The resource group ID.
- resource
Type String - (String) The endpoint gateway resource type.
- security
Groups 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 orsecurity_groups
attribute should be used, both can't be use together. - service
Endpoints List<String> - (Array of Strings) The fully qualified domain names for the target service. A fully qualified domain name for the target service
- 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 usingibm.IsVirtualEndpointGatewayIp
resource to bind/unbind new reserved IPs to endpoint gateways and use the resourceibm.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.
- Resource
Type 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.
- Resource
Type 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.
- resource
Type 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.
- resource
Type 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.
- resource
Type 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
IsVirtualEndpointGatewayTarget, IsVirtualEndpointGatewayTargetArgs
- Resource
Type string - The endpoint gateway target resource type. The possible values are
provider_cloud_service
,provider_infrastructure_service
andprivate_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 string - The endpoint gateway target resource type. The possible values are
provider_cloud_service
,provider_infrastructure_service
andprivate_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 String - The endpoint gateway target resource type. The possible values are
provider_cloud_service
,provider_infrastructure_service
andprivate_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 string - The endpoint gateway target resource type. The possible values are
provider_cloud_service
,provider_infrastructure_service
andprivate_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 str - The endpoint gateway target resource type. The possible values are
provider_cloud_service
,provider_infrastructure_service
andprivate_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.
- resource
Type String - The endpoint gateway target resource type. The possible values are
provider_cloud_service
,provider_infrastructure_service
andprivate_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
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
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.