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

volcengine.mongodb.SslState

Explore with Pulumi AI

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

Provides a resource to manage mongodb ssl state

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: 2,
    shardNumber: 3,
    storageSpaceGb: 20,
    subnetId: fooSubnet.id,
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    tags: [{
        key: "k1",
        value: "v1",
    }],
});
const fooSslState = new volcengine.mongodb.SslState("fooSslState", {instanceId: fooInstance.id});
Copy
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=2,
    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_ssl_state = volcengine.mongodb.SslState("fooSslState", instance_id=foo_instance.id)
Copy
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(2),
			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.NewSslState(ctx, "fooSslState", &mongodb.SslStateArgs{
			InstanceId: fooInstance.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 = 2,
        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 fooSslState = new Volcengine.Mongodb.SslState("fooSslState", new()
    {
        InstanceId = fooInstance.Id,
    });

});
Copy
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.SslState;
import com.pulumi.volcengine.mongodb.SslStateArgs;
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(2)
            .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 fooSslState = new SslState("fooSslState", SslStateArgs.builder()        
            .instanceId(fooInstance.id())
            .build());

    }
}
Copy
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: 2
      shardNumber: 3
      storageSpaceGb: 20
      subnetId: ${fooSubnet.id}
      zoneId: ${fooZones.zones[0].id}
      tags:
        - key: k1
          value: v1
  fooSslState:
    type: volcengine:mongodb:SslState
    properties:
      instanceId: ${fooInstance.id}
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:Zones
      Arguments: {}
Copy

Create SslState Resource

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

Constructor syntax

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

@overload
def SslState(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             instance_id: Optional[str] = None,
             ssl_action: Optional[str] = None)
func NewSslState(ctx *Context, name string, args SslStateArgs, opts ...ResourceOption) (*SslState, error)
public SslState(string name, SslStateArgs args, CustomResourceOptions? opts = null)
public SslState(String name, SslStateArgs args)
public SslState(String name, SslStateArgs args, CustomResourceOptions options)

type: volcengine:mongodb:SslState
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SslStateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SslStateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SslStateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SslStateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SslStateArgs
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 sslStateResource = new Volcengine.Mongodb.SslState("sslStateResource", new()
{
    InstanceId = "string",
    SslAction = "string",
});
Copy
example, err := mongodb.NewSslState(ctx, "sslStateResource", &mongodb.SslStateArgs{
	InstanceId: pulumi.String("string"),
	SslAction:  pulumi.String("string"),
})
Copy
var sslStateResource = new SslState("sslStateResource", SslStateArgs.builder()
    .instanceId("string")
    .sslAction("string")
    .build());
Copy
ssl_state_resource = volcengine.mongodb.SslState("sslStateResource",
    instance_id="string",
    ssl_action="string")
Copy
const sslStateResource = new volcengine.mongodb.SslState("sslStateResource", {
    instanceId: "string",
    sslAction: "string",
});
Copy
type: volcengine:mongodb:SslState
properties:
    instanceId: string
    sslAction: string
Copy

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

InstanceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of mongodb instance.
SslAction string
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of mongodb instance.
SslAction string
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.
instanceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of mongodb instance.
sslAction String
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.
instanceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of mongodb instance.
sslAction string
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.
instance_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of mongodb instance.
ssl_action str
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.
instanceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of mongodb instance.
sslAction String
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
IsValid bool
Whetehr SSL is valid.
SslEnable bool
Whether SSL is enabled.
SslExpiredTime string
The expire time of SSL.
Id string
The provider-assigned unique ID for this managed resource.
IsValid bool
Whetehr SSL is valid.
SslEnable bool
Whether SSL is enabled.
SslExpiredTime string
The expire time of SSL.
id String
The provider-assigned unique ID for this managed resource.
isValid Boolean
Whetehr SSL is valid.
sslEnable Boolean
Whether SSL is enabled.
sslExpiredTime String
The expire time of SSL.
id string
The provider-assigned unique ID for this managed resource.
isValid boolean
Whetehr SSL is valid.
sslEnable boolean
Whether SSL is enabled.
sslExpiredTime string
The expire time of SSL.
id str
The provider-assigned unique ID for this managed resource.
is_valid bool
Whetehr SSL is valid.
ssl_enable bool
Whether SSL is enabled.
ssl_expired_time str
The expire time of SSL.
id String
The provider-assigned unique ID for this managed resource.
isValid Boolean
Whetehr SSL is valid.
sslEnable Boolean
Whether SSL is enabled.
sslExpiredTime String
The expire time of SSL.

Look up Existing SslState Resource

Get an existing SslState 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?: SslStateState, opts?: CustomResourceOptions): SslState
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        instance_id: Optional[str] = None,
        is_valid: Optional[bool] = None,
        ssl_action: Optional[str] = None,
        ssl_enable: Optional[bool] = None,
        ssl_expired_time: Optional[str] = None) -> SslState
func GetSslState(ctx *Context, name string, id IDInput, state *SslStateState, opts ...ResourceOption) (*SslState, error)
public static SslState Get(string name, Input<string> id, SslStateState? state, CustomResourceOptions? opts = null)
public static SslState get(String name, Output<String> id, SslStateState state, CustomResourceOptions options)
resources:  _:    type: volcengine:mongodb:SslState    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
The ID of mongodb instance.
IsValid bool
Whetehr SSL is valid.
SslAction string
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.
SslEnable bool
Whether SSL is enabled.
SslExpiredTime string
The expire time of SSL.
InstanceId Changes to this property will trigger replacement. string
The ID of mongodb instance.
IsValid bool
Whetehr SSL is valid.
SslAction string
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.
SslEnable bool
Whether SSL is enabled.
SslExpiredTime string
The expire time of SSL.
instanceId Changes to this property will trigger replacement. String
The ID of mongodb instance.
isValid Boolean
Whetehr SSL is valid.
sslAction String
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.
sslEnable Boolean
Whether SSL is enabled.
sslExpiredTime String
The expire time of SSL.
instanceId Changes to this property will trigger replacement. string
The ID of mongodb instance.
isValid boolean
Whetehr SSL is valid.
sslAction string
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.
sslEnable boolean
Whether SSL is enabled.
sslExpiredTime string
The expire time of SSL.
instance_id Changes to this property will trigger replacement. str
The ID of mongodb instance.
is_valid bool
Whetehr SSL is valid.
ssl_action str
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.
ssl_enable bool
Whether SSL is enabled.
ssl_expired_time str
The expire time of SSL.
instanceId Changes to this property will trigger replacement. String
The ID of mongodb instance.
isValid Boolean
Whetehr SSL is valid.
sslAction String
The action of ssl, valid value contains Update. Set ssl_action to Update will will trigger an SSL update operation when executing pulumi up.When the current time is less than 30 days from the ssl_expired_time, executing pulumi up will automatically renew the SSL.
sslEnable Boolean
Whether SSL is enabled.
sslExpiredTime String
The expire time of SSL.

Import

mongodb ssl state can be imported using the ssl:instanceId, e.g.

$ pulumi import volcengine:mongodb/sslState:SslState default ssl:mongo-shard-d050db19xxx
Copy

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 v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine