1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. MqttInstance
tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack

tencentcloud.MqttInstance

Explore with Pulumi AI

Provides a resource to create a MQTT instance

Example Usage

Create a POSTPAID instance

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

const config = new pulumi.Config();
const availabilityZone = config.get("availabilityZone") || "ap-guangzhou-6";
// create vpc
const vpc = new tencentcloud.Vpc("vpc", {cidrBlock: "10.0.0.0/16"});
// create subnet
const subnet = new tencentcloud.Subnet("subnet", {
    vpcId: vpc.vpcId,
    availabilityZone: availabilityZone,
    cidrBlock: "10.0.1.0/24",
    isMulticast: false,
});
// create mqtt instance
const example = new tencentcloud.MqttInstance("example", {
    instanceType: "BASIC",
    skuCode: "basic_2k",
    remark: "remarks.",
    vpcList: {
        vpcId: vpc.vpcId,
        subnetId: subnet.subnetId,
    },
    payMode: 0,
    tags: {
        createBy: "Terraform",
    },
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

config = pulumi.Config()
availability_zone = config.get("availabilityZone")
if availability_zone is None:
    availability_zone = "ap-guangzhou-6"
# create vpc
vpc = tencentcloud.Vpc("vpc", cidr_block="10.0.0.0/16")
# create subnet
subnet = tencentcloud.Subnet("subnet",
    vpc_id=vpc.vpc_id,
    availability_zone=availability_zone,
    cidr_block="10.0.1.0/24",
    is_multicast=False)
# create mqtt instance
example = tencentcloud.MqttInstance("example",
    instance_type="BASIC",
    sku_code="basic_2k",
    remark="remarks.",
    vpc_list={
        "vpc_id": vpc.vpc_id,
        "subnet_id": subnet.subnet_id,
    },
    pay_mode=0,
    tags={
        "createBy": "Terraform",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		availabilityZone := "ap-guangzhou-6"
		if param := cfg.Get("availabilityZone"); param != "" {
			availabilityZone = param
		}
		// create vpc
		vpc, err := tencentcloud.NewVpc(ctx, "vpc", &tencentcloud.VpcArgs{
			CidrBlock: pulumi.String("10.0.0.0/16"),
		})
		if err != nil {
			return err
		}
		// create subnet
		subnet, err := tencentcloud.NewSubnet(ctx, "subnet", &tencentcloud.SubnetArgs{
			VpcId:            vpc.VpcId,
			AvailabilityZone: pulumi.String(availabilityZone),
			CidrBlock:        pulumi.String("10.0.1.0/24"),
			IsMulticast:      pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		// create mqtt instance
		_, err = tencentcloud.NewMqttInstance(ctx, "example", &tencentcloud.MqttInstanceArgs{
			InstanceType: pulumi.String("BASIC"),
			SkuCode:      pulumi.String("basic_2k"),
			Remark:       pulumi.String("remarks."),
			VpcList: &tencentcloud.MqttInstanceVpcListArgs{
				VpcId:    vpc.VpcId,
				SubnetId: subnet.SubnetId,
			},
			PayMode: pulumi.Float64(0),
			Tags: pulumi.StringMap{
				"createBy": pulumi.String("Terraform"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var availabilityZone = config.Get("availabilityZone") ?? "ap-guangzhou-6";
    // create vpc
    var vpc = new Tencentcloud.Vpc("vpc", new()
    {
        CidrBlock = "10.0.0.0/16",
    });

    // create subnet
    var subnet = new Tencentcloud.Subnet("subnet", new()
    {
        VpcId = vpc.VpcId,
        AvailabilityZone = availabilityZone,
        CidrBlock = "10.0.1.0/24",
        IsMulticast = false,
    });

    // create mqtt instance
    var example = new Tencentcloud.MqttInstance("example", new()
    {
        InstanceType = "BASIC",
        SkuCode = "basic_2k",
        Remark = "remarks.",
        VpcList = new Tencentcloud.Inputs.MqttInstanceVpcListArgs
        {
            VpcId = vpc.VpcId,
            SubnetId = subnet.SubnetId,
        },
        PayMode = 0,
        Tags = 
        {
            { "createBy", "Terraform" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.Vpc;
import com.pulumi.tencentcloud.VpcArgs;
import com.pulumi.tencentcloud.Subnet;
import com.pulumi.tencentcloud.SubnetArgs;
import com.pulumi.tencentcloud.MqttInstance;
import com.pulumi.tencentcloud.MqttInstanceArgs;
import com.pulumi.tencentcloud.inputs.MqttInstanceVpcListArgs;
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 config = ctx.config();
        final var availabilityZone = config.get("availabilityZone").orElse("ap-guangzhou-6");
        // create vpc
        var vpc = new Vpc("vpc", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .build());

        // create subnet
        var subnet = new Subnet("subnet", SubnetArgs.builder()
            .vpcId(vpc.vpcId())
            .availabilityZone(availabilityZone)
            .cidrBlock("10.0.1.0/24")
            .isMulticast(false)
            .build());

        // create mqtt instance
        var example = new MqttInstance("example", MqttInstanceArgs.builder()
            .instanceType("BASIC")
            .skuCode("basic_2k")
            .remark("remarks.")
            .vpcList(MqttInstanceVpcListArgs.builder()
                .vpcId(vpc.vpcId())
                .subnetId(subnet.subnetId())
                .build())
            .payMode(0)
            .tags(Map.of("createBy", "Terraform"))
            .build());

    }
}
Copy
configuration:
  availabilityZone:
    type: string
    default: ap-guangzhou-6
resources:
  # create vpc
  vpc:
    type: tencentcloud:Vpc
    properties:
      cidrBlock: 10.0.0.0/16
  # create subnet
  subnet:
    type: tencentcloud:Subnet
    properties:
      vpcId: ${vpc.vpcId}
      availabilityZone: ${availabilityZone}
      cidrBlock: 10.0.1.0/24
      isMulticast: false
  # create mqtt instance
  example:
    type: tencentcloud:MqttInstance
    properties:
      instanceType: BASIC
      skuCode: basic_2k
      remark: remarks.
      vpcList:
        vpcId: ${vpc.vpcId}
        subnetId: ${subnet.subnetId}
      payMode: 0
      tags:
        createBy: Terraform
Copy

Create a PREPAID instance

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

const config = new pulumi.Config();
const availabilityZone = config.get("availabilityZone") || "ap-guangzhou-6";
// create vpc
const vpc = new tencentcloud.Vpc("vpc", {cidrBlock: "10.0.0.0/16"});
// create subnet
const subnet = new tencentcloud.Subnet("subnet", {
    vpcId: vpc.vpcId,
    availabilityZone: availabilityZone,
    cidrBlock: "10.0.1.0/24",
    isMulticast: false,
});
// create mqtt instance
const example = new tencentcloud.MqttInstance("example", {
    instanceType: "PRO",
    skuCode: "pro_6k_1",
    remark: "remarks.",
    vpcList: {
        vpcId: vpc.vpcId,
        subnetId: subnet.subnetId,
    },
    payMode: 1,
    timeSpan: 1,
    renewFlag: 1,
    forceDelete: false,
    tags: {
        createBy: "Terraform",
    },
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

config = pulumi.Config()
availability_zone = config.get("availabilityZone")
if availability_zone is None:
    availability_zone = "ap-guangzhou-6"
# create vpc
vpc = tencentcloud.Vpc("vpc", cidr_block="10.0.0.0/16")
# create subnet
subnet = tencentcloud.Subnet("subnet",
    vpc_id=vpc.vpc_id,
    availability_zone=availability_zone,
    cidr_block="10.0.1.0/24",
    is_multicast=False)
# create mqtt instance
example = tencentcloud.MqttInstance("example",
    instance_type="PRO",
    sku_code="pro_6k_1",
    remark="remarks.",
    vpc_list={
        "vpc_id": vpc.vpc_id,
        "subnet_id": subnet.subnet_id,
    },
    pay_mode=1,
    time_span=1,
    renew_flag=1,
    force_delete=False,
    tags={
        "createBy": "Terraform",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		availabilityZone := "ap-guangzhou-6"
		if param := cfg.Get("availabilityZone"); param != "" {
			availabilityZone = param
		}
		// create vpc
		vpc, err := tencentcloud.NewVpc(ctx, "vpc", &tencentcloud.VpcArgs{
			CidrBlock: pulumi.String("10.0.0.0/16"),
		})
		if err != nil {
			return err
		}
		// create subnet
		subnet, err := tencentcloud.NewSubnet(ctx, "subnet", &tencentcloud.SubnetArgs{
			VpcId:            vpc.VpcId,
			AvailabilityZone: pulumi.String(availabilityZone),
			CidrBlock:        pulumi.String("10.0.1.0/24"),
			IsMulticast:      pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		// create mqtt instance
		_, err = tencentcloud.NewMqttInstance(ctx, "example", &tencentcloud.MqttInstanceArgs{
			InstanceType: pulumi.String("PRO"),
			SkuCode:      pulumi.String("pro_6k_1"),
			Remark:       pulumi.String("remarks."),
			VpcList: &tencentcloud.MqttInstanceVpcListArgs{
				VpcId:    vpc.VpcId,
				SubnetId: subnet.SubnetId,
			},
			PayMode:     pulumi.Float64(1),
			TimeSpan:    pulumi.Float64(1),
			RenewFlag:   pulumi.Float64(1),
			ForceDelete: pulumi.Bool(false),
			Tags: pulumi.StringMap{
				"createBy": pulumi.String("Terraform"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var availabilityZone = config.Get("availabilityZone") ?? "ap-guangzhou-6";
    // create vpc
    var vpc = new Tencentcloud.Vpc("vpc", new()
    {
        CidrBlock = "10.0.0.0/16",
    });

    // create subnet
    var subnet = new Tencentcloud.Subnet("subnet", new()
    {
        VpcId = vpc.VpcId,
        AvailabilityZone = availabilityZone,
        CidrBlock = "10.0.1.0/24",
        IsMulticast = false,
    });

    // create mqtt instance
    var example = new Tencentcloud.MqttInstance("example", new()
    {
        InstanceType = "PRO",
        SkuCode = "pro_6k_1",
        Remark = "remarks.",
        VpcList = new Tencentcloud.Inputs.MqttInstanceVpcListArgs
        {
            VpcId = vpc.VpcId,
            SubnetId = subnet.SubnetId,
        },
        PayMode = 1,
        TimeSpan = 1,
        RenewFlag = 1,
        ForceDelete = false,
        Tags = 
        {
            { "createBy", "Terraform" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.Vpc;
import com.pulumi.tencentcloud.VpcArgs;
import com.pulumi.tencentcloud.Subnet;
import com.pulumi.tencentcloud.SubnetArgs;
import com.pulumi.tencentcloud.MqttInstance;
import com.pulumi.tencentcloud.MqttInstanceArgs;
import com.pulumi.tencentcloud.inputs.MqttInstanceVpcListArgs;
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 config = ctx.config();
        final var availabilityZone = config.get("availabilityZone").orElse("ap-guangzhou-6");
        // create vpc
        var vpc = new Vpc("vpc", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .build());

        // create subnet
        var subnet = new Subnet("subnet", SubnetArgs.builder()
            .vpcId(vpc.vpcId())
            .availabilityZone(availabilityZone)
            .cidrBlock("10.0.1.0/24")
            .isMulticast(false)
            .build());

        // create mqtt instance
        var example = new MqttInstance("example", MqttInstanceArgs.builder()
            .instanceType("PRO")
            .skuCode("pro_6k_1")
            .remark("remarks.")
            .vpcList(MqttInstanceVpcListArgs.builder()
                .vpcId(vpc.vpcId())
                .subnetId(subnet.subnetId())
                .build())
            .payMode(1)
            .timeSpan(1)
            .renewFlag(1)
            .forceDelete(false)
            .tags(Map.of("createBy", "Terraform"))
            .build());

    }
}
Copy
configuration:
  availabilityZone:
    type: string
    default: ap-guangzhou-6
resources:
  # create vpc
  vpc:
    type: tencentcloud:Vpc
    properties:
      cidrBlock: 10.0.0.0/16
  # create subnet
  subnet:
    type: tencentcloud:Subnet
    properties:
      vpcId: ${vpc.vpcId}
      availabilityZone: ${availabilityZone}
      cidrBlock: 10.0.1.0/24
      isMulticast: false
  # create mqtt instance
  example:
    type: tencentcloud:MqttInstance
    properties:
      instanceType: PRO
      skuCode: pro_6k_1
      remark: remarks.
      vpcList:
        vpcId: ${vpc.vpcId}
        subnetId: ${subnet.subnetId}
      payMode: 1
      timeSpan: 1
      renewFlag: 1
      forceDelete: false
      tags:
        createBy: Terraform
Copy

Create MqttInstance Resource

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

Constructor syntax

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

@overload
def MqttInstance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 instance_type: Optional[str] = None,
                 sku_code: Optional[str] = None,
                 force_delete: Optional[bool] = None,
                 mqtt_instance_id: Optional[str] = None,
                 name: Optional[str] = None,
                 pay_mode: Optional[float] = None,
                 remark: Optional[str] = None,
                 renew_flag: Optional[float] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 time_span: Optional[float] = None,
                 vpc_list: Optional[MqttInstanceVpcListArgs] = None)
func NewMqttInstance(ctx *Context, name string, args MqttInstanceArgs, opts ...ResourceOption) (*MqttInstance, error)
public MqttInstance(string name, MqttInstanceArgs args, CustomResourceOptions? opts = null)
public MqttInstance(String name, MqttInstanceArgs args)
public MqttInstance(String name, MqttInstanceArgs args, CustomResourceOptions options)
type: tencentcloud:MqttInstance
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. MqttInstanceArgs
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. MqttInstanceArgs
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. MqttInstanceArgs
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. MqttInstanceArgs
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. MqttInstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

InstanceType This property is required. string
Instance type, BASIC for Basic Edition PRO for Professional Edition.
SkuCode This property is required. string
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
ForceDelete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
MqttInstanceId string
ID of the resource.
Name string
Instance name.
PayMode double
Payment mode (0: Postpaid; 1: Prepaid).
Remark string
Remarks.
RenewFlag double
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
Tags Dictionary<string, string>
Tags of the MQTT instance.
TimeSpan double
Purchase duration (unit: months).
VpcList MqttInstanceVpcList
VPC information bound to the instance.
InstanceType This property is required. string
Instance type, BASIC for Basic Edition PRO for Professional Edition.
SkuCode This property is required. string
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
ForceDelete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
MqttInstanceId string
ID of the resource.
Name string
Instance name.
PayMode float64
Payment mode (0: Postpaid; 1: Prepaid).
Remark string
Remarks.
RenewFlag float64
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
Tags map[string]string
Tags of the MQTT instance.
TimeSpan float64
Purchase duration (unit: months).
VpcList MqttInstanceVpcListArgs
VPC information bound to the instance.
instanceType This property is required. String
Instance type, BASIC for Basic Edition PRO for Professional Edition.
skuCode This property is required. String
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
forceDelete Boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
mqttInstanceId String
ID of the resource.
name String
Instance name.
payMode Double
Payment mode (0: Postpaid; 1: Prepaid).
remark String
Remarks.
renewFlag Double
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
tags Map<String,String>
Tags of the MQTT instance.
timeSpan Double
Purchase duration (unit: months).
vpcList MqttInstanceVpcList
VPC information bound to the instance.
instanceType This property is required. string
Instance type, BASIC for Basic Edition PRO for Professional Edition.
skuCode This property is required. string
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
forceDelete boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
mqttInstanceId string
ID of the resource.
name string
Instance name.
payMode number
Payment mode (0: Postpaid; 1: Prepaid).
remark string
Remarks.
renewFlag number
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
tags {[key: string]: string}
Tags of the MQTT instance.
timeSpan number
Purchase duration (unit: months).
vpcList MqttInstanceVpcList
VPC information bound to the instance.
instance_type This property is required. str
Instance type, BASIC for Basic Edition PRO for Professional Edition.
sku_code This property is required. str
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
force_delete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
mqtt_instance_id str
ID of the resource.
name str
Instance name.
pay_mode float
Payment mode (0: Postpaid; 1: Prepaid).
remark str
Remarks.
renew_flag float
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
tags Mapping[str, str]
Tags of the MQTT instance.
time_span float
Purchase duration (unit: months).
vpc_list MqttInstanceVpcListArgs
VPC information bound to the instance.
instanceType This property is required. String
Instance type, BASIC for Basic Edition PRO for Professional Edition.
skuCode This property is required. String
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
forceDelete Boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
mqttInstanceId String
ID of the resource.
name String
Instance name.
payMode Number
Payment mode (0: Postpaid; 1: Prepaid).
remark String
Remarks.
renewFlag Number
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
tags Map<String>
Tags of the MQTT instance.
timeSpan Number
Purchase duration (unit: months).
vpcList Property Map
VPC information bound to the instance.

Outputs

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

AutomaticActivation bool
Is the automatic registration certificate automatically activated.
DeviceCertificateProvisionType string
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
Id string
The provider-assigned unique ID for this managed resource.
AutomaticActivation bool
Is the automatic registration certificate automatically activated.
DeviceCertificateProvisionType string
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
Id string
The provider-assigned unique ID for this managed resource.
automaticActivation Boolean
Is the automatic registration certificate automatically activated.
deviceCertificateProvisionType String
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
id String
The provider-assigned unique ID for this managed resource.
automaticActivation boolean
Is the automatic registration certificate automatically activated.
deviceCertificateProvisionType string
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
id string
The provider-assigned unique ID for this managed resource.
automatic_activation bool
Is the automatic registration certificate automatically activated.
device_certificate_provision_type str
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
id str
The provider-assigned unique ID for this managed resource.
automaticActivation Boolean
Is the automatic registration certificate automatically activated.
deviceCertificateProvisionType String
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing MqttInstance Resource

Get an existing MqttInstance 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?: MqttInstanceState, opts?: CustomResourceOptions): MqttInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automatic_activation: Optional[bool] = None,
        device_certificate_provision_type: Optional[str] = None,
        force_delete: Optional[bool] = None,
        instance_type: Optional[str] = None,
        mqtt_instance_id: Optional[str] = None,
        name: Optional[str] = None,
        pay_mode: Optional[float] = None,
        remark: Optional[str] = None,
        renew_flag: Optional[float] = None,
        sku_code: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        time_span: Optional[float] = None,
        vpc_list: Optional[MqttInstanceVpcListArgs] = None) -> MqttInstance
func GetMqttInstance(ctx *Context, name string, id IDInput, state *MqttInstanceState, opts ...ResourceOption) (*MqttInstance, error)
public static MqttInstance Get(string name, Input<string> id, MqttInstanceState? state, CustomResourceOptions? opts = null)
public static MqttInstance get(String name, Output<String> id, MqttInstanceState state, CustomResourceOptions options)
resources:  _:    type: tencentcloud:MqttInstance    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:
AutomaticActivation bool
Is the automatic registration certificate automatically activated.
DeviceCertificateProvisionType string
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
ForceDelete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
InstanceType string
Instance type, BASIC for Basic Edition PRO for Professional Edition.
MqttInstanceId string
ID of the resource.
Name string
Instance name.
PayMode double
Payment mode (0: Postpaid; 1: Prepaid).
Remark string
Remarks.
RenewFlag double
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
SkuCode string
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
Tags Dictionary<string, string>
Tags of the MQTT instance.
TimeSpan double
Purchase duration (unit: months).
VpcList MqttInstanceVpcList
VPC information bound to the instance.
AutomaticActivation bool
Is the automatic registration certificate automatically activated.
DeviceCertificateProvisionType string
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
ForceDelete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
InstanceType string
Instance type, BASIC for Basic Edition PRO for Professional Edition.
MqttInstanceId string
ID of the resource.
Name string
Instance name.
PayMode float64
Payment mode (0: Postpaid; 1: Prepaid).
Remark string
Remarks.
RenewFlag float64
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
SkuCode string
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
Tags map[string]string
Tags of the MQTT instance.
TimeSpan float64
Purchase duration (unit: months).
VpcList MqttInstanceVpcListArgs
VPC information bound to the instance.
automaticActivation Boolean
Is the automatic registration certificate automatically activated.
deviceCertificateProvisionType String
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
forceDelete Boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
instanceType String
Instance type, BASIC for Basic Edition PRO for Professional Edition.
mqttInstanceId String
ID of the resource.
name String
Instance name.
payMode Double
Payment mode (0: Postpaid; 1: Prepaid).
remark String
Remarks.
renewFlag Double
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
skuCode String
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
tags Map<String,String>
Tags of the MQTT instance.
timeSpan Double
Purchase duration (unit: months).
vpcList MqttInstanceVpcList
VPC information bound to the instance.
automaticActivation boolean
Is the automatic registration certificate automatically activated.
deviceCertificateProvisionType string
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
forceDelete boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
instanceType string
Instance type, BASIC for Basic Edition PRO for Professional Edition.
mqttInstanceId string
ID of the resource.
name string
Instance name.
payMode number
Payment mode (0: Postpaid; 1: Prepaid).
remark string
Remarks.
renewFlag number
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
skuCode string
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
tags {[key: string]: string}
Tags of the MQTT instance.
timeSpan number
Purchase duration (unit: months).
vpcList MqttInstanceVpcList
VPC information bound to the instance.
automatic_activation bool
Is the automatic registration certificate automatically activated.
device_certificate_provision_type str
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
force_delete bool
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
instance_type str
Instance type, BASIC for Basic Edition PRO for Professional Edition.
mqtt_instance_id str
ID of the resource.
name str
Instance name.
pay_mode float
Payment mode (0: Postpaid; 1: Prepaid).
remark str
Remarks.
renew_flag float
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
sku_code str
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
tags Mapping[str, str]
Tags of the MQTT instance.
time_span float
Purchase duration (unit: months).
vpc_list MqttInstanceVpcListArgs
VPC information bound to the instance.
automaticActivation Boolean
Is the automatic registration certificate automatically activated.
deviceCertificateProvisionType String
Client certificate registration method: JITP: Automatic registration; API: Manually register through the API.
forceDelete Boolean
Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.
instanceType String
Instance type, BASIC for Basic Edition PRO for Professional Edition.
mqttInstanceId String
ID of the resource.
name String
Instance name.
payMode Number
Payment mode (0: Postpaid; 1: Prepaid).
remark String
Remarks.
renewFlag Number
Whether to enable auto-renewal (0: Disabled; 1: Enabled).
skuCode String
Product SKU, available SKUs can be queried via the DescribeProductSKUList API.
tags Map<String>
Tags of the MQTT instance.
timeSpan Number
Purchase duration (unit: months).
vpcList Property Map
VPC information bound to the instance.

Supporting Types

MqttInstanceVpcList
, MqttInstanceVpcListArgs

SubnetId This property is required. string
Subnet ID.
VpcId This property is required. string
VPC ID.
SubnetId This property is required. string
Subnet ID.
VpcId This property is required. string
VPC ID.
subnetId This property is required. String
Subnet ID.
vpcId This property is required. String
VPC ID.
subnetId This property is required. string
Subnet ID.
vpcId This property is required. string
VPC ID.
subnet_id This property is required. str
Subnet ID.
vpc_id This property is required. str
VPC ID.
subnetId This property is required. String
Subnet ID.
vpcId This property is required. String
VPC ID.

Package Details

Repository
tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes
This Pulumi package is based on the tencentcloud Terraform Provider.