opentelekomcloud.VpcepServiceV1
Explore with Pulumi AI
Up-to-date reference of API arguments for VPCEP service you can get at documentation portal
Manages a VPC Endpoint Service v1 resource within OpenTelekomCloud.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const config = new pulumi.Config();
const osSubnetId = config.requireObject("osSubnetId");
const vpcId = config.requireObject("vpcId");
const domainId1 = config.requireObject("domainId1");
const domainId2 = config.requireObject("domainId2");
const lb1 = new opentelekomcloud.LbLoadbalancerV2("lb1", {vipSubnetId: osSubnetId});
const service = new opentelekomcloud.VpcepServiceV1("service", {
portId: lb1.vipPortId,
vpcId: vpcId,
serverType: "LB",
ports: [{
clientPort: 80,
serverPort: 8080,
}],
whitelists: [
domainId1,
domainId2,
],
tags: {
key: "value",
},
});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
config = pulumi.Config()
os_subnet_id = config.require_object("osSubnetId")
vpc_id = config.require_object("vpcId")
domain_id1 = config.require_object("domainId1")
domain_id2 = config.require_object("domainId2")
lb1 = opentelekomcloud.LbLoadbalancerV2("lb1", vip_subnet_id=os_subnet_id)
service = opentelekomcloud.VpcepServiceV1("service",
port_id=lb1.vip_port_id,
vpc_id=vpc_id,
server_type="LB",
ports=[{
"client_port": 80,
"server_port": 8080,
}],
whitelists=[
domain_id1,
domain_id2,
],
tags={
"key": "value",
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
osSubnetId := cfg.RequireObject("osSubnetId")
vpcId := cfg.RequireObject("vpcId")
domainId1 := cfg.RequireObject("domainId1")
domainId2 := cfg.RequireObject("domainId2")
lb1, err := opentelekomcloud.NewLbLoadbalancerV2(ctx, "lb1", &opentelekomcloud.LbLoadbalancerV2Args{
VipSubnetId: pulumi.Any(osSubnetId),
})
if err != nil {
return err
}
_, err = opentelekomcloud.NewVpcepServiceV1(ctx, "service", &opentelekomcloud.VpcepServiceV1Args{
PortId: lb1.VipPortId,
VpcId: pulumi.Any(vpcId),
ServerType: pulumi.String("LB"),
Ports: opentelekomcloud.VpcepServiceV1PortArray{
&opentelekomcloud.VpcepServiceV1PortArgs{
ClientPort: pulumi.Float64(80),
ServerPort: pulumi.Float64(8080),
},
},
Whitelists: pulumi.StringArray{
domainId1,
domainId2,
},
Tags: pulumi.StringMap{
"key": pulumi.String("value"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var osSubnetId = config.RequireObject<dynamic>("osSubnetId");
var vpcId = config.RequireObject<dynamic>("vpcId");
var domainId1 = config.RequireObject<dynamic>("domainId1");
var domainId2 = config.RequireObject<dynamic>("domainId2");
var lb1 = new Opentelekomcloud.LbLoadbalancerV2("lb1", new()
{
VipSubnetId = osSubnetId,
});
var service = new Opentelekomcloud.VpcepServiceV1("service", new()
{
PortId = lb1.VipPortId,
VpcId = vpcId,
ServerType = "LB",
Ports = new[]
{
new Opentelekomcloud.Inputs.VpcepServiceV1PortArgs
{
ClientPort = 80,
ServerPort = 8080,
},
},
Whitelists = new[]
{
domainId1,
domainId2,
},
Tags =
{
{ "key", "value" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.LbLoadbalancerV2;
import com.pulumi.opentelekomcloud.LbLoadbalancerV2Args;
import com.pulumi.opentelekomcloud.VpcepServiceV1;
import com.pulumi.opentelekomcloud.VpcepServiceV1Args;
import com.pulumi.opentelekomcloud.inputs.VpcepServiceV1PortArgs;
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) {
final var config = ctx.config();
final var osSubnetId = config.get("osSubnetId");
final var vpcId = config.get("vpcId");
final var domainId1 = config.get("domainId1");
final var domainId2 = config.get("domainId2");
var lb1 = new LbLoadbalancerV2("lb1", LbLoadbalancerV2Args.builder()
.vipSubnetId(osSubnetId)
.build());
var service = new VpcepServiceV1("service", VpcepServiceV1Args.builder()
.portId(lb1.vipPortId())
.vpcId(vpcId)
.serverType("LB")
.ports(VpcepServiceV1PortArgs.builder()
.clientPort(80)
.serverPort(8080)
.build())
.whitelists(
domainId1,
domainId2)
.tags(Map.of("key", "value"))
.build());
}
}
configuration:
osSubnetId:
type: dynamic
vpcId:
type: dynamic
domainId1:
type: dynamic
domainId2:
type: dynamic
resources:
lb1:
type: opentelekomcloud:LbLoadbalancerV2
properties:
vipSubnetId: ${osSubnetId}
service:
type: opentelekomcloud:VpcepServiceV1
properties:
portId: ${lb1.vipPortId}
vpcId: ${vpcId}
serverType: LB
ports:
- clientPort: 80
serverPort: 8080
whitelists:
- ${domainId1}
- ${domainId2}
tags:
key: value
Create VpcepServiceV1 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VpcepServiceV1(name: string, args: VpcepServiceV1Args, opts?: CustomResourceOptions);
@overload
def VpcepServiceV1(resource_name: str,
args: VpcepServiceV1Args,
opts: Optional[ResourceOptions] = None)
@overload
def VpcepServiceV1(resource_name: str,
opts: Optional[ResourceOptions] = None,
port_id: Optional[str] = None,
vpc_id: Optional[str] = None,
server_type: Optional[str] = None,
ports: Optional[Sequence[VpcepServiceV1PortArgs]] = None,
pool_id: Optional[str] = None,
approval_enabled: Optional[bool] = None,
name: Optional[str] = None,
service_type: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tcp_proxy: Optional[str] = None,
timeouts: Optional[VpcepServiceV1TimeoutsArgs] = None,
vip_port_id: Optional[str] = None,
description: Optional[str] = None,
vpcep_service_v1_id: Optional[str] = None,
whitelists: Optional[Sequence[str]] = None)
func NewVpcepServiceV1(ctx *Context, name string, args VpcepServiceV1Args, opts ...ResourceOption) (*VpcepServiceV1, error)
public VpcepServiceV1(string name, VpcepServiceV1Args args, CustomResourceOptions? opts = null)
public VpcepServiceV1(String name, VpcepServiceV1Args args)
public VpcepServiceV1(String name, VpcepServiceV1Args args, CustomResourceOptions options)
type: opentelekomcloud:VpcepServiceV1
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 VpcepServiceV1Args
- 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 VpcepServiceV1Args
- 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 VpcepServiceV1Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VpcepServiceV1Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VpcepServiceV1Args
- 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 vpcepServiceV1Resource = new Opentelekomcloud.VpcepServiceV1("vpcepServiceV1Resource", new()
{
PortId = "string",
VpcId = "string",
ServerType = "string",
Ports = new[]
{
new Opentelekomcloud.Inputs.VpcepServiceV1PortArgs
{
ClientPort = 0,
ServerPort = 0,
Protocol = "string",
},
},
PoolId = "string",
ApprovalEnabled = false,
Name = "string",
ServiceType = "string",
Tags =
{
{ "string", "string" },
},
TcpProxy = "string",
Timeouts = new Opentelekomcloud.Inputs.VpcepServiceV1TimeoutsArgs
{
Default = "string",
},
VipPortId = "string",
Description = "string",
VpcepServiceV1Id = "string",
Whitelists = new[]
{
"string",
},
});
example, err := opentelekomcloud.NewVpcepServiceV1(ctx, "vpcepServiceV1Resource", &opentelekomcloud.VpcepServiceV1Args{
PortId: pulumi.String("string"),
VpcId: pulumi.String("string"),
ServerType: pulumi.String("string"),
Ports: opentelekomcloud.VpcepServiceV1PortArray{
&opentelekomcloud.VpcepServiceV1PortArgs{
ClientPort: pulumi.Float64(0),
ServerPort: pulumi.Float64(0),
Protocol: pulumi.String("string"),
},
},
PoolId: pulumi.String("string"),
ApprovalEnabled: pulumi.Bool(false),
Name: pulumi.String("string"),
ServiceType: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TcpProxy: pulumi.String("string"),
Timeouts: &opentelekomcloud.VpcepServiceV1TimeoutsArgs{
Default: pulumi.String("string"),
},
VipPortId: pulumi.String("string"),
Description: pulumi.String("string"),
VpcepServiceV1Id: pulumi.String("string"),
Whitelists: pulumi.StringArray{
pulumi.String("string"),
},
})
var vpcepServiceV1Resource = new VpcepServiceV1("vpcepServiceV1Resource", VpcepServiceV1Args.builder()
.portId("string")
.vpcId("string")
.serverType("string")
.ports(VpcepServiceV1PortArgs.builder()
.clientPort(0)
.serverPort(0)
.protocol("string")
.build())
.poolId("string")
.approvalEnabled(false)
.name("string")
.serviceType("string")
.tags(Map.of("string", "string"))
.tcpProxy("string")
.timeouts(VpcepServiceV1TimeoutsArgs.builder()
.default_("string")
.build())
.vipPortId("string")
.description("string")
.vpcepServiceV1Id("string")
.whitelists("string")
.build());
vpcep_service_v1_resource = opentelekomcloud.VpcepServiceV1("vpcepServiceV1Resource",
port_id="string",
vpc_id="string",
server_type="string",
ports=[{
"client_port": 0,
"server_port": 0,
"protocol": "string",
}],
pool_id="string",
approval_enabled=False,
name="string",
service_type="string",
tags={
"string": "string",
},
tcp_proxy="string",
timeouts={
"default": "string",
},
vip_port_id="string",
description="string",
vpcep_service_v1_id="string",
whitelists=["string"])
const vpcepServiceV1Resource = new opentelekomcloud.VpcepServiceV1("vpcepServiceV1Resource", {
portId: "string",
vpcId: "string",
serverType: "string",
ports: [{
clientPort: 0,
serverPort: 0,
protocol: "string",
}],
poolId: "string",
approvalEnabled: false,
name: "string",
serviceType: "string",
tags: {
string: "string",
},
tcpProxy: "string",
timeouts: {
"default": "string",
},
vipPortId: "string",
description: "string",
vpcepServiceV1Id: "string",
whitelists: ["string"],
});
type: opentelekomcloud:VpcepServiceV1
properties:
approvalEnabled: false
description: string
name: string
poolId: string
portId: string
ports:
- clientPort: 0
protocol: string
serverPort: 0
serverType: string
serviceType: string
tags:
string: string
tcpProxy: string
timeouts:
default: string
vipPortId: string
vpcId: string
vpcepServiceV1Id: string
whitelists:
- string
VpcepServiceV1 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 VpcepServiceV1 resource accepts the following input properties:
- Port
Id string - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- Ports
List<Vpcep
Service V1Port> - Lists the port mappings opened to the VPC endpoint service. See below for the details.
- Server
Type string - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- Vpc
Id string - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- Approval
Enabled bool - Specifies whether connection approval is required.
- Description string
- Specifies the description of the VPC endpoint service.
- Name string
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- Pool
Id string - Specifies the ID of the cluster associated with the target VPCEP resource.
- Service
Type string Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- Dictionary<string, string>
- Map of the resource tags.
- Tcp
Proxy string Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- Timeouts
Vpcep
Service V1Timeouts - Vip
Port stringId - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- Vpcep
Service stringV1Id - ID of VPC endpoint service
- Whitelists List<string>
- Lists of domain IDs of target users.
- Port
Id string - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- Ports
[]Vpcep
Service V1Port Args - Lists the port mappings opened to the VPC endpoint service. See below for the details.
- Server
Type string - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- Vpc
Id string - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- Approval
Enabled bool - Specifies whether connection approval is required.
- Description string
- Specifies the description of the VPC endpoint service.
- Name string
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- Pool
Id string - Specifies the ID of the cluster associated with the target VPCEP resource.
- Service
Type string Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- map[string]string
- Map of the resource tags.
- Tcp
Proxy string Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- Timeouts
Vpcep
Service V1Timeouts Args - Vip
Port stringId - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- Vpcep
Service stringV1Id - ID of VPC endpoint service
- Whitelists []string
- Lists of domain IDs of target users.
- port
Id String - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- ports
List<Vpcep
Service V1Port> - Lists the port mappings opened to the VPC endpoint service. See below for the details.
- server
Type String - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- vpc
Id String - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- approval
Enabled Boolean - Specifies whether connection approval is required.
- description String
- Specifies the description of the VPC endpoint service.
- name String
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- pool
Id String - Specifies the ID of the cluster associated with the target VPCEP resource.
- service
Type String Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- Map<String,String>
- Map of the resource tags.
- tcp
Proxy String Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- timeouts
Vpcep
Service V1Timeouts - vip
Port StringId - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- vpcep
Service StringV1Id - ID of VPC endpoint service
- whitelists List<String>
- Lists of domain IDs of target users.
- port
Id string - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- ports
Vpcep
Service V1Port[] - Lists the port mappings opened to the VPC endpoint service. See below for the details.
- server
Type string - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- vpc
Id string - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- approval
Enabled boolean - Specifies whether connection approval is required.
- description string
- Specifies the description of the VPC endpoint service.
- name string
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- pool
Id string - Specifies the ID of the cluster associated with the target VPCEP resource.
- service
Type string Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- {[key: string]: string}
- Map of the resource tags.
- tcp
Proxy string Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- timeouts
Vpcep
Service V1Timeouts - vip
Port stringId - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- vpcep
Service stringV1Id - ID of VPC endpoint service
- whitelists string[]
- Lists of domain IDs of target users.
- port_
id str - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- ports
Sequence[Vpcep
Service V1Port Args] - Lists the port mappings opened to the VPC endpoint service. See below for the details.
- server_
type str - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- vpc_
id str - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- approval_
enabled bool - Specifies whether connection approval is required.
- description str
- Specifies the description of the VPC endpoint service.
- name str
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- pool_
id str - Specifies the ID of the cluster associated with the target VPCEP resource.
- service_
type str Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- Mapping[str, str]
- Map of the resource tags.
- tcp_
proxy str Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- timeouts
Vpcep
Service V1Timeouts Args - vip_
port_ strid - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- vpcep_
service_ strv1_ id - ID of VPC endpoint service
- whitelists Sequence[str]
- Lists of domain IDs of target users.
- port
Id String - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- ports List<Property Map>
- Lists the port mappings opened to the VPC endpoint service. See below for the details.
- server
Type String - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- vpc
Id String - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- approval
Enabled Boolean - Specifies whether connection approval is required.
- description String
- Specifies the description of the VPC endpoint service.
- name String
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- pool
Id String - Specifies the ID of the cluster associated with the target VPCEP resource.
- service
Type String Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- Map<String>
- Map of the resource tags.
- tcp
Proxy String Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- timeouts Property Map
- vip
Port StringId - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- vpcep
Service StringV1Id - ID of VPC endpoint service
- whitelists List<String>
- Lists of domain IDs of target users.
Outputs
All input properties are implicitly available as output properties. Additionally, the VpcepServiceV1 resource produces the following output properties:
- Connections
List<Vpcep
Service V1Connection> - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The connection status of the VPC endpoint.
- Connections
[]Vpcep
Service V1Connection - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The connection status of the VPC endpoint.
- connections
List<Vpcep
Service V1Connection> - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The connection status of the VPC endpoint.
- connections
Vpcep
Service V1Connection[] - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- id string
- The provider-assigned unique ID for this managed resource.
- status string
- The connection status of the VPC endpoint.
- connections
Sequence[Vpcep
Service V1Connection] - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- id str
- The provider-assigned unique ID for this managed resource.
- status str
- The connection status of the VPC endpoint.
- connections List<Property Map>
- An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The connection status of the VPC endpoint.
Look up Existing VpcepServiceV1 Resource
Get an existing VpcepServiceV1 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?: VpcepServiceV1State, opts?: CustomResourceOptions): VpcepServiceV1
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
approval_enabled: Optional[bool] = None,
connections: Optional[Sequence[VpcepServiceV1ConnectionArgs]] = None,
description: Optional[str] = None,
name: Optional[str] = None,
pool_id: Optional[str] = None,
port_id: Optional[str] = None,
ports: Optional[Sequence[VpcepServiceV1PortArgs]] = None,
server_type: Optional[str] = None,
service_type: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tcp_proxy: Optional[str] = None,
timeouts: Optional[VpcepServiceV1TimeoutsArgs] = None,
vip_port_id: Optional[str] = None,
vpc_id: Optional[str] = None,
vpcep_service_v1_id: Optional[str] = None,
whitelists: Optional[Sequence[str]] = None) -> VpcepServiceV1
func GetVpcepServiceV1(ctx *Context, name string, id IDInput, state *VpcepServiceV1State, opts ...ResourceOption) (*VpcepServiceV1, error)
public static VpcepServiceV1 Get(string name, Input<string> id, VpcepServiceV1State? state, CustomResourceOptions? opts = null)
public static VpcepServiceV1 get(String name, Output<String> id, VpcepServiceV1State state, CustomResourceOptions options)
resources: _: type: opentelekomcloud:VpcepServiceV1 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.
- Approval
Enabled bool - Specifies whether connection approval is required.
- Connections
List<Vpcep
Service V1Connection> - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- Description string
- Specifies the description of the VPC endpoint service.
- Name string
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- Pool
Id string - Specifies the ID of the cluster associated with the target VPCEP resource.
- Port
Id string - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- Ports
List<Vpcep
Service V1Port> - Lists the port mappings opened to the VPC endpoint service. See below for the details.
- Server
Type string - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- Service
Type string Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- Status string
- The connection status of the VPC endpoint.
- Dictionary<string, string>
- Map of the resource tags.
- Tcp
Proxy string Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- Timeouts
Vpcep
Service V1Timeouts - Vip
Port stringId - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- Vpc
Id string - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- Vpcep
Service stringV1Id - ID of VPC endpoint service
- Whitelists List<string>
- Lists of domain IDs of target users.
- Approval
Enabled bool - Specifies whether connection approval is required.
- Connections
[]Vpcep
Service V1Connection Args - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- Description string
- Specifies the description of the VPC endpoint service.
- Name string
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- Pool
Id string - Specifies the ID of the cluster associated with the target VPCEP resource.
- Port
Id string - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- Ports
[]Vpcep
Service V1Port Args - Lists the port mappings opened to the VPC endpoint service. See below for the details.
- Server
Type string - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- Service
Type string Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- Status string
- The connection status of the VPC endpoint.
- map[string]string
- Map of the resource tags.
- Tcp
Proxy string Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- Timeouts
Vpcep
Service V1Timeouts Args - Vip
Port stringId - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- Vpc
Id string - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- Vpcep
Service stringV1Id - ID of VPC endpoint service
- Whitelists []string
- Lists of domain IDs of target users.
- approval
Enabled Boolean - Specifies whether connection approval is required.
- connections
List<Vpcep
Service V1Connection> - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- description String
- Specifies the description of the VPC endpoint service.
- name String
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- pool
Id String - Specifies the ID of the cluster associated with the target VPCEP resource.
- port
Id String - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- ports
List<Vpcep
Service V1Port> - Lists the port mappings opened to the VPC endpoint service. See below for the details.
- server
Type String - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- service
Type String Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- status String
- The connection status of the VPC endpoint.
- Map<String,String>
- Map of the resource tags.
- tcp
Proxy String Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- timeouts
Vpcep
Service V1Timeouts - vip
Port StringId - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- vpc
Id String - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- vpcep
Service StringV1Id - ID of VPC endpoint service
- whitelists List<String>
- Lists of domain IDs of target users.
- approval
Enabled boolean - Specifies whether connection approval is required.
- connections
Vpcep
Service V1Connection[] - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- description string
- Specifies the description of the VPC endpoint service.
- name string
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- pool
Id string - Specifies the ID of the cluster associated with the target VPCEP resource.
- port
Id string - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- ports
Vpcep
Service V1Port[] - Lists the port mappings opened to the VPC endpoint service. See below for the details.
- server
Type string - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- service
Type string Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- status string
- The connection status of the VPC endpoint.
- {[key: string]: string}
- Map of the resource tags.
- tcp
Proxy string Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- timeouts
Vpcep
Service V1Timeouts - vip
Port stringId - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- vpc
Id string - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- vpcep
Service stringV1Id - ID of VPC endpoint service
- whitelists string[]
- Lists of domain IDs of target users.
- approval_
enabled bool - Specifies whether connection approval is required.
- connections
Sequence[Vpcep
Service V1Connection Args] - An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- description str
- Specifies the description of the VPC endpoint service.
- name str
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- pool_
id str - Specifies the ID of the cluster associated with the target VPCEP resource.
- port_
id str - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- ports
Sequence[Vpcep
Service V1Port Args] - Lists the port mappings opened to the VPC endpoint service. See below for the details.
- server_
type str - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- service_
type str Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- status str
- The connection status of the VPC endpoint.
- Mapping[str, str]
- Map of the resource tags.
- tcp_
proxy str Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- timeouts
Vpcep
Service V1Timeouts Args - vip_
port_ strid - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- vpc_
id str - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- vpcep_
service_ strv1_ id - ID of VPC endpoint service
- whitelists Sequence[str]
- Lists of domain IDs of target users.
- approval
Enabled Boolean - Specifies whether connection approval is required.
- connections List<Property Map>
- An array of VPC endpoints connect to the VPC endpoint service. Structure is documented below.
- description String
- Specifies the description of the VPC endpoint service.
- name String
- Specifies the name of the VPC endpoint service.
The value contains a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
- If you do not specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceId
. - If you specify this parameter, the VPC endpoint service name is in the format:
regionName.serviceName.serviceId
.
- If you do not specify this parameter, the VPC endpoint service name is in the format:
- pool
Id String - Specifies the ID of the cluster associated with the target VPCEP resource.
- port
Id String - Specifies the ID for identifying the backend resource of the VPC endpoint service.
The value is as follows:
- If the backend service is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
- ports List<Property Map>
- Lists the port mappings opened to the VPC endpoint service. See below for the details.
- server
Type String - Specifies the resource type.
VM
: The backend resource is a server.VIP
: The backend resource is a virtual IP address that functions as a physical server hosting virtual resources.LB
: The backend resource is an enhanced load balancer.
- service
Type String Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
There are two types of VPC endpoint services:
interface
andgateway
.- status String
- The connection status of the VPC endpoint.
- Map<String>
- Map of the resource tags.
- tcp
Proxy String Specifies whether the client IP address and port number or
marker_id
information is transmitted to the server. This parameter is available only when the server can parse fields tcp option and tcp payload.The values are as follows:
- timeouts Property Map
- vip
Port StringId - Specifies the ID of the virtual NIC to which the virtual IP address is bound.
- vpc
Id String - Specifies the ID of the VPC (router) to which the backend resource of the VPC endpoint service belongs.
- vpcep
Service StringV1Id - ID of VPC endpoint service
- whitelists List<String>
- Lists of domain IDs of target users.
Supporting Types
VpcepServiceV1Connection, VpcepServiceV1ConnectionArgs
- Created
At string - Description string
- Specifies the description of the VPC endpoint service.
- Domain
Id string - The user's domain ID.
- Endpoint
Id string - The unique ID of the VPC endpoint.
- Packet
Id double - The packet ID of the VPC endpoint.
- Status string
- The connection status of the VPC endpoint.
- Updated
At string
- Created
At string - Description string
- Specifies the description of the VPC endpoint service.
- Domain
Id string - The user's domain ID.
- Endpoint
Id string - The unique ID of the VPC endpoint.
- Packet
Id float64 - The packet ID of the VPC endpoint.
- Status string
- The connection status of the VPC endpoint.
- Updated
At string
- created
At String - description String
- Specifies the description of the VPC endpoint service.
- domain
Id String - The user's domain ID.
- endpoint
Id String - The unique ID of the VPC endpoint.
- packet
Id Double - The packet ID of the VPC endpoint.
- status String
- The connection status of the VPC endpoint.
- updated
At String
- created
At string - description string
- Specifies the description of the VPC endpoint service.
- domain
Id string - The user's domain ID.
- endpoint
Id string - The unique ID of the VPC endpoint.
- packet
Id number - The packet ID of the VPC endpoint.
- status string
- The connection status of the VPC endpoint.
- updated
At string
- created_
at str - description str
- Specifies the description of the VPC endpoint service.
- domain_
id str - The user's domain ID.
- endpoint_
id str - The unique ID of the VPC endpoint.
- packet_
id float - The packet ID of the VPC endpoint.
- status str
- The connection status of the VPC endpoint.
- updated_
at str
- created
At String - description String
- Specifies the description of the VPC endpoint service.
- domain
Id String - The user's domain ID.
- endpoint
Id String - The unique ID of the VPC endpoint.
- packet
Id Number - The packet ID of the VPC endpoint.
- status String
- The connection status of the VPC endpoint.
- updated
At String
VpcepServiceV1Port, VpcepServiceV1PortArgs
- Client
Port double - Specifies the port for accessing the VPC endpoint.
- Server
Port double - Specifies the port for accessing the VPC endpoint service.
- Protocol string
- Specifies the protocol used in port mappings. The value can be
TCP
orUDP
. The default value isTCP
.
- Client
Port float64 - Specifies the port for accessing the VPC endpoint.
- Server
Port float64 - Specifies the port for accessing the VPC endpoint service.
- Protocol string
- Specifies the protocol used in port mappings. The value can be
TCP
orUDP
. The default value isTCP
.
- client
Port Double - Specifies the port for accessing the VPC endpoint.
- server
Port Double - Specifies the port for accessing the VPC endpoint service.
- protocol String
- Specifies the protocol used in port mappings. The value can be
TCP
orUDP
. The default value isTCP
.
- client
Port number - Specifies the port for accessing the VPC endpoint.
- server
Port number - Specifies the port for accessing the VPC endpoint service.
- protocol string
- Specifies the protocol used in port mappings. The value can be
TCP
orUDP
. The default value isTCP
.
- client_
port float - Specifies the port for accessing the VPC endpoint.
- server_
port float - Specifies the port for accessing the VPC endpoint service.
- protocol str
- Specifies the protocol used in port mappings. The value can be
TCP
orUDP
. The default value isTCP
.
- client
Port Number - Specifies the port for accessing the VPC endpoint.
- server
Port Number - Specifies the port for accessing the VPC endpoint service.
- protocol String
- Specifies the protocol used in port mappings. The value can be
TCP
orUDP
. The default value isTCP
.
VpcepServiceV1Timeouts, VpcepServiceV1TimeoutsArgs
- Default string
- Default string
- default_ String
- default string
- default str
- default String
Import
VPC endpoint service can be imported using the id
, e.g.
$ pulumi import opentelekomcloud:index/vpcepServiceV1:VpcepServiceV1 service 71ba78a2-d847-4882-8fd0-42c5854c1cbc
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
- License
- Notes
- This Pulumi package is based on the
opentelekomcloud
Terraform Provider.