@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
196 lines (195 loc) • 6.87 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage mongodb 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 fooAddress: volcengine.eip.Address[] = [];
* for (const range = {value: 0}; range.value < 2; range.value++) {
* fooAddress.push(new volcengine.eip.Address(`fooAddress-${range.value}`, {
* billingType: "PostPaidByBandwidth",
* bandwidth: 1,
* isp: "ChinaUnicom",
* description: "acc-test",
* projectName: "default",
* }));
* }
* const replica_set = new volcengine.mongodb.Instance("replica-set", {
* dbEngineVersion: "MongoDB_4_0",
* instanceType: "ReplicaSet",
* superAccountPassword: "@acc-test-123",
* nodeSpec: "mongo.2c4g",
* mongosNodeSpec: "mongo.mongos.2c4g",
* instanceName: "acc-test-mongo-replica",
* chargeType: "PostPaid",
* projectName: "default",
* mongosNodeNumber: 2,
* shardNumber: 3,
* storageSpaceGb: 20,
* subnetId: fooSubnet.id,
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* const replica_set_public_endpoint = new volcengine.mongodb.Endpoint("replica-set-public-endpoint", {
* instanceId: replica_set.id,
* networkType: "Public",
* eipIds: fooAddress.map(__item => __item.id),
* });
* const sharded_cluster = new volcengine.mongodb.Instance("sharded-cluster", {
* dbEngineVersion: "MongoDB_4_0",
* instanceType: "ShardedCluster",
* superAccountPassword: "@acc-test-123",
* nodeSpec: "mongo.shard.1c2g",
* mongosNodeSpec: "mongo.mongos.1c2g",
* instanceName: "acc-test-mongo-shard",
* chargeType: "PostPaid",
* projectName: "default",
* mongosNodeNumber: 2,
* shardNumber: 2,
* storageSpaceGb: 20,
* subnetId: fooSubnet.id,
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* const sharded_cluster_private_endpoint = new volcengine.mongodb.Endpoint("sharded-cluster-private-endpoint", {
* instanceId: sharded_cluster.id,
* networkType: "Private",
* objectId: sharded_cluster.shards.apply(shards => shards[0].shardId),
* });
* ```
*
* ## Import
*
* mongodb endpoint can be imported using the instanceId:endpointId
* `instanceId`: represents the instance that endpoint related to.
* `endpointId`: the id of endpoint.
* e.g.
*
* ```sh
* $ pulumi import volcengine:mongodb/endpoint:Endpoint default mongo-replica-e405f8e2****:BRhFA0pDAk0XXkxCZQ
* ```
*/
export declare class Endpoint extends pulumi.CustomResource {
/**
* Get an existing Endpoint 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?: EndpointState, opts?: pulumi.CustomResourceOptions): Endpoint;
/**
* Returns true if the given object is an instance of Endpoint. 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 Endpoint;
/**
* A list of EIP IDs that need to be bound when applying for endpoint.
*/
readonly eipIds: pulumi.Output<string[]>;
/**
* The id of endpoint.
*/
readonly endpointId: pulumi.Output<string>;
/**
* The instance where the endpoint resides.
*/
readonly instanceId: pulumi.Output<string>;
/**
* A list of the Mongos node that needs to apply for the endpoint.
*/
readonly mongosNodeIds: pulumi.Output<string[] | undefined>;
/**
* The network type of endpoint. Valid values: `Private`, `Public`. Default is `Private`.
*/
readonly networkType: pulumi.Output<string | undefined>;
/**
* The object ID corresponding to the endpoint.
*/
readonly objectId: pulumi.Output<string>;
/**
* Create a Endpoint 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: EndpointArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Endpoint resources.
*/
export interface EndpointState {
/**
* A list of EIP IDs that need to be bound when applying for endpoint.
*/
eipIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The id of endpoint.
*/
endpointId?: pulumi.Input<string>;
/**
* The instance where the endpoint resides.
*/
instanceId?: pulumi.Input<string>;
/**
* A list of the Mongos node that needs to apply for the endpoint.
*/
mongosNodeIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The network type of endpoint. Valid values: `Private`, `Public`. Default is `Private`.
*/
networkType?: pulumi.Input<string>;
/**
* The object ID corresponding to the endpoint.
*/
objectId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Endpoint resource.
*/
export interface EndpointArgs {
/**
* A list of EIP IDs that need to be bound when applying for endpoint.
*/
eipIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The instance where the endpoint resides.
*/
instanceId: pulumi.Input<string>;
/**
* A list of the Mongos node that needs to apply for the endpoint.
*/
mongosNodeIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The network type of endpoint. Valid values: `Private`, `Public`. Default is `Private`.
*/
networkType?: pulumi.Input<string>;
/**
* The object ID corresponding to the endpoint.
*/
objectId?: pulumi.Input<string>;
}