1. Packages
  2. Volcengine
  3. API Docs
  4. privatelink
  5. VpcGatewayEndpoint
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.privatelink.VpcGatewayEndpoint

volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Provides a resource to manage privatelink vpc gateway endpoint

    Import

    VpcGatewayEndpoint can be imported using the id, e.g.

    $ pulumi import volcengine:privatelink/vpcGatewayEndpoint:VpcGatewayEndpoint default gwep-273yuq6q7bgn47fap8squ****

    Create VpcGatewayEndpoint Resource

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

    Constructor syntax

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

@overload
def VpcGatewayEndpoint(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       service_id: Optional[str] = None,
                       vpc_id: Optional[str] = None,
                       description: Optional[str] = None,
                       endpoint_name: Optional[str] = None,
                       project_name: Optional[str] = None,
                       tags: Optional[Sequence[VpcGatewayEndpointTagArgs]] = None,
                       vpc_policy: Optional[str] = None)
    func NewVpcGatewayEndpoint(ctx *Context, name string, args VpcGatewayEndpointArgs, opts ...ResourceOption) (*VpcGatewayEndpoint, error)
    public VpcGatewayEndpoint(string name, VpcGatewayEndpointArgs args, CustomResourceOptions? opts = null)
    public VpcGatewayEndpoint(String name, VpcGatewayEndpointArgs args)
