Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. mongodb
  5. InstanceParameter
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.mongodb.InstanceParameter

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage mongodb instance parameter

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";

const fooZones = volcengine.ecs.Zones({});
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 fooInstance = new volcengine.mongodb.Instance("fooInstance", {
    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: 32,
    shardNumber: 3,
    storageSpaceGb: 20,
    subnetId: fooSubnet.id,
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    tags: [{
        key: "k1",
        value: "v1",
    }],
});
const fooInstanceParameter = new volcengine.mongodb.InstanceParameter("fooInstanceParameter", {
    instanceId: fooInstance.id,
    parameterName: "cursorTimeoutMillis",
    parameterRole: "Node",
    parameterValue: "600111",
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo_instance = volcengine.mongodb.Instance("fooInstance",
    db_engine_version="MongoDB_4_0",
    instance_type="ReplicaSet",
    super_account_password="@acc-test-123",
    node_spec="mongo.2c4g",
    mongos_node_spec="mongo.mongos.2c4g",
    instance_name="acc-test-mongo-replica",
    charge_type="PostPaid",
    project_name="default",
    mongos_node_number=32,
    shard_number=3,
    storage_space_gb=20,
    subnet_id=foo_subnet.id,
    zone_id=foo_zones.zones[0].id,
    tags=[volcengine.mongodb.InstanceTagArgs(
        key="k1",
        value="v1",
    )])
foo_instance_parameter = volcengine.mongodb.InstanceParameter("fooInstanceParameter",
    instance_id=foo_instance.id,
    parameter_name="cursorTimeoutMillis",
    parameter_role="Node",
    parameter_value="600111")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/mongodb"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.Zones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooInstance, err := mongodb.NewInstance(ctx, "fooInstance", &mongodb.InstanceArgs{
			DbEngineVersion:      pulumi.String("MongoDB_4_0"),
			InstanceType:         pulumi.String("ReplicaSet"),
			SuperAccountPassword: pulumi.String("@acc-test-123"),
			NodeSpec:             pulumi.String("mongo.2c4g"),
			MongosNodeSpec:       pulumi.String("mongo.mongos.2c4g"),
			InstanceName:         pulumi.String("acc-test-mongo-replica"),
			ChargeType:           pulumi.String("PostPaid"),
			ProjectName:          pulumi.String("default"),
			MongosNodeNumber:     pulumi.Int(32),
			ShardNumber:          pulumi.Int(3),
			StorageSpaceGb:       pulumi.Int(20),
			SubnetId:             fooSubnet.ID(),
			ZoneId:               pulumi.String(fooZones.Zones[0].Id),
			Tags: mongodb.InstanceTagArray{
				&mongodb.InstanceTagArgs{
					Key:   pulumi.String("k1"),
					Value: pulumi.String("v1"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = mongodb.NewInstanceParameter(ctx, "fooInstanceParameter", &mongodb.InstanceParameterArgs{
			InstanceId:     fooInstance.ID(),
			ParameterName:  pulumi.String("cursorTimeoutMillis"),
			ParameterRole:  pulumi.String("Node"),
			ParameterValue: pulumi.String("600111"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.Zones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooInstance = new Volcengine.Mongodb.Instance("fooInstance", new()
    {
        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 = 32,
        ShardNumber = 3,
        StorageSpaceGb = 20,
        SubnetId = fooSubnet.Id,
        ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
        Tags = new[]
        {
            new Volcengine.Mongodb.Inputs.InstanceTagArgs
            {
                Key = "k1",
                Value = "v1",
            },
        },
    });

    var fooInstanceParameter = new Volcengine.Mongodb.InstanceParameter("fooInstanceParameter", new()
    {
        InstanceId = fooInstance.Id,
        ParameterName = "cursorTimeoutMillis",
        ParameterRole = "Node",
        ParameterValue = "600111",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.mongodb.Instance;
import com.pulumi.volcengine.mongodb.InstanceArgs;
import com.pulumi.volcengine.mongodb.inputs.InstanceTagArgs;
import com.pulumi.volcengine.mongodb.InstanceParameter;
import com.pulumi.volcengine.mongodb.InstanceParameterArgs;
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 fooZones = EcsFunctions.Zones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
            .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(32)
            .shardNumber(3)
            .storageSpaceGb(20)
            .subnetId(fooSubnet.id())
            .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
            .tags(InstanceTagArgs.builder()
                .key("k1")
                .value("v1")
                .build())
            .build());

        var fooInstanceParameter = new InstanceParameter("fooInstanceParameter", InstanceParameterArgs.builder()        
            .instanceId(fooInstance.id())
            .parameterName("cursorTimeoutMillis")
            .parameterRole("Node")
            .parameterValue("600111")
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[0].id}
      vpcId: ${fooVpc.id}
  fooInstance:
    type: volcengine:mongodb:Instance
    properties:
      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: 32
      shardNumber: 3
      storageSpaceGb: 20
      subnetId: ${fooSubnet.id}
      zoneId: ${fooZones.zones[0].id}
      tags:
        - key: k1
          value: v1
  fooInstanceParameter:
    type: volcengine:mongodb:InstanceParameter
    properties:
      instanceId: ${fooInstance.id}
      parameterName: cursorTimeoutMillis
      parameterRole: Node
      parameterValue: '600111'
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:Zones
      Arguments: {}

    Create InstanceParameter Resource

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

    Constructor syntax

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

@overload
def InstanceParameter(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      instance_id: Optional[str] = None,
                      parameter_name: Optional[str] = None,
                      parameter_role: Optional[str] = None,
                      parameter_value: Optional[str] = None)
    func NewInstanceParameter(ctx *Context, name string, args InstanceParameterArgs, opts ...ResourceOption) (*InstanceParameter, error)
    public InstanceParameter(string name, InstanceParameterArgs args, CustomResourceOptions? opts = null)
    public InstanceParameter(String name, InstanceParameterArgs args)
public InstanceParameter(String name, InstanceParameterArgs args, CustomResourceOptions options)

    type: volcengine:mongodb:InstanceParameter
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 InstanceParameterArgs
    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 InstanceParameterArgs
    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 InstanceParameterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceParameterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceParameterArgs
    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 instanceParameterResource = new Volcengine.Mongodb.InstanceParameter("instanceParameterResource", new()
{
    InstanceId = "string",
    ParameterName = "string",
    ParameterRole = "string",
    ParameterValue = "string",
});

    example, err := mongodb.NewInstanceParameter(ctx, "instanceParameterResource", &mongodb.InstanceParameterArgs{
	InstanceId:     pulumi.String("string"),
	ParameterName:  pulumi.String("string"),
	ParameterRole:  pulumi.String("string"),
	ParameterValue: pulumi.String("string"),
})

    var instanceParameterResource = new InstanceParameter("instanceParameterResource", InstanceParameterArgs.builder()
    .instanceId("string")
    .parameterName("string")
    .parameterRole("string")
    .parameterValue("string")
    .build());

    instance_parameter_resource = volcengine.mongodb.InstanceParameter("instanceParameterResource",
    instance_id="string",
    parameter_name="string",
    parameter_role="string",
    parameter_value="string")

    const instanceParameterResource = new volcengine.mongodb.InstanceParameter("instanceParameterResource", {
    instanceId: "string",
    parameterName: "string",
    parameterRole: "string",
    parameterValue: "string",
});

    type: volcengine:mongodb:InstanceParameter
properties:
    instanceId: string
    parameterName: string
    parameterRole: string
    parameterValue: string

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

    InstanceId string
    The instance ID.
    ParameterName string
    The name of parameter.
    ParameterRole string
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    ParameterValue string
    The value of parameter.
    InstanceId string
    The instance ID.
    ParameterName string
    The name of parameter.
    ParameterRole string
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    ParameterValue string
    The value of parameter.
    instanceId String
    The instance ID.
    parameterName String
    The name of parameter.
    parameterRole String
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    parameterValue String
    The value of parameter.
    instanceId string
    The instance ID.
    parameterName string
    The name of parameter.
    parameterRole string
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    parameterValue string
    The value of parameter.
    instance_id str
    The instance ID.
    parameter_name str
    The name of parameter.
    parameter_role str
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    parameter_value str
    The value of parameter.
    instanceId String
    The instance ID.
    parameterName String
    The name of parameter.
    parameterRole String
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    parameterValue String
    The value of parameter.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing InstanceParameter Resource

    Get an existing InstanceParameter 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?: InstanceParameterState, opts?: CustomResourceOptions): InstanceParameter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        instance_id: Optional[str] = None,
        parameter_name: Optional[str] = None,
        parameter_role: Optional[str] = None,
        parameter_value: Optional[str] = None) -> InstanceParameter
    func GetInstanceParameter(ctx *Context, name string, id IDInput, state *InstanceParameterState, opts ...ResourceOption) (*InstanceParameter, error)
    public static InstanceParameter Get(string name, Input<string> id, InstanceParameterState? state, CustomResourceOptions? opts = null)
    public static InstanceParameter get(String name, Output<String> id, InstanceParameterState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:mongodb:InstanceParameter    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:
    InstanceId string
    The instance ID.
    ParameterName string
    The name of parameter.
    ParameterRole string
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    ParameterValue string
    The value of parameter.
    InstanceId string
    The instance ID.
    ParameterName string
    The name of parameter.
    ParameterRole string
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    ParameterValue string
    The value of parameter.
    instanceId String
    The instance ID.
    parameterName String
    The name of parameter.
    parameterRole String
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    parameterValue String
    The value of parameter.
    instanceId string
    The instance ID.
    parameterName string
    The name of parameter.
    parameterRole string
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    parameterValue string
    The value of parameter.
    instance_id str
    The instance ID.
    parameter_name str
    The name of parameter.
    parameter_role str
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    parameter_value str
    The value of parameter.
    instanceId String
    The instance ID.
    parameterName String
    The name of parameter.
    parameterRole String
    The node type to which the parameter belongs. The value range is as follows: Node, Shard, ConfigServer, Mongos.
    parameterValue String
    The value of parameter.

    Import

    mongodb parameter can be imported using the param:instanceId:parameterName, e.g.

    $ pulumi import volcengine:mongodb/instanceParameter:InstanceParameter default param:mongo-replica-e405f8e2****:connPoolMaxConnsPerHost

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
    volcengine/pulumi-volcengine