@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
137 lines (136 loc) • 5.84 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage privatelink security group
* ## 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 foo1 = new volcengine.vpc.SecurityGroup("foo1", {
* securityGroupName: "acc-test-security-group-new",
* 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",
* });
* const fooPrivatelink_securityGroupSecurityGroup = new volcengine.privatelink.SecurityGroup("fooPrivatelink/securityGroupSecurityGroup", {
* endpointId: fooVpcEndpoint.id,
* securityGroupId: foo1.id,
* });
* ```
*
* ## Import
*
* PrivateLink Security Group Service can be imported using the endpoint id and security group id, e.g.
*
* ```sh
* $ pulumi import volcengine:privatelink/securityGroup:SecurityGroup default ep-2fe630gurkl37k5gfuy33****:sg-xxxxx
* ```
*/
export declare class SecurityGroup extends pulumi.CustomResource {
/**
* Get an existing SecurityGroup 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?: SecurityGroupState, opts?: pulumi.CustomResourceOptions): SecurityGroup;
/**
* Returns true if the given object is an instance of SecurityGroup. 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 SecurityGroup;
/**
* The id of the endpoint.
*/
readonly endpointId: pulumi.Output<string>;
/**
* The id of the security group. It is not recommended to use this resource for binding security groups, it is recommended to use the `securityGroupId` field of `volcengine.privatelink.VpcEndpoint` for binding.
* If using this resource and `volcengine.privatelink.VpcEndpoint` jointly for operations, use lifecycle ignoreChanges to suppress changes to the `securityGroupId` field in `volcengine.privatelink.VpcEndpoint`.
*/
readonly securityGroupId: pulumi.Output<string>;
/**
* Create a SecurityGroup 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: SecurityGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SecurityGroup resources.
*/
export interface SecurityGroupState {
/**
* The id of the endpoint.
*/
endpointId?: pulumi.Input<string>;
/**
* The id of the security group. It is not recommended to use this resource for binding security groups, it is recommended to use the `securityGroupId` field of `volcengine.privatelink.VpcEndpoint` for binding.
* If using this resource and `volcengine.privatelink.VpcEndpoint` jointly for operations, use lifecycle ignoreChanges to suppress changes to the `securityGroupId` field in `volcengine.privatelink.VpcEndpoint`.
*/
securityGroupId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SecurityGroup resource.
*/
export interface SecurityGroupArgs {
/**
* The id of the endpoint.
*/
endpointId: pulumi.Input<string>;
/**
* The id of the security group. It is not recommended to use this resource for binding security groups, it is recommended to use the `securityGroupId` field of `volcengine.privatelink.VpcEndpoint` for binding.
* If using this resource and `volcengine.privatelink.VpcEndpoint` jointly for operations, use lifecycle ignoreChanges to suppress changes to the `securityGroupId` field in `volcengine.privatelink.VpcEndpoint`.
*/
securityGroupId: pulumi.Input<string>;
}