public VpcGatewayEndpoint(String name, VpcGatewayEndpointArgs args, CustomResourceOptions options)

    type: volcengine:privatelink:VpcGatewayEndpoint
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 VpcGatewayEndpointArgs
    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 VpcGatewayEndpointArgs
    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 VpcGatewayEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcGatewayEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcGatewayEndpointArgs
    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 vpcGatewayEndpointResource = new Volcengine.Privatelink.VpcGatewayEndpoint("vpcGatewayEndpointResource", new()
{
    ServiceId = "string",
    VpcId = "string",
    Description = "string",
    EndpointName = "string",
    ProjectName = "string",
    Tags = new[]
    {
        new Volcengine.Privatelink.Inputs.VpcGatewayEndpointTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    VpcPolicy = "string",
});

    example, err := privatelink.NewVpcGatewayEndpoint(ctx, "vpcGatewayEndpointResource", &privatelink.VpcGatewayEndpointArgs{
	ServiceId:    pulumi.String("string"),
	VpcId:        pulumi.String("string"),
	Description:  pulumi.String("string"),
	EndpointName: pulumi.String("string"),
	ProjectName:  pulumi.String("string"),
	Tags: privatelink.VpcGatewayEndpointTagArray{
		&privatelink.VpcGatewayEndpointTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	VpcPolicy: pulumi.String("string"),
})

    var vpcGatewayEndpointResource = new VpcGatewayEndpoint("vpcGatewayEndpointResource", VpcGatewayEndpointArgs.builder()
    .serviceId("string")
    .vpcId("string")
    .description("string")
    .endpointName("string")
    .projectName("string")
    .tags(VpcGatewayEndpointTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .vpcPolicy("string")
    .build());

    vpc_gateway_endpoint_resource = volcengine.privatelink.VpcGatewayEndpoint("vpcGatewayEndpointResource",
    service_id="string",
    vpc_id="string",
    description="string",
    endpoint_name="string",
    project_name="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    vpc_policy="string")

    const vpcGatewayEndpointResource = new volcengine.privatelink.VpcGatewayEndpoint("vpcGatewayEndpointResource", {
    serviceId: "string",
    vpcId: "string",
    description: "string",
    endpointName: "string",
    projectName: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    vpcPolicy: "string",
});

    type: volcengine:privatelink:VpcGatewayEndpoint
properties:
    description: string
    endpointName: string
    projectName: string
    serviceId: string
    tags:
        - key: string
          value: string
    vpcId: string
    vpcPolicy: string

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

    ServiceId string
    The id of the gateway endpoint service.
    VpcId string
    The id of the vpc.
    Description string
    The description of the gateway endpoint.
    EndpointName string
    The name of the gateway endpoint.
    ProjectName string
    The project name of the gateway endpoint.
    Tags List<VpcGatewayEndpointTag>
    Tags.
    VpcPolicy string
    The vpc policy of the gateway endpoint.
    ServiceId string
    The id of the gateway endpoint service.
    VpcId string
    The id of the vpc.
    Description string
    The description of the gateway endpoint.
    EndpointName string
    The name of the gateway endpoint.
    ProjectName string
    The project name of the gateway endpoint.
    Tags []VpcGatewayEndpointTagArgs
    Tags.
    VpcPolicy string
    The vpc policy of the gateway endpoint.
    serviceId String
    The id of the gateway endpoint service.
    vpcId String
    The id of the vpc.
    description String
    The description of the gateway endpoint.
    endpointName String
    The name of the gateway endpoint.
    projectName String
    The project name of the gateway endpoint.
    tags List<VpcGatewayEndpointTag>
    Tags.
    vpcPolicy String
    The vpc policy of the gateway endpoint.
    serviceId string
    The id of the gateway endpoint service.
    vpcId string
    The id of the vpc.
    description string
    The description of the gateway endpoint.
    endpointName string
    The name of the gateway endpoint.
    projectName string
    The project name of the gateway endpoint.
    tags VpcGatewayEndpointTag[]
    Tags.
    vpcPolicy string
    The vpc policy of the gateway endpoint.
    service_id str
    The id of the gateway endpoint service.
    vpc_id str
    The id of the vpc.
    description str
    The description of the gateway endpoint.
    endpoint_name str
    The name of the gateway endpoint.
    project_name str
    The project name of the gateway endpoint.
    tags Sequence[VpcGatewayEndpointTagArgs]
    Tags.
    vpc_policy str
    The vpc policy of the gateway endpoint.
    serviceId String
    The id of the gateway endpoint service.
    vpcId String
    The id of the vpc.
    description String
    The description of the gateway endpoint.
    endpointName String
    The name of the gateway endpoint.
    projectName String
    The project name of the gateway endpoint.
    tags List<Property Map>
    Tags.
    vpcPolicy String
    The vpc policy of the gateway endpoint.

    Outputs

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

    EndpointId string
    The id of the gateway endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    EndpointId string
    The id of the gateway endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    endpointId String
    The id of the gateway endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    endpointId string
    The id of the gateway endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    endpoint_id str
    The id of the gateway endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    endpointId String
    The id of the gateway endpoint.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VpcGatewayEndpoint Resource

    Get an existing VpcGatewayEndpoint 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?: VpcGatewayEndpointState, opts?: CustomResourceOptions): VpcGatewayEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        endpoint_id: Optional[str] = None,
        endpoint_name: Optional[str] = None,
        project_name: Optional[str] = None,
        service_id: Optional[str] = None,
        tags: Optional[Sequence[VpcGatewayEndpointTagArgs]] = None,
        vpc_id: Optional[str] = None,
        vpc_policy: Optional[str] = None) -> VpcGatewayEndpoint
    func GetVpcGatewayEndpoint(ctx *Context, name string, id IDInput, state *VpcGatewayEndpointState, opts ...ResourceOption) (*VpcGatewayEndpoint, error)
    public static VpcGatewayEndpoint Get(string name, Input<string> id, VpcGatewayEndpointState? state, CustomResourceOptions? opts = null)
    public static VpcGatewayEndpoint get(String name, Output<String> id, VpcGatewayEndpointState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:privatelink:VpcGatewayEndpoint    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of the gateway endpoint.
    EndpointId string
    The id of the gateway endpoint.
    EndpointName string
    The name of the gateway endpoint.
    ProjectName string
    The project name of the gateway endpoint.
    ServiceId string
    The id of the gateway endpoint service.
    Tags List<VpcGatewayEndpointTag>
    Tags.
    VpcId string
    The id of the vpc.
    VpcPolicy string
    The vpc policy of the gateway endpoint.
    Description string
    The description of the gateway endpoint.
    EndpointId string
    The id of the gateway endpoint.
    EndpointName string
    The name of the gateway endpoint.
    ProjectName string
    The project name of the gateway endpoint.
    ServiceId string
    The id of the gateway endpoint service.
    Tags []VpcGatewayEndpointTagArgs
    Tags.
    VpcId string
    The id of the vpc.
    VpcPolicy string
    The vpc policy of the gateway endpoint.
    description String
    The description of the gateway endpoint.
    endpointId String
    The id of the gateway endpoint.
    endpointName String
    The name of the gateway endpoint.
    projectName String
    The project name of the gateway endpoint.
    serviceId String
    The id of the gateway endpoint service.
    tags List<VpcGatewayEndpointTag>
    Tags.
    vpcId String
    The id of the vpc.
    vpcPolicy String
    The vpc policy of the gateway endpoint.
    description string
    The description of the gateway endpoint.
    endpointId string
    The id of the gateway endpoint.
    endpointName string
    The name of the gateway endpoint.
    projectName string
    The project name of the gateway endpoint.
    serviceId string
    The id of the gateway endpoint service.
    tags VpcGatewayEndpointTag[]
    Tags.
    vpcId string
    The id of the vpc.
    vpcPolicy string
    The vpc policy of the gateway endpoint.
    description str
    The description of the gateway endpoint.
    endpoint_id str
    The id of the gateway endpoint.
    endpoint_name str
    The name of the gateway endpoint.
    project_name str
    The project name of the gateway endpoint.
    service_id str
    The id of the gateway endpoint service.
    tags Sequence[VpcGatewayEndpointTagArgs]
    Tags.
    vpc_id str
    The id of the vpc.
    vpc_policy str
    The vpc policy of the gateway endpoint.
    description String
    The description of the gateway endpoint.
    endpointId String
    The id of the gateway endpoint.
    endpointName String
    The name of the gateway endpoint.
    projectName String
    The project name of the gateway endpoint.
    serviceId String
    The id of the gateway endpoint service.
    tags List<Property Map>
    Tags.
    vpcId String
    The id of the vpc.
    vpcPolicy String
    The vpc policy of the gateway endpoint.

    Supporting Types

    VpcGatewayEndpointTag, VpcGatewayEndpointTagArgs

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Try Pulumi Cloud free. Your team will thank you.