@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
257 lines (256 loc) • 8.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage privatelink vpc endpoint
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooZones = volcengine.ecs.getZones({});
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-vpc",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-test-subnet",
* cidrBlock: "172.16.0.0/24",
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* vpcId: fooVpc.id,
* });
* const fooSecurityGroup = new volcengine.vpc.SecurityGroup("fooSecurityGroup", {
* securityGroupName: "acc-test-security-group",
* vpcId: fooVpc.id,
* });
* const fooClb = new volcengine.clb.Clb("fooClb", {
* type: "public",
* subnetId: fooSubnet.id,
* loadBalancerSpec: "small_1",
* description: "acc-test-demo",
* loadBalancerName: "acc-test-clb",
* loadBalancerBillingType: "PostPaid",
* eipBillingConfig: {
* isp: "BGP",
* eipBillingType: "PostPaidByBandwidth",
* bandwidth: 1,
* },
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* const fooVpcEndpointService = new volcengine.privatelink.VpcEndpointService("fooVpcEndpointService", {
* resources: [{
* resourceId: fooClb.id,
* resourceType: "CLB",
* }],
* description: "acc-test",
* autoAcceptEnabled: true,
* });
* const fooVpcEndpoint = new volcengine.privatelink.VpcEndpoint("fooVpcEndpoint", {
* securityGroupIds: [fooSecurityGroup.id],
* serviceId: fooVpcEndpointService.id,
* endpointName: "acc-test-ep",
* description: "acc-test",
* });
* ```
*
* ## Import
*
* VpcEndpoint can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:privatelink/vpcEndpoint:VpcEndpoint default ep-3rel74u229dz45zsk2i6l****
* ```
*/
export declare class VpcEndpoint extends pulumi.CustomResource {
/**
* Get an existing VpcEndpoint resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VpcEndpointState, opts?: pulumi.CustomResourceOptions): VpcEndpoint;
/**
* Returns true if the given object is an instance of VpcEndpoint. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is VpcEndpoint;
/**
* Whether the vpc endpoint is locked.
*/
readonly businessStatus: pulumi.Output<string>;
/**
* The connection status of vpc endpoint.
*/
readonly connectionStatus: pulumi.Output<string>;
/**
* The create time of vpc endpoint.
*/
readonly creationTime: pulumi.Output<string>;
/**
* The delete time of vpc endpoint.
*/
readonly deletedTime: pulumi.Output<string>;
/**
* The description of vpc endpoint.
*/
readonly description: pulumi.Output<string>;
/**
* The domain of vpc endpoint.
*/
readonly endpointDomain: pulumi.Output<string>;
/**
* The name of vpc endpoint.
*/
readonly endpointName: pulumi.Output<string>;
/**
* The type of vpc endpoint.
*/
readonly endpointType: pulumi.Output<string>;
/**
* Whether to enable private dns name. Default is false.
*/
readonly privateDnsEnabled: pulumi.Output<boolean>;
/**
* The private dns name of vpc endpoint.
*/
readonly privateDnsName: pulumi.Output<string>;
/**
* The security group ids of vpc endpoint. It is recommended to bind security groups using the 'security_group_ids' field in this resource instead of using `volcengine.privatelink.SecurityGroup`.
* For operations that jointly use this resource and `volcengine.privatelink.SecurityGroup`, use lifecycle ignoreChanges to suppress changes to the 'security_group_ids' field.
*/
readonly securityGroupIds: pulumi.Output<string[]>;
/**
* The id of vpc endpoint service.
*/
readonly serviceId: pulumi.Output<string>;
/**
* The name of vpc endpoint service.
*/
readonly serviceName: pulumi.Output<string>;
/**
* The status of vpc endpoint.
*/
readonly status: pulumi.Output<string>;
/**
* The update time of vpc endpoint.
*/
readonly updateTime: pulumi.Output<string>;
/**
* The vpc id of vpc endpoint.
*/
readonly vpcId: pulumi.Output<string>;
/**
* Create a VpcEndpoint resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: VpcEndpointArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VpcEndpoint resources.
*/
export interface VpcEndpointState {
/**
* Whether the vpc endpoint is locked.
*/
businessStatus?: pulumi.Input<string>;
/**
* The connection status of vpc endpoint.
*/
connectionStatus?: pulumi.Input<string>;
/**
* The create time of vpc endpoint.
*/
creationTime?: pulumi.Input<string>;
/**
* The delete time of vpc endpoint.
*/
deletedTime?: pulumi.Input<string>;
/**
* The description of vpc endpoint.
*/
description?: pulumi.Input<string>;
/**
* The domain of vpc endpoint.
*/
endpointDomain?: pulumi.Input<string>;
/**
* The name of vpc endpoint.
*/
endpointName?: pulumi.Input<string>;
/**
* The type of vpc endpoint.
*/
endpointType?: pulumi.Input<string>;
/**
* Whether to enable private dns name. Default is false.
*/
privateDnsEnabled?: pulumi.Input<boolean>;
/**
* The private dns name of vpc endpoint.
*/
privateDnsName?: pulumi.Input<string>;
/**
* The security group ids of vpc endpoint. It is recommended to bind security groups using the 'security_group_ids' field in this resource instead of using `volcengine.privatelink.SecurityGroup`.
* For operations that jointly use this resource and `volcengine.privatelink.SecurityGroup`, use lifecycle ignoreChanges to suppress changes to the 'security_group_ids' field.
*/
securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The id of vpc endpoint service.
*/
serviceId?: pulumi.Input<string>;
/**
* The name of vpc endpoint service.
*/
serviceName?: pulumi.Input<string>;
/**
* The status of vpc endpoint.
*/
status?: pulumi.Input<string>;
/**
* The update time of vpc endpoint.
*/
updateTime?: pulumi.Input<string>;
/**
* The vpc id of vpc endpoint.
*/
vpcId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a VpcEndpoint resource.
*/
export interface VpcEndpointArgs {
/**
* The description of vpc endpoint.
*/
description?: pulumi.Input<string>;
/**
* The name of vpc endpoint.
*/
endpointName?: pulumi.Input<string>;
/**
* Whether to enable private dns name. Default is false.
*/
privateDnsEnabled?: pulumi.Input<boolean>;
/**
* The security group ids of vpc endpoint. It is recommended to bind security groups using the 'security_group_ids' field in this resource instead of using `volcengine.privatelink.SecurityGroup`.
* For operations that jointly use this resource and `volcengine.privatelink.SecurityGroup`, use lifecycle ignoreChanges to suppress changes to the 'security_group_ids' field.
*/
securityGroupIds: pulumi.Input<pulumi.Input<string>[]>;
/**
* The id of vpc endpoint service.
*/
serviceId: pulumi.Input<string>;
/**
* The name of vpc endpoint service.
*/
serviceName?: pulumi.Input<string>;
